Download link for 2.6.2 release

[goredo.git] / doc / jobserver.texi

diff --git a/doc/jobserver.texi b/doc/jobserver.texi
index 0bb3ce530aa0994d3f9293923869c1d020e36cab..e1e73296c0395478393f910dc3d8b1470891c1bb 100644 (file)
--- a/doc/jobserver.texi
+++ b/doc/jobserver.texi
@@ -1,4 +1,5 @@
 @node Jobserver
+@cindex jobserver
 @unnumbered Jobserver
 
 Parallel builds are made by utilizing the jobserver protocol. Each job
@@ -8,21 +9,26 @@ to each @command{goredo} instance. Job takes the token by reading the
 single byte from that pipe, writing it back for returning. Pipe is
 pre-filled with required number of tokens.
 
+@pindex bmake
+@pindex gmake
 @command{goredo} can be integrated with
+@url{http://netbsd.org/, NetBSD}'s
 @url{http://www.crufty.net/help/sjg/bmake.htm, bmake} and
 @url{https://www.gnu.org/software/make/, GNU Make} (@command{gmake})
 jobserver protocol. All three of them use the same principle of
 jobserver, but different ways of passing pipe's file descriptors
 numbers to child process.
 
+@vindex REDO_MAKE
 @env{$REDO_MAKE} environment variable controls the compatibility behaviour:
 
 @table @command
 @item bmake
-Pass @code{-j 1 -J X,Y} arguments through @env{MAKEFLAGS} variable.
+Pass @code{-j 1 -J X,Y} arguments through @env{$MAKEFLAGS} variable.
 @item gmake
-Pass @code{--jobserver-auth=X,Y} arguments through @env{MAKEFLAGS} variable.
+Pass @code{--jobserver-auth=X,Y} arguments through @env{$MAKEFLAGS} variable.
+Beware that only @option{--jobserver-style=pipe} protocol is supported!
 @item none
-Pass @code{X,Y} arguments through @env{REDO_JS_FD} variable.
+Pass @code{X,Y} arguments through @env{$REDO_JS_FD} variable.
 Used by default, if @env{$REDO_MAKE} is not set.
 @end table