revi-archive/phorge-arcanist
1
0
Fork 0
mirror of https://we.phorge.it/source/arcanist.git synced 2024-11-22 06:42:41 +01:00
Code Issues Releases Wiki Activity

Fix symbol reference in arcconfig.diviner (thanks, jason!)

Browse source
This commit is contained in:
epriestley 2011-03-17 19:19:31 -07:00
parent 9b6e8aa6e1
commit b7be6dbf32
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/docs/arcconfig.diviner
View file

@ -6,7 +6,7 @@ Explains how to configure Arcanist projects with ##.arcconfig## files.
= .arcconfig Basics = = .arcconfig Basics =
Arcanist uses ##.arcconfig## files to determine a number of things about project Arcanist uses ##.arcconfig## files to determine a number of things about project
configuration. For instance, these are things it figures out from configuration. For instance, these are things it figures out from
##.arcconfig##: ##.arcconfig##:
- where the logical root directory of a project is; - where the logical root directory of a project is;
@ -20,28 +20,28 @@ A simple, valid file looks something like this:
"project_id" : "some_project_name", "project_id" : "some_project_name",
"conduit_uri" : "https://phabricator.example.com/api/" "conduit_uri" : "https://phabricator.example.com/api/"
} }
Here's what these options mean: Here's what these options mean:
- **project_id**: a human-readable string identifying the project - **project_id**: a human-readable string identifying the project
- **conduit_uri**: the Conduit API URI for the Phabricator installation that - **conduit_uri**: the Conduit API URI for the Phabricator installation that
Arcanist should send diffs to for review. Generally, if you access Arcanist should send diffs to for review. Generally, if you access
Phabricator at ##https://phabricator.example.com/##, the **conduit_uri** is Phabricator at ##https://phabricator.example.com/##, the **conduit_uri** is
##https://phabricator.example.com/api/##. Be mindful about "http" vs ##https://phabricator.example.com/api/##. Be mindful about "http" vs
"https". "https".
For an exhaustive list of available options, see below. For an exhaustive list of available options, see below.
= Advanced .arcconfig = = Advanced .arcconfig =
Other options include: Other options include:
- **lint_engine**: the name of a subclass of @{class:ArcanistLintEngine}, - **lint_engine**: the name of a subclass of @{class:ArcanistLintEngine},
which should be used to apply lint rules to this project. See (TODO). which should be used to apply lint rules to this project. See (TODO).
- **unit_engine**: the name of a subclass of - **unit_engine**: the name of a subclass of
@{class:ArcanistBaseUnitTestEngine.php}, which should be used to apply unit @{class:ArcanistBaseUnitTestEngine}, which should be used to apply unit
test rules to this project. See (TODO). test rules to this project. See (TODO).
- **arcanist_configuration**: the name of a subclass of - **arcanist_configuration**: the name of a subclass of
@{class:ArcanistConfiguration} which can add new command flags for this @{class:ArcanistConfiguration} which can add new command flags for this
project or provide entirely new commands. project or provide entirely new commands.
- **remote_hooks_installed**: tells Arcanist that you've set up remote hooks - **remote_hooks_installed**: tells Arcanist that you've set up remote hooks