From b99db5cbc1d466c065618927834115c0975c3b6c Mon Sep 17 00:00:00 2001 From: David Pursehouse Date: Thu, 26 Sep 2013 11:34:42 +0900 Subject: [PATCH] Tidy up buck documentation - Enable source highlighting for `maven_jar()` example. - Break the `buckd` documentation into paragraphs for easier reading, and fix a couple of grammatical mistakes. - Add indentation and remove "$>" on `buckd` usage example to make it consistent with other examples. - Add missing backticks. Change-Id: Ia65dec84969c38612f449309a9a29e648d60f828 --- Documentation/dev-buck.txt | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/Documentation/dev-buck.txt b/Documentation/dev-buck.txt index a41a821a42..28b0f59b3a 100644 --- a/Documentation/dev-buck.txt +++ b/Documentation/dev-buck.txt @@ -280,10 +280,11 @@ Building against unpublished Maven JARs --------------------------------------- To build against unpublished Maven JARs, like gwtorm or PrologCafe, the custom -JARs must be installed in the local Maven repository (mvn clean install) and -maven_jar() must be updated to point to the MAVEN_LOCAL Maven repository for +JARs must be installed in the local Maven repository (`mvn clean install`) and +`maven_jar()` must be updated to point to the `MAVEN_LOCAL` Maven repository for that artifact: +[source,python] ---- maven_jar( name = 'gwtorm', @@ -313,23 +314,28 @@ The trivial case using a local directory is: Using Buck daemon ~~~~~~~~~~~~~~~~~ -Buck ships with daemon command `buckd`, which uses +Buck ships with a daemon command `buckd`, which uses the link:https://github.com/martylamb/nailgun[Nailgun] protocol for running Java programs from the command line without incurring the JVM startup -overhead. Using a Buck daemon can save significant amounts of time as it -avoids the overhead of starting a Java virtual machine, loading the buck class -files and parsing the build files for each command. It is safe to run several -buck daemons started from different project directories and they will not -interfere with each other. Buck's documentation covers daemon in -http://facebook.github.io/buck/command/buckd.html[buckd]. The trivial case is -to run `buckd` from the project's root directory and use `buck` as usually: +overhead. + +Using a Buck daemon can save significant amounts of time as it avoids the +overhead of starting a Java virtual machine, loading the buck class files +and parsing the build files for each command. + +It is safe to run several buck daemons started from different project +directories and they will not interfere with each other. Buck's documentation +covers daemon in http://facebook.github.io/buck/command/buckd.html[buckd]. + +The trivial use case is to run `buckd` from the project's root directory and +run `buck` as usual: ---- -$>buckd -$>buck build gerrit -Using buckd. -[-] PARSING BUILD FILES...FINISHED 0.6s -[-] BUILDING...FINISHED 0.2s + buckd + buck build gerrit + Using buckd. + [-] PARSING BUILD FILES...FINISHED 0.6s + [-] BUILDING...FINISHED 0.2s ---- Overwrite Buck's settings