diff options
author | Martin Pool <mbp@sourcefrog.net> | 2024-03-09 16:24:35 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-03-13 04:38:27 +0000 |
commit | 4734a606564b0b1edf8b402d1ba6220088d0af8e (patch) | |
tree | d895477433621005ca4cfc1e69976cd465b586bc | |
parent | d1f4de0f7d811d03491c1779b850257c9c6028ee (diff) |
Update links from lists.samba.org to githuborigin/links
-rw-r--r-- | README.md | 5 | ||||
-rw-r--r-- | configure.ac | 2 | ||||
-rw-r--r-- | doc/reporting-bugs.txt | 17 | ||||
-rw-r--r-- | man/distcc.1 | 132 | ||||
-rw-r--r-- | man/distccd.1 | 58 | ||||
-rw-r--r-- | man/distccmon-text.1 | 22 | ||||
-rw-r--r-- | man/include_server.1 | 28 | ||||
-rw-r--r-- | man/pump.1 | 4 | ||||
-rw-r--r-- | src/mon.h | 8 |
9 files changed, 132 insertions, 144 deletions
@@ -3,7 +3,8 @@ by Martin Pool Current Documents: <https://distcc.github.io/> -Formally <http://distcc.org/> + +Formerly <http://distcc.org/> "pump" functionality added by Fergus Henderson, Nils Klarlund, Manos Renieris, and Craig Silverstein (Google Inc.) @@ -57,6 +58,6 @@ distcc is distributed under the GNU General Public Licence v2. ## Resources -* [Mailing list](https://lists.samba.org/mailman/listinfo/distcc) +* Repo, questions, and bugs: https://github.com/distcc/distcc * [Stack Overflow questions](http://stackoverflow.com/questions/tagged/distcc) diff --git a/configure.ac b/configure.ac index 007efb8..34d3a42 100644 --- a/configure.ac +++ b/configure.ac @@ -10,7 +10,7 @@ dnl Process this file with autoconf to produce a configure script # As of 0.6cvs, distcc no longer uses automake, only autoconf. AC_PREREQ(2.69) -AC_INIT(distcc, 3.4, distcc@lists.samba.org) +AC_INIT(distcc, 3.4, https://github.com/distcc/distcc) AC_CONFIG_HEADERS(src/config.h) AC_CONFIG_MACRO_DIRS([m4]) diff --git a/doc/reporting-bugs.txt b/doc/reporting-bugs.txt index 11726d2..496d5c3 100644 --- a/doc/reporting-bugs.txt +++ b/doc/reporting-bugs.txt @@ -1,11 +1,8 @@ -How to report bugs in distcc -*- indented-text -*- - - -If you are having trouble with distcc, please send email to -distcc@lists.samba.org. Please don't send mail direct to the author: -if you use the list, other people may be able to help you faster and -the answers are archived to help others. +# How to report bugs in distcc +If you are having trouble with distcc, please open a question at +<https://github.com/distcc/distcc/discussions/categories/q-a>, or, if it's +clearly a bug, open a bug in that GitHub repo. * The first aim of a bug report is to let the programmer see the failure with their own eyes. If you can't be with them to make it @@ -51,7 +48,7 @@ A good bug report for distcc should include these details: -Wimplicit -Wshadow -Wpointer-arith -Wcast-align \ -Wwrite-strings -Waggregate-return -Wstrict-prototypes \ -Wmissing-prototypes -Wnested-externs -o src/clirpc.o \ - -c src/clirpc.c + -c src/clirpc.c * Turn on client and server error logging. On the client, set these environment variables, and try to reproduce the problem: @@ -67,7 +64,3 @@ A good bug report for distcc should include these details: include all of them in your report, by looking at the process ID in square brackets. If you can't work that out, quote the last few hundred lines leading up to the failure. - -An error report with all the necessary details is often answered and -resolved within two days or less. If you don't include enough -information to know what is going wrong it can take much longer. diff --git a/man/distcc.1 b/man/distcc.1 index ca0dd3e..9e19b5f 100644 --- a/man/distcc.1 +++ b/man/distcc.1 @@ -2,8 +2,8 @@ .SH "NAME" distcc \- distributed C/C++/ObjC compiler with distcc-pump extensions .SH "SYNOPSIS" -.B distcc -.I <compiler> [COMPILER OPTIONS] +.B distcc +.I <compiler> [COMPILER OPTIONS] .PP .B distcc .I [COMPILER OPTIONS] @@ -14,7 +14,7 @@ distcc \- distributed C/C++/ObjC compiler with distcc-pump extensions .B distcc .I [DISTCC OPTIONS] .SH "DESCRIPTION" -.P +.P distcc distributes compilation of C code across several machines on a network. distcc should always generate the same results as a local compile, it is simple to install and use, and it is often much faster than a @@ -36,7 +36,7 @@ workstation or laptop. The distcc client runs on this machine, as does make, the preprocessor (if distcc's pump mode is not used), the linker, and other stages of the build process. Any number of volunteer machines act as compilation servers and help the client to build the program, by running the -.B distccd(1) +.B distccd(1) daemon, C compiler and assembler as required. .PP @@ -45,20 +45,20 @@ through a tunnel command such as ssh(1). For TCP connections the volunteers must run the distccd(1) daemon either directly or from inetd. For SSH connections distccd must be installed but should .B not -be listening for connections. +be listening for connections. .PP TCP connections should only be used on secure networks because there is no user authentication or protection of source or object code. SSH connections are slower. .PP distcc is intended to be used with GNU Make's -.B -j +.B -j option, which runs several compiler processes concurrently. distcc spreads the jobs across both local and remote CPUs. Because distcc is able to distribute most of the work across the network, a higher -concurrency level can be used than for local builds. As a rule of thumb, +concurrency level can be used than for local builds. As a rule of thumb, the -.B -j +.B -j value should be set to about twice the total number of available server CPUs but subject to client limitations. This setting allows for maximal interleaving of tasks being blocked waiting for disk or network IO. Note that @@ -76,10 +76,10 @@ locks. The effect of other build activity, such as Java compilation when building mixed code, should be considered. The .B --localslots_cpp parameter is by default set to 8. -This limits the number of concurrent processes that do preprocessing in +This limits the number of concurrent processes that do preprocessing in plain distcc (non-pump) mode. -Therefore, larger -.B -j +Therefore, larger +.B -j values than 8 may be used without overloading a single-CPU client due to preprocessing. Such large values may speed up parts of the build that do not involve C compilations, but they may not be useful to distcc @@ -98,12 +98,12 @@ cause mysterious compile or link failures. For each machine, download distcc, unpack, and install. .TP 2 -On each of the servers, run +On each of the servers, run .B distccd --daemon -with +with .B --allow options to restrict access. -.TP +.TP 3 Put the names of the servers in your environment: .RS @@ -124,7 +124,7 @@ compressed: $ export DISTCC_HOSTS='--randomize localhost red,cpp,lzo green,cpp,lzo blue,cpp,lzo' .RE -The +The .B --randomize option enforces a uniform usage of compile servers. While you will get some benefit from distcc's pump mode with only a few servers, you @@ -212,7 +212,7 @@ compared to plain distcc mode. .SH "RESTRICTIONS FOR PUMP MODE" Using pump mode requires both client and servers to use release 3.0 or -later of distcc and distccd (respectively). +later of distcc and distccd (respectively). .PP The incremental include analysis of distc-pump mode rests on the fundamental assumption that source and header files do not change @@ -367,7 +367,7 @@ For example: .PP Then, to use distcc, a user just needs to put the directory /usr/lib/distcc/bin early in the PATH, and have set a host list in -DISTCC_HOSTS or a file. distcc will handle the rest. +DISTCC_HOSTS or a file. distcc will handle the rest. .PP To automatically discover compilers and create masquerade links run the provided @@ -394,7 +394,7 @@ For example, in /usr/lib/distcc/bin create a file cc which contains: .PP .RS .nf -#!/bin/sh +#!/bin/sh distcc /usr/bin/gcc "$@" .fi .RE @@ -417,8 +417,8 @@ This tells ccache to run distcc as a wrapper around the real compiler. ccache still uses the real compiler to detect compiler upgrades. .PP -ccache can then be run using either a masquerade directory -.I or +ccache can then be run using either a masquerade directory +.I or by setting .IP @@ -432,11 +432,11 @@ be any use. distcc's pump mode is not compatible with ccache. .SH "HOST SPECIFICATIONS" A "host list" tells distcc which machines to use for compilation. In -order, distcc looks in the +order, distcc looks in the .B $DISTCC_HOSTS -environment variable, the user's +environment variable, the user's .B $DISTCC_DIR/hosts -file, and the system-wide host +file, and the system-wide host file. If no host list can be found, distcc emits a warning and compiles locally. .PP @@ -455,7 +455,7 @@ first machine listed is used (but see .I --randomize below). .PP -Placing +Placing .I localhost at the right point in the list is important to getting good performance. Because overhead for running jobs locally is low, @@ -475,23 +475,23 @@ later in the list. To avoid this, place the keyword into the host list. This will cause the host list to be randomized, which should improve performance slightly for large build clusters. .PP -There are two special host names +There are two special host names .B --localslots and .B --localslots_cpp -which are useful for adjusting load on the local machine. The +which are useful for adjusting load on the local machine. The .B --localslots -host specifies how many jobs that cannot be run remotely that can be run concurrently -on the local machine, while +host specifies how many jobs that cannot be run remotely that can be run concurrently +on the local machine, while .B --localslots_cpp controls how many preprocessors will run in parallel on the local machine. Tuning these values can improve performance. Linking on large projects -can take large amounts of memory. Running parallel linkers, which cannot be +can take large amounts of memory. Running parallel linkers, which cannot be executed remotely, may force the machine to swap, which reduces performance over just running the jobs in sequence without swapping. Getting the number of parallel preprocessors just right allows you to use larger parallel factors with make, since the local machine -now has some mechanism for measuring local resource usage. +now has some mechanism for measuring local resource usage. .PP Finally there is the host entry .PP @@ -535,7 +535,7 @@ A literal IPv6 address enclosed in square brackets, such as .B [::1] .TP .B IPV4 -A literal IPv4 address, such as +A literal IPv4 address, such as .B 10.0.0.1 .TP .B HOSTNAME @@ -547,18 +547,18 @@ Connect to a specified decimal port number, rather than the default of .TP .B @HOSTID Connect to the host over SSH, rather than TCP. Options for the SSH -connection can be set in +connection can be set in .B ~/.ssh/config .TP .B USER@ Connect to the host over SSH as a specified username. .TP -.B :COMMAND +.B :COMMAND Connect over SSH, and use a specified path to find the distccd server. This is normally only needed if for some reason you can't install distccd into a directory on the default PATH for SSH connections. Use this if you get errors like "distccd: command not -found" in SSH mode. +found" in SSH mode. .TP .B /LIMIT A decimal limit can be added to any host specification to restrict the @@ -571,7 +571,7 @@ servers with more than two processors. Enables LZO compression for this TCP or SSH host. .TP .B ,cpp -Enables distcc-pump mode for this host. Note: the build command must be +Enables distcc-pump mode for this host. Note: the build command must be wrapped in the pump script in order to start the include server. .TP .B ,auth @@ -614,14 +614,14 @@ hash/pound sign (\fB#\fP) and run to the end of the line. If a host in the list is not reachable distcc will emit a warning and ignore that host for about one minute. .SH "COMPRESSION" -The -.B lzo +The +.B lzo host option specifies that LZO compression should be used for data transfer, including preprocessed source, object code and error messages. Compression is usually economical on networks slower than 100Mbps, but results may vary depending on the network, processors and source tree. -.PP +.PP Enabling compression makes the distcc client and server use more CPU time, but less network traffic. The added CPU time is insignificant for pump mode. The compression ratio is typically 4:1 for source and 2:1 for object code. @@ -661,7 +661,7 @@ Error messages or warnings from local or remote compilers are passed through to diagnostic output on the client. .PP distcc can supply extensive debugging information when the verbose -option is used. This is controlled by the +option is used. This is controlled by the .B DISTCC_VERBOSE environment variable on the client, and the .B --verbose @@ -697,7 +697,7 @@ Connect failed. .TP 104 Compiler crashed. -.TP +.TP 105 Out of memory. .TP @@ -712,7 +712,7 @@ Truncated. .TP 109 Protocol Error. -.TP +.TP 110 The given compiler was not found on the remote host. Check that $CC is set appropriately and that it's installed in a directory on the search path for distccd. .TP @@ -730,7 +730,7 @@ In use by another process. .TP 115 No such file. -.TP +.TP 116 No hosts defined and fallbacks disabled. .TP @@ -744,7 +744,7 @@ GSS-API - Catchall error code for GSS-API related errors. Called for preprocessing, which needs to be done locally. .SH "FILES" -If $DISTCC_HOSTS is not set, distcc reads a host list from either +If $DISTCC_HOSTS is not set, distcc reads a host list from either .B $DISTCC_DIR/hosts or a system-wide configuration file set at compile time. The file locations are shown in the output from @@ -815,16 +815,16 @@ packets and aids performance. This should normally be left enabled. Specifies the command used for opening SSH connections. Defaults to "ssh" but may be set to a different connection command such as "lsh" or "tsocks-ssh" that accepts a similar command line. The command is -not split into words and is not executed through the shell. +not split into words and is not executed through the shell. .TP .B DISTCC_SKIP_LOCAL_RETRY If set, when a remote compile fails, distcc will no longer try to -recompile that file locally. +recompile that file locally. .TP .B "DISTCC_DIR" Per-user configuration directory to store lock files and state files. -By default -.B ~/.distcc/ +By default +.B ~/.distcc/ is used. .TP .B "TMPDIR" @@ -839,7 +839,7 @@ caching transient errors such as network problems. .TP .B "DISTCC_ENABLE_DISCREPANCY_EMAIL" If set, distcc sends an email when a compilation failed remotely, but succeeded -locally. Built-in heuristics prevent some such discrepancy email from being sent if +locally. Built-in heuristics prevent some such discrepancy email from being sent if the problem is that a local file changed between the failing remote compilation and the succeeding local compilation. .TP @@ -866,7 +866,7 @@ compilation commands may be required. The compilation command passed to distcc must be one that will execute properly on every volunteer machine to produce an object file of the appropriate type. If the machines -have different processors, then simply using +have different processors, then simply using .B distcc cc will probably not work, because that will normally invoke the volunteer's native compiler. @@ -876,7 +876,7 @@ necessarily generate compatible .o files. .PP Several different gcc configurations can be installed side-by-side on any machine. If you build gcc from source, -you should use the +you should use the .B --program-suffix configuration options to cause it to be installed with a name that encodes the gcc version and the target platform. @@ -886,13 +886,13 @@ The recommended convention for the gcc name is such as .B i686-linux-gcc-3.2 \&. GCC 3.3 will install itself -under this name, in addition to +under this name, in addition to .I TARGET-gcc -and, if it's native, -.I gcc-VERSION -and +and, if it's native, +.I gcc-VERSION +and .I gcc -\&. +\&. .PP The compiler must be installed under the same name on the client and on every volunteer machine. @@ -918,14 +918,14 @@ incompatible versions. Compiler errors about link problems or declarations in system header files are usually due to mismatched or incorrectly installed compilers. .PP -gcc's -.B -MD +gcc's +.B -MD option can produce output in the wrong directory if the source and -object files are in different directories and the -.B -MF +object files are in different directories and the +.B -MF option is not used. There is no perfect solution because of incompatible changes between gcc versions. Explicitly specifying the -dependency output file with +dependency output file with .B -MF will fix the problem. .PP @@ -936,7 +936,7 @@ build down. .PP When distcc or ccache is used on NFS, the filesystem must be exported with the -.B no_subtree_check +.B no_subtree_check option to allow reliable renames between directories. .PP The compiler can be invoked with a command line @@ -944,14 +944,14 @@ The compiler can be invoked with a command line to both compile and link. distcc doesn't split this into separate parts, but rather runs the whole thing locally. .PP -distcc-pump mode reverts to plain distcc mode for source files that contain +distcc-pump mode reverts to plain distcc mode for source files that contain includes with absolute paths (either directly or in an included file). .PP Due to limitations in gcc, gdb may not be able to automatically find the source files for programs built using distcc in some -circumstances. The gdb +circumstances. The gdb .B directory -command can be used. For distcc's plain (non-pump) mode, +command can be used. For distcc's plain (non-pump) mode, this is fixed in gcc 3.4 and later. For pump mode, the fix in gcc 3.4 does not suffice; we've worked around the gcc limitation by rewriting the object files that gcc produces, but this is only @@ -974,13 +974,13 @@ In distcc-pump mode, certain assumptions are made that source and header files do not change during the build. See discussion in section DISTCC DISCREPANCY SYMPTOMS of \fBinclude_server\fR(1(). -Other known bugs may be documented on +Other known bugs may be documented on .I http://code.google.com/p/distcc/ .SH "AUTHOR" distcc was written by Martin Pool <mbp@sourcefrog.net>, with the co-operation of many scholars including Wayne Davison, Frerich Raabe, Dimitri Papadopoulos and others noted in the NEWS file. Please report -bugs to <distcc@lists.samba.org>. See \fBpump\fR(1) for the authors of pump mode. +bugs at <https://github.com/distcc/distcc>. See \fBpump\fR(1) for the authors of pump mode. .SH "LICENCE" You are free to use distcc. distcc (including this manual) may be copied, modified or distributed only under the terms of the GNU diff --git a/man/distccd.1 b/man/distccd.1 index 9cf8d1c..7a29401 100644 --- a/man/distccd.1 +++ b/man/distccd.1 @@ -2,16 +2,16 @@ .SH "NAME" distccd \- distributed C/C++ compiler server .SH "SYNOPSIS" -.B distccd --daemon +.B distccd --daemon .I [OPTIONS] .SH "DESCRIPTION" -.I distccd +.I distccd is the server for the distcc(1) distributed compiler. It accepts and runs compilation jobs for network clients. .PP distcc can run over either TCP or a connection command such as ssh(1). TCP connections are fast but relatively insecure. SSH connections are -secure but slower. +secure but slower. .PP For SSH connections, distccd must be installed on the volunteer but should not run as a daemon -- it will be started over SSH as needed. @@ -23,15 +23,15 @@ and source and output is protected in transit. For TCP connections, distccd can run either from an inetd-style program, or as a standalone server. Standalone mode is recommended because it is slightly more efficient and allows distccd to regulate -the number of incoming jobs. The +the number of incoming jobs. The .B --listen -and +and .B --allow options can be used for simple IP-based access control. .PP distcc may be started either by root or any other user. If run by root, it gives away privileges and changes to the user specified by -the +the .B --user option, or the user called "distcc", or the user called "nobody". .PP @@ -64,12 +64,12 @@ daemontools. The super-server starts distccd when the system boots, and whenever it exits. .PP distccd should be started just as for a standalone server, -except that the +except that the .B --no-detach option should be used so that the super-server can monitor it. .PP For example, to add distccd as a process to Linux -sysvinit, add this line to +sysvinit, add this line to .I /etc/inittab .RS .PP @@ -99,7 +99,7 @@ The \.6000 option raises the limit to 6000 per minute. .SH "TERMINATING DISTCCD" To shut down a standalone server, send a SIGTERM signal to the parent process. The most reliable way to do -this from a script is to use the +this from a script is to use the .I --pid-file option to record its process ID. Shutting down the server in this way should allow any jobs currently in progress to complete. @@ -116,7 +116,7 @@ Sets a limit on the number of jobs that can be accepted at any time. By default this is set to two greater than the number of CPUs on the machine, to allow for some processes being blocked on network IO. (Daemon mode only.) -.TP +.TP .B -N, --nice NICENESS Makes the daemon more nice about giving up the CPU to other tasks on the machine. NICENESS is an increment to the current priority of the @@ -164,7 +164,7 @@ denial of service from clients that don't properly disconnect and compilers that fail to terminate. By default this is turned off. .TP .B --no-detach -Do not detach from the shell that started the daemon. +Do not detach from the shell that started the daemon. .TP .B --no-fork Don't fork children for each connection, to allow attaching gdb. @@ -180,7 +180,7 @@ Set the minimum severity of error that will be included in the log file. Useful if you only want to see error messages rather than an entry for each connection. LEVEL can be any of the standard syslog levels, and in particular -.I critical, error, warning, notice, info, +.I critical, error, warning, notice, info, or .I debug. .TP @@ -211,7 +211,7 @@ Serve a client connected to stdin/stdout. As the name suggests, this option should be used when distccd is run from within a super-server like inetd. distccd assumes inetd mode when stdin is a socket. -.TP +.TP .B --daemon Bind and listen on a socket, rather than running from inetd. This is used for standalone mode. distccd @@ -219,14 +219,14 @@ assumes daemon mode at startup if stdin is a tty, so --daemon should be explicitly specified when starting distccd from a script or in a non-interactive ssh connection. -.TP +.TP .B --enable-tcp-insecure By default (since Distcc 3.3) distcc will only execute binaries that are masqueraded to distcc in /usr/lib/distcc. This turns that off, and opens distcc up to executing arbitrary code. This feature is mainly for distcc's test suite. See MASQUERADING of .BR distcc (1). -.TP +.TP .B --zeroconf Register the availability of this distccd server using Avahi Zeroconf DNS Service Discovery (DNS-SD). This allows distcc clients on the local @@ -279,20 +279,20 @@ environment variable may be used to set the path. The search path is logged when --verbose is given. In case of confusion, check the logs. .PP -When distccd is run over ssh, the -.I $HOME/.ssh/environment -file may be useful in setting the path. See +When distccd is run over ssh, the +.I $HOME/.ssh/environment +file may be useful in setting the path. See .B ssh(1). .SH "DIAGNOSTICS" -distccd logs messages to syslog's +distccd logs messages to syslog's .I daemon facility by -default, which normally writes to -.I /var/log/daemon +default, which normally writes to +.I /var/log/daemon or -.I /var/log/messages. +.I /var/log/messages. Log messages can be sent to a -different file using the +different file using the .B --log-file option. .SH "ENVIRONMENT VARIABLES" .TP @@ -303,7 +303,7 @@ refuse to serve any command whose last DISTCC_CMDLIST_MATCHWORDS last words do not match those of a command in that list. See the comments in src/serve.c. .TP .B "DISTCC_CMDLIST_NUMWORDS" -The number of words, from the end of the command, to match. The default is 1. +The number of words, from the end of the command, to match. The default is 1. .TP .B "DISTCCD_PATH" When starting distccd, if this value is set it will be used unaltered @@ -313,7 +313,7 @@ remove masquerade directories from the path is skipped. .B "DISTCC_SAVE_TEMPS" If set to 1, temporary files are not deleted after use. .PP -Note that +Note that .B "DISTCC_LOG" does not affect the log destination for the server. .TP @@ -336,11 +336,11 @@ to authenticate with the client. .SH "BUGS" IP-based access control is not secure against attackers able to spoof TCP connections, and cannot discriminate different users on a client. -.PP +.PP TCP connections are not secure against attackers able to observe or modify network traffic. .PP -Because ccache does not cache compilation from +Because ccache does not cache compilation from .B .i files, it is not useful to call it from distccd. .SH "LICENCE" @@ -352,6 +352,6 @@ COPYING. .SH "AUTHOR" distcc was written by Martin Pool <mbp@sourcefrog.net>, with the co-operation of many scholars including Wayne Davison, Frerich Raabe, -Dimitri Papadopoulos and others noted in the NEWS file. +Dimitri Papadopoulos and others noted in the NEWS file. See \fBpump\fR(1) for the authors of pump mode. -Please report bugs to <distcc@lists.samba.org>. +Please report bugs to <https://github.com/distcc/distcc>. diff --git a/man/distccmon-text.1 b/man/distccmon-text.1 index a9e5dce..568faba 100644 --- a/man/distccmon-text.1 +++ b/man/distccmon-text.1 @@ -1,20 +1,20 @@ .TH distccmon-text 1 "2 October 2004" .SH "NAME" -.LP +.LP distccmon\-text \- Displays current compilation jobs in text form. .SH "SYNTAX" -.LP +.LP distccmon-text [DELAY] .SH "DESCRIPTION" -.LP +.LP Displays current compilation jobs in text form. distccmon-text must -be run on the client machine, with the same setting for +be run on the client machine, with the same setting for .I DISTCC_DIR -(or home directory) +(or home directory) as the user running the distcc client. .SH "OPTIONS" -.LP -.TP +.LP +.TP \fBDELAY\fR repeatedly updates after \fIdelay\fP (fractional) seconds. .SH "OUTPUT FORMAT" @@ -40,17 +40,17 @@ index for that host. When a delay is specified, each block of output is terminated by a blank line. .SH "EXAMPLES" -.LP +.LP To display currently active jobs (updated every second): .IP distccmon\-text 1 -.LP +.LP To display the status once: .IP distccmon\-text .SH "AUTHORS" -.LP -distcc was written by Martin Pool <mbp@sourcefrog.net>, with the co\-operation of many scholars including Wayne Davison, Frerich Raabe, Dimitri Papadopoulos and others noted in the NEWS file. Please report bugs to <distcc@lists.samba.org>. +.LP +distcc was written by Martin Pool <mbp@sourcefrog.net>, with the co\-operation of many scholars including Wayne Davison, Frerich Raabe, Dimitri Papadopoulos and others noted in the NEWS file. Please report bugs to <https://github.com/distcc/distcc>. .SH "SEE ALSO" .LP d distccd(1), ccache(1), gcc(1), make(1) diff --git a/man/include_server.1 b/man/include_server.1 index c89728b..406a766 100644 --- a/man/include_server.1 +++ b/man/include_server.1 @@ -6,9 +6,9 @@ include_server.py \- conservative approximation of include dependencies for C/C+ --port .I INCLUDE_SERVER_PORT [OPTIONS] .SH "DESCRIPTION" -.P +.P include_server.py starts an include server process. This process answers -queries from +queries from \fBdistcc\fR(1) clients about what files to include in C/C++ compilations. The include_server.py command itself terminates as soon as the include server has been spawned. @@ -17,11 +17,11 @@ The INCLUDE_SERVER_PORT argument is the name of a socket used for all communication between distcc clients and the include server. The \fBpump\fR(1) command is responsible for creating the socket location, for passing it to this script, and for passing it to all distcc clients via the environment variable -named INCLUDE_SERVER_PORT. +named INCLUDE_SERVER_PORT. .PP The protocol used by the include server uses distcc's RPC implementation. Each distcc request consists of (1) the current directory and (2) the list of -arguments of the compilation command. +arguments of the compilation command. .PP If the include server is able to process the request, then it answers the distcc client by sending a list of filepaths. The filepaths are those of the @@ -46,7 +46,7 @@ locally retried, see section \fBDISTCC DISCREPANCY SYMPTOMS\fR. .SH "OPTION SUMMARY" The following options are understood by include_server.py. .TP -.B -dPAT, --debug_pattern=PAT +.B -dPAT, --debug_pattern=PAT Bit vector for turning on warnings and debugging 1 = warnings 2 = trace some functions @@ -63,7 +63,7 @@ Maximal number of emails to send (in addition to a final email). Default: 3. .B --no-email Do not send email. This is the default. .TP -.B --path_observation_re=RE +.B --path_observation_re=RE Issue warning message whenever a filename is resolved to a realpath that is matched by RE, which is a regular expression in Python syntax. This is useful for finding out where files included actually come from. Use RE="" to find them @@ -72,11 +72,11 @@ all. Note: warnings must be enabled with at least -d1. .B --pid_file FILEPATH The pid of the include server is written to file FILEPATH. This allows a script such a \fBpump\fR to tear down the include server. -.TP +.TP .B -s, --statistics Print information to stdout about include analysis. .TP -.B --stat_reset_triggers=LIST +.B --stat_reset_triggers=LIST Flush stat caches when the timestamp of any filepath in LIST changes or the filepath comes in or out of existence. LIST is a colon separated string of filepaths, possibly containing simple globs (as allowed by Python's glob @@ -84,22 +84,22 @@ module). Print a warning whenever such a change happens (if warnings are enabled). This option allows limited exceptions to distcc_pump's normal assumption that source files are not modified during the build. .TP -.B -t, --time +.B -t, --time Print elapsed, user, and system time to stderr. .TP -.B --unsafe_absolute_includes +.B --unsafe_absolute_includes Do preprocessing on the compilation server even if includes of absolute filepaths are encountered. Normally the include-server will fall back on local preprocessing if it detects any absolute includes. Thus, this flag is useful for preventing such fallbacks when the absolute includes are a false alarm, either because the absolute include is discarded during preprocessing or because -the absolutely included file exists on the compilation servers. +the absolutely included file exists on the compilation servers. .IP More precisely, with --unsafe_absolute_includes absolute includes are ignored for the purposes of gathering the include closure. Using this option may lead to incorrect results because (1) the header may actually be included on the compilation server and it may not be the same as on the client, (2) the include -directives of the header are not further analyzed. +directives of the header are not further analyzed. .IP The option is useful for compiling code that has such hardcoded absolute locations of header files inside conditional directives (e.g. "#ifdef") that @@ -120,7 +120,7 @@ including other files in foo/. Verify that files in CPP closure are contained in closure calculated by include processor. .TP -.B -w, --write_include_closure +.B -w, --write_include_closure Write a .d_approx file which lists all the included files calculated by the include server; with -x, additionally write the included files as calculated by CPP to a .d_exact file. @@ -292,7 +292,7 @@ Other known bugs may be documented on .SH "AUTHOR" The include server was written by Nils Klarlund, with assistance from Fergus Henderson, Manos Renieris, and Craig Silverstein. Please report bugs to -<distcc@lists.samba.org>. +<https://github.com/distcc/distcc>. .SH "LICENCE" You are free to use distcc. distcc (including this manual) may be @@ -100,7 +100,7 @@ and use the output of .B lsdistcc to set DISTCC_HOSTS. .SH "OPTIONS" -.TP +.TP .B --help Displays summary instructions. .TP @@ -170,7 +170,7 @@ in the documentation directory for information on how to report it. .SH "AUTHORS" The pump script and distcc's pump mode were written by Nils Klarlund, Manos Renieris, Fergus Henderson, and Craig Silverstein. Please report -bugs to <distcc@lists.samba.org>. +bugs to <https://github.com/distcc/distcc>. .SH "LICENCE" .B pump is part of distcc. @@ -37,13 +37,7 @@ extern "C" { It is possible for third party developers to write monitoring software for distcc clusters, and you are encouranged to do - so. This appendix attempts to provide you with all the information - you'll need to write a distcc monitor, but just like all other - software, distcc is not perfect; in case you are stuck, can't seem - to get your monitor working, or just think a particular quirk in - the way a monitor was to be written is worth being pointed out, - don't hesitate to subscribe to the list (http://lists.samba.org/) - and present your problem. + so. Limitations on monitoring |