From b216dc9c2c433e607cc094ece6798b1807dea9e2 Mon Sep 17 00:00:00 2001
From: Jakub Vrana <jakub@vrana.cz>
Date: Sat, 20 Apr 2013 11:44:29 -0700
Subject: [PATCH] Document where Arcanist configuration can be set

Test Plan: Read it.

Reviewers: epriestley

Reviewed By: epriestley

CC: aran, Korvin

Differential Revision: https://secure.phabricator.com/D5732
---
 .../engine/PhabricatorFileStorageEngine.php   |  2 +-
 src/docs/userguide/arcanist.diviner           | 20 +++++++++++++++++++
 2 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/src/applications/files/engine/PhabricatorFileStorageEngine.php b/src/applications/files/engine/PhabricatorFileStorageEngine.php
index 5941088664..ee4b691454 100644
--- a/src/applications/files/engine/PhabricatorFileStorageEngine.php
+++ b/src/applications/files/engine/PhabricatorFileStorageEngine.php
@@ -48,7 +48,7 @@ abstract class PhabricatorFileStorageEngine {
    * some metadata keys (like "name" and "author") in it. You should be prepared
    * to handle writes which specify no metadata, but might want to optionally
    * use some keys in this array for debugging or logging purposes. This is
-   * the same dictionary passed to @{method:PhabricatorFile::NewFromFileData},
+   * the same dictionary passed to @{method:PhabricatorFile::newFromFileData},
    * so you could conceivably do custom things with it.
    *
    * If you are unable to write for whatever reason (e.g., the disk is full),
diff --git a/src/docs/userguide/arcanist.diviner b/src/docs/userguide/arcanist.diviner
index 5dae1d5da8..50090f568e 100644
--- a/src/docs/userguide/arcanist.diviner
+++ b/src/docs/userguide/arcanist.diviner
@@ -139,6 +139,26 @@ to your ##.bashrc##, ##.profile## or similar:
 
   source /path/to/arcanist/resources/shell/bash-completion
 
+== Configuration ==
+
+Some Arcanist commands can be configured. This configuration is read from
+several sources:
+
+  # A customization can force any setting with
+    @{method@arcanist:ArcanistWorkingCopyIdentity::setRuntimeConfig}.
+  # User can specify settings for working copy in `arc/config` file located in
+    VCS directory (e.g. `.git/arc/config`) in JSON format. This file can also be
+    modified by running `arc set-config --local`.
+  # Repository can specify its config in `.arcconfig` in JSON format.
+  # User can specify the settings in `~/.arcrc` (JSON) through the `config` key.
+    This file can be modified also by `arc set-config --global`.
+  # Machine can specify the settings with `/etc/arcconfig` (JSON). On Windows,
+    the file path is 'C:\ProgramData\Phabricator\Arcanist\config`.
+
+The first place where the setting is defined wins.
+
+Existing settings can be printed with `arc set-config --show`.
+
 == Next Steps ==
 
 Continue by: