summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Pursehouse <david.pursehouse@sonymobile.com>2013-10-17 00:13:55 +0900
committerDavid Pursehouse <david.pursehouse@sonymobile.com>2013-10-17 00:14:47 +0900
commit485678214524a84ef1a2f25faa9427761a187bb9 (patch)
treed20b809ae3eec698dc50976f9d45f327225afaa6
parenta3cf3548a808d9d856af31eaf10a9092482782ce (diff)
Improve documentation of buck settings override
-rw-r--r--Documentation/dev-buck.txt13
1 files changed, 7 insertions, 6 deletions
diff --git a/Documentation/dev-buck.txt b/Documentation/dev-buck.txt
index 8bbea7eb9e..15c145aad9 100644
--- a/Documentation/dev-buck.txt
+++ b/Documentation/dev-buck.txt
@@ -345,12 +345,13 @@ run `buck` as usual:
[-] BUILDING...FINISHED 0.2s
----
-Overwrite Buck's settings
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Override Buck's settings
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+User-specific configuration can be placed in one of the following files:
+`/etc/buck.conf`, `$HOME/.buck/buck.conf` or `$HOME/.buckrc`.
-In the latest version of Buck the wrapper script `buck_common` will source
-one of these files (if they exist): /etc/buck.conf, $HOME/.buck/buck.conf or
-$HOME/.buckrc. The trivial case to overwrite the Buck's default 1GB heap size:
+For example to override Buck's default 1GB heap size:
----
cat > $HOME/.buckrc <<EOF
@@ -361,7 +362,7 @@ $HOME/.buckrc. The trivial case to overwrite the Buck's default 1GB heap size:
EOF
----
-Or to debug BUCK, set BUCK_DEBUG_MODE to anything non-empty, then connect to
+Or to debug BUCK, set `BUCK_DEBUG_MODE` to anything non-empty, then connect to
port 8888:
----