[distcc] Re: hostspec options syntax

[Wayne Davison]

Martin, just in case you decide to use the ,OPT syntax implemented in my
last patch, here's a patch that documents the new syntax.  One caveat,
it documents the "timeout=N" option as though it works, which it doesn't
(yet).

..wayne..
-------------- next part --------------
Index: linuxdoc/distcc.sgml
--- linuxdoc/distcc.sgml	9 Mar 2003 09:28:01 -0000	1.100
+++ linuxdoc/distcc.sgml	10 Mar 2003 00:50:43 -0000
@@ -597,17 +597,21 @@
 	  volunteer machines are available to run jobs.  This is a
 	  space-separated list of host specifications, each of which
 	  has the syntax:
-<tscreen><verb>HOSTNAME[/MAX_JOBS][:PORT]</verb></tscreen>
-
-	<p>
-	  You can specify the maximum number of jobs that the host
-	  should receive by affixing a number after a slash (e.g.
-	  "localhost/2").
+<tscreen><verb>HOSTNAME[:PORT][,OPT...]</verb></tscreen>
 
 	<p>
 	  A numeric TCP port may optionally be specified after a
 	  colon.  If no port is specified, it uses the default, which
 	  is currently 3632.
+
+	<p>
+	  You can specify one or more host-specific options at the end of the
+	  host-spec by appending each one after a comma.  The current options
+	  are slots=N (abbreviated as just N, if desired) and timeout=N.
+	  The "slots" option specifies the maximum number of jobs that the
+	  associated host should be given simultaneously (e.g. "localhost,2").
+	  The timeout option is measured in seconds (e.g.
+	  "myhost:3633,slots=3,timeout=999").
 
 	<p>
 	  If only one invocation of distcc runs at a time, it will
Index: src/distcc.c
--- src/distcc.c	5 Mar 2003 02:02:22 -0000	1.158
+++ src/distcc.c	10 Mar 2003 00:50:43 -0000
@@ -114,9 +114,15 @@
 "\n"
 "Host specifications:\n"
 "   localhost                  run in place\n"
-"   HOST                       TCP connection, port %d\n"
-"   HOST:PORT                  TCP connection, specified port\n"
-"   HOST/MAX:PORT              As above, but limit the number of jobs to MAX\n"
+"   HOST[:PORT][,OPT...]       TCP connection (default port=%d)\n"
+"\n"
+"OPT Values:\n"
+"   slots=N                    Maximum of N simultaneous jobs allowed\n"
+"   N                          Abbreviation of the slots=N option\n"
+"   timeout=N                  Timeout this connection after N seconds\n"
+"\n"
+"Hostname examples:\n"
+"   foo   foo:3633   foo,4   bar:3634,2   bar,timeout=999,slots=3\n"
 "\n"
 "distcc distributes compilation jobs across volunteer machines running\n"
 "distccd.  Jobs that cannot be distributed, such as linking or \n"