Revise the doc/example directory:

- Add README file to the doc/example directory.
- Add files in doc/example for every system configuration file
  installed or modified by the RPM installation script (rpm.spec).
- Update some comments in rpm.spec.
- Some whitespace changes to doc/example/logrotate and
  packaging/RedHat/logrotate.d/distcc to make those two files match.
- Copy warning from packaging/RedHat/xinetd.d/distcc to
  doc/examples/xinetd.

Reviewers: Craig Silverstein


git-svn-id: http://distcc.googlecode.com/svn/trunk@136 01de4be4-8c4a-0410-9132-4925637da917

6 files changed, 47 insertions, 2 deletions

diff --git a/doc/example/README b/doc/example/README
new file mode 100644
index 0000000..0367f7a
--- /dev/null
+++ b/doc/example/README
@@ -0,0 +1,36 @@
+This directory (distcc/doc/example) contains example configuration
+files for the distccd service that need to be installed manually when
+distccd is installed via "make install".  For a typical Linux system,
+these files would need to be installed in the following locations:
+
+   /etc/init.d/distcc
+   /etc/logrotate.d/distcc
+   /etc/inetd.d/distcc
+   /etc/defaults/distcc
+   /etc/services              # Just append one line to this file.
+   /etc/hosts.allow           # Just append one line to this file.
+
+The details of how to set up services are quite system-specific, so
+depending on your system you may need to do things differently.
+
+If you install distccd using the RPM or Debian package, appropriate
+versions of those files will be installed automatically, so you don't
+need to install them manually, and you don't need to bother looking at
+the files in this directory (distcc/doc/example).  However, you may need
+to edit the /etc/hosts.allow file.
+
+In addition to the above-mentioned configuration files, you may also
+need to edit the following three files in distcc's sysconf directory
+(/etc/distcc, or /usr/local/etc/distcc, or some other location, depending
+on how your configured distcc).  Example versions of these configuration
+files get installed automatically by "make install" and by the RPM and
+Debian packages.  Two configuration files on the server machines are
+used by the init script for starting distccd:
+
+   /etc/distcc/commands.allow.sh
+   /etc/distcc/clients.allow
+
+One configuration file on the client machine is used by distcc:
+
+   /etc/distcc/hosts
+
diff --git a/doc/example/default b/doc/example/default
new file mode 100644
index 0000000..44aeaa7
--- /dev/null
+++ b/doc/example/default
@@ -0,0 +1,2 @@
+# This should go in the file /etc/default/distcc.
+STARTDISTCC=true
diff --git a/doc/example/hosts.allow b/doc/example/hosts.allow
new file mode 100644
index 0000000..7648e85
--- /dev/null
+++ b/doc/example/hosts.allow
@@ -0,0 +1,3 @@
+# A line like this should be appended to /etc/hosts.allow.
+# You'll need to edit this to allow access from other hosts.
+distcc:	127.0.0.1
diff --git a/doc/example/logrotate b/doc/example/logrotate
index 2bfe1eb..ebb9502 100644
--- a/doc/example/logrotate
+++ b/doc/example/logrotate
@@ -9,4 +9,4 @@
        missingok
        copytruncate
        notifempty
-}
\ No newline at end of file
+}
diff --git a/doc/example/services b/doc/example/services
new file mode 100644
index 0000000..37bcc50
--- /dev/null
+++ b/doc/example/services
@@ -0,0 +1,2 @@
+# Append the following line to /etc/services
+distcc		3632/tcp			# Distcc Distributed Compiler
diff --git a/doc/example/xinetd b/doc/example/xinetd
index 096dcf4..b41c47b 100644
--- a/doc/example/xinetd
+++ b/doc/example/xinetd
@@ -1,4 +1,6 @@
 # default: off
+# description: distccd serves C/C++ compilation requests from distcc clients.
+#              WARNING: This service should ONLY be used on trusted networks.
 
 # xinetd service description for distcc, contributed by akpm, updated
 # by mbp.
@@ -8,7 +10,7 @@
 # and then restart xinetd.  You should also create a 'distcc' user.
 
 # ===> Note that running from inetd is generally NOT recommended for
-# distcc distccd should give better performance when it can run as a
+# distcc. distccd should give better performance when it can run as a
 # standalone daemon and regulate its own load.
 
 service distcc