Skip to content

Commit

Permalink
Update the html version of the man pages, based on the .1 updates.
Browse files Browse the repository at this point in the history
Add include_server, which is a new man page.  Update the Makefile to
know about the new man page, include it in the distribution, etc.
Also update the rpm spec to include it too.
  • Loading branch information
csilvers committed Jun 9, 2008
1 parent f193df3 commit 0f4df54
Show file tree
Hide file tree
Showing 4 changed files with 526 additions and 8 deletions.
9 changes: 6 additions & 3 deletions Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -362,10 +362,11 @@ conf_files = $(conf_dir)/hosts \
default_dir = packaging/RedHat/default
default_files = $(default_dir)/distcc

man1_MEN = man/distcc.1 man/distccd.1 man/distccmon-text.1 man/pump.1
man1_MEN = man/distcc.1 man/distccd.1 man/distccmon-text.1 \
man/pump.1 man/include_server.1
man_HTML = man/distcc_1.html man/distccd_1.html man/distccmon_text_1.html \
man/pump_1.html
MEN = $(man1_MEN)
man/pump_1.html man/include_server_1.html
MEN = $(man1_MEN)

gnome_data = gnome/distccmon-gnome-icon.png \
gnome/distccmon-gnome.desktop
Expand Down Expand Up @@ -650,6 +651,8 @@ man/distccmon_text_1.html: man/distccmon-text.1
man/pump_1.html: man/pump.1
troff2html -man "$(srcdir)"/man/pump.1 > $@

man/include_server_1.html: man/include_server.1
troff2html -man "$(srcdir)"/man/include_server.1 > $@

######################################################################
## CHECK targets for code that has been build.
Expand Down
40 changes: 35 additions & 5 deletions doc/web/man/distcc_1.html
Original file line number Diff line number Diff line change
Expand Up @@ -243,12 +243,12 @@ <H2>
<A NAME=TOC_7>
HOW DISTCC-PUMP MODE WORKS</A>
</H2>
In pump mode, distcc runs the prepreprocessor remotely too. To
do so, the preprocessor must have access to all the files that
it would have accessed if had been running locally. In pump mode,
In pump mode, distcc runs the preprocessor remotely too. To do
so, the preprocessor must have access to all the files that it
would have accessed if had been running locally. In pump mode,
therefore, distcc gathers all of the recursively included headers,
except the ones that are part of the compiler installation, and
sends them along with the source file to the compilation server.<BR>
except the ones that are default system headers, and sends them
along with the source file to the compilation server.<BR>
<P>
In distcc-pump mode, the server unpacks the set of all source
files in a temporary directory, which contains a directory tree
Expand Down Expand Up @@ -293,6 +293,29 @@ <H2>
To overcome such issues, and other corner cases such as absolute
filepaths in includes, see the include_server(1) man page.<BR>
<P>
Another important assumption is that the include configuration
of all machines must be identical. Thus the headers under the
default system path must be the same on all servers and all clients.
If a standard GNU compiler installation is used, then this requirement
applies to all libraries whose header files are installed under
/usr/include or /usr/local/include/. Note that installing software
packages often lead to additional headers files being placed in
subdirectories of either.<BR>
<P>
If this assumption does not hold, then it is possible to break
builds with distcc-pump mode, or worse, to get wrong results without
warning. Presently this condition is not verified, and it is
on our TODO list to address this issue. Also, currently, explicit
include specifications that resolve to something under the default
system search path such as -I/usr/include/foolib do not work except
if this directory is specified with -isystem.<BR>
<P>
An easy way to guarantee that the include configurations are identical
is to use a crosscompiler that defines a default system search
path restricted to directories of the compiler installation.<BR>
<P>
See the <B>include_server</B>(1) manual for more information on
symptoms and causes of violations of distcc-pump mode assumptions.<BR>
<P>
<H2>
<A NAME=TOC_8>
Expand Down Expand Up @@ -991,6 +1014,13 @@ <H2>
library. The include server will time out and distcc will revert
to plain mode.<BR>
<P>
In distcc-pump mode, includes of the form -I/usr/include/foolib
do not usually work, see discussion in section HOW DISTCC-PUMP
MODE WORKS above.<BR>
<P>
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 <B>include_server</B>(1().<BR>
<P>
Other known bugs may be documented on <I> http://code.google.com/p/distcc/</I><BR>
<H2>
Expand Down
Loading

0 comments on commit 0f4df54

Please sign in to comment.