]> git.donarmstrong.com Git - debbugs.git/blobdiff - README
Add Debbugs::BugWalker to abstract out bug-walking code in
[debbugs.git] / README
diff --git a/README b/README
index 19d16a25a17382df800948b5518f6e2aa2b6bd0f..1577635e3f1fb3b681802057de41a712b9cf621c 100644 (file)
--- a/README
+++ b/README
@@ -1,14 +1,20 @@
-                     DEBIAN BUG TRACKING SYSTEM
-                     --------------------------
+                     debbugs, Debian bug tracking system
+                     -----------------------------------
 
 This bug tracking system was developed by Ian Jackson from 1994-1997,
 with assistance from nCipher Corporation Limited in 1997.  nCipher allowed
 Ian to redistribute modifications he made to the system while working as an
 employee of nCipher.
 
+Since then, it has been developed by the various administrators of
+bugs.debian.org, including Darren Benham, Adam Heath, Josip Rodin, Anthony
+Towns, and Colin Watson.  As in the case of Ian, nCipher allowed Colin to
+redistribute modifications he made while working as an employee of nCipher.
+
 =============================================================================
 SYSTEM REQUIREMENTS
 =============================================================================
+
  - GNU date
  - GNU gzip
  - Perl 5 (5.005 is known to work)
@@ -17,8 +23,10 @@ SYSTEM REQUIREMENTS
  - The bug system requires its own mail domain.  It comes with code
    which understands how exim, qmail and sendmail deliver mail for such a 
    domain to a script.
- - A webserver (this is easiest if the bug system can write
-   directly to the webspace).
+ - A webserver.  For the old system of static HTML pages generated for
+   bug reports and index pages, this is easiest if the bug system can
+   write directly to the webspace; for the new system of CGI scripts
+   that generate web pages on the fly, write access is not required.
  - Somewhere to run CGI scripts (unless you don't need the web forms for
    searching for bugs by number, package, maintainer or submitter).
 
@@ -33,6 +41,8 @@ If you can't use the .deb, do the following:
 1. Run "make install" from the source directory.
 
 2. Edit the config files in /etc/debbugs/ directory to suit your needs.
+Re-run debbugsconfig when you're finished to regenerate the
+documentation.
 
 3. Set up the mail arrangements to deliver mail to the right place, and to
 set up a blackhole mail alias if you need one.  Ensure that owner@bugs, the
@@ -44,7 +54,11 @@ All other email should be piped into the receive script.
 directory.
 
 5. Test things a bit, by sending mail messages to the bug system and
-running .../scripts/processall and/or .../scripts/update-html.
+running /usr/lib/debbugs/processall and/or /usr/lib/debbugs/rebuild.
+The latter updates index files used by the CGI scripts.  If you're
+feeling brave, you can link /var/lib/debbugs/spool/index.db to
+index.db.realtime and .../index.archive to index.archive.realtime to
+remove the need for the rebuild script; this is still semi-experimental.
 
 6. If all seems well then install the crontab from
 /usr/share/doc/debbugs/examples/crontab.
@@ -59,17 +73,19 @@ If you need a template, look in /usr/share/doc/debbugs/examples/ directory.
 =============================================================================
 FURTHER INFORMATION
 =============================================================================
-Web:  http://benham.net/debbugs/
+
 Email: debian-debbugs@lists.debian.org (mailing list)
-       debian-debbugs-request@lists.debian.org with the word subscribe in the
-       subject line
+       To subscribe, email debian-debbugs-request@lists.debian.org
+       with the word "subscribe" in the subject line
+Outdated web site: http://benham.net/debbugs/
 
 =============================================================================
 COPYRIGHT AND LACK-OF-WARRANTY NOTICE
 =============================================================================
-Copyright 1999 Darren O. Benham <gecko@debian.org>
-Copyright 1994,1995,1996,1997 Ian Jackson <ijackson@chiark.greenend.org.uk>
-Copyright 1997 nCipher Corporation Limited
+
+Copyright 1999 Darren O. Benham
+Copyright 1994-1997 Ian Jackson
+Copyright 1997,2003 nCipher Corporation Limited
 
 This bug system is free software; you can redistribute it and/or modify it
 under the terms of the GNU General Public License as published by the Free
@@ -84,5 +100,3 @@ You should have received a copy of the GNU General Public License along
 with this program, or one should be available above; if not, write to the
 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 02111-1307, USA.
-
- - Darren Benham 14 Oct, 1999