mirror of
https://we.phorge.it/source/phorge.git
synced 2024-12-19 12:00:55 +01:00
Modernize Arcanist documentation
Summary: Change `project_id` to `project.name` and `conduit_uri` to `phabricator.uri`. Test Plan: `grep` Reviewers: #blessed_reviewers, epriestley Reviewed By: #blessed_reviewers, epriestley Subscribers: epriestley, Korvin Differential Revision: https://secure.phabricator.com/D9736
This commit is contained in:
parent
1abd74459f
commit
30f46e598b
4 changed files with 7 additions and 7 deletions
|
@ -25,7 +25,7 @@ to lowest priority:
|
||||||
running `bin/config`.
|
running `bin/config`.
|
||||||
- **Config Files**: Values are stored in a config file in `conf/`. The file
|
- **Config Files**: Values are stored in a config file in `conf/`. The file
|
||||||
to use is selected by writing to `conf/local/ENVIRONMENT`, or setting the
|
to use is selected by writing to `conf/local/ENVIRONMENT`, or setting the
|
||||||
PHABRICATOR_ENV configuration variable. See below for more information.
|
`PHABRICATOR_ENV` configuration variable. See below for more information.
|
||||||
- **Defaults**: Defaults hard-coded in the Phabricator source, which can not
|
- **Defaults**: Defaults hard-coded in the Phabricator source, which can not
|
||||||
be edited. They have the lowest priority, and all other settings override
|
be edited. They have the lowest priority, and all other settings override
|
||||||
them.
|
them.
|
||||||
|
|
|
@ -149,7 +149,7 @@ relative path like this:
|
||||||
...arc looks for it by trying these paths:
|
...arc looks for it by trying these paths:
|
||||||
|
|
||||||
- `path/to/root/examplelib/src/` First, arc looks in the project's root
|
- `path/to/root/examplelib/src/` First, arc looks in the project's root
|
||||||
directory (where the .arcconfig lives) to see if the library is part of
|
directory (where the `.arcconfig` lives) to see if the library is part of
|
||||||
the project. This makes it easy to just put project-specific code in a
|
the project. This makes it easy to just put project-specific code in a
|
||||||
project.
|
project.
|
||||||
- `path/to/root/../examplelib/src/` Next, arc looks //next to// the project's
|
- `path/to/root/../examplelib/src/` Next, arc looks //next to// the project's
|
||||||
|
|
|
@ -44,13 +44,13 @@ Create a `.arcconfig` file in your project's working copy:
|
||||||
yourproject/ $ $EDITOR .arcconfig
|
yourproject/ $ $EDITOR .arcconfig
|
||||||
yourproject/ $ cat .arcconfig
|
yourproject/ $ cat .arcconfig
|
||||||
{
|
{
|
||||||
"project_id" : "yourprojectname",
|
"project.name" : "yourprojectname",
|
||||||
"conduit_uri" : "https://phabricator.example.com/"
|
"phabricator.uri" : "https://phabricator.example.com/"
|
||||||
}
|
}
|
||||||
|
|
||||||
Set `project_id` to a string that identifies the project.
|
Set `project.name` to a string that identifies the project.
|
||||||
|
|
||||||
Set `conduit_uri` to the URI for your Phabricator install (where `arc`
|
Set `phabricator.uri` to the URI for your Phabricator install (where `arc`
|
||||||
should send changes to).
|
should send changes to).
|
||||||
|
|
||||||
NOTE: You should **commit this file** to the repository.
|
NOTE: You should **commit this file** to the repository.
|
||||||
|
|
|
@ -83,7 +83,7 @@ Phabricator. For example, you might write this file to
|
||||||
##libcustom/.arcconfig##:
|
##libcustom/.arcconfig##:
|
||||||
|
|
||||||
{
|
{
|
||||||
"project_id" : "libcustom",
|
"project.name" : "libcustom",
|
||||||
"load" : [
|
"load" : [
|
||||||
"phabricator/src/"
|
"phabricator/src/"
|
||||||
]
|
]
|
||||||
|
|
Loading…
Reference in a new issue