Changes to gnats/doc/gnats-faq.texi

[Hans-Albert Schneider]

Index: gnats/doc/gnats-faq.texi
diff -c gnats/doc/gnats-faq.texi:1.7 gnats/doc/gnats-faq.texi:1.8
*** gnats/doc/gnats-faq.texi:1.7        Sun Jul 14 13:27:47 2002
--- gnats/doc/gnats-faq.texi    Sun Jul 21 17:47:18 2002
***************
*** 93,99 ****
  The questions and answers have been compiled by
  @email{Hans-Albert@@HA-Schneider.de,Hans-Albert Schneider}, mainly
  using the help-gnats mailing list and the @sc{gnats} documentation as
! input.
  
  
  @menu
--- 93,99 ----
  The questions and answers have been compiled by
  @email{Hans-Albert@@HA-Schneider.de,Hans-Albert Schneider}, mainly
  using the help-gnats mailing list and the @sc{gnats} documentation as
! input.  Please report any errors and suggestions to him.
  
  
  @menu
***************
*** 289,297 ****
  @end itemize
  
  Providing this information in the initial report avoids further
! unnecessary communication, saves our limited development resources and
! helps to track down and fix the problem soon.
  
  
  
  @node     Installation
--- 289,340 ----
  @end itemize
  
  Providing this information in the initial report avoids further
! unnecessary communication, saves the limited resources of the
! developers (keep in mind that they are working on @sc{gnats} and
! friends in their spare time) and helps to track down and fix the
! problem soon.
! 
! 
! @ignore
! @c @node Upgrading
! @comment  node-name,  next,  previous,  up
! @section Upgrading Considerations
! 
! See @ref{Upgrading,,Upgrading from older versions,gnats,Keeping
! Track} for the upgrade process from 3.x to 4.x.
! 
! If you are running a 3.x version older than 3.113.1, and your system
! is heavily used, you may prefer to upgrade to 3.113.1--there are a lot
! of changes between 3.113.1 and 4.0-pre, and some parts of the 4.0
! documentation may still need to be updated.
! 
! Another consideration is to migrate by running 4.x in parallel to 3.x,
! as a sort of mirror of the 3.x version.
! To the best of my knowledge, this has not yet been done practically.
! 
! The idea is to have the mail
! aliases on the 3.x server also send the mails to the 4.x server.  To
! avoid confusing submitters and responsibles by duplicate emails (one
! from 3.x and one from 4.x), the 4.x server could send its mails to the
! @sc{gnats} admin, or even to @code{nobody} (usually aliased to
! @address@hidden/dev/null}}).  As the mail text sent by the 4.x server is
! configurable, another option is to include an explanatory statement.
  
+ @smallexample
+ # On the @sc{gnats} 3 server:
+ GreatNewDB-bugs: GreatNewDB-bugs-3, GreatNewDB-bugs-4
+ GreatNewDB-query:  "|/usr/local/lib/gnats/mail-query -d /usr/local/gnats/db2"
+ GreatNewDB-bugs-3: "|/usr/local/lib/gnats/queue-pr -d /usr/local/gnats/db2 -q"
+ # If the @sc{gnats} 4 server is different:
+ GreatNewDB-bugs-4: GreatNewDB-bugs-4@@gnats4-server
+ @end smallexample
+ 
+ @smallexample
+ # On the @sc{gnats} 4 server:
+ GreatNewDB-bugs-4: "|/usr/local/libexec/gnats/queue-pr -d GreatNewDB -q"
+ nobody:            /dev/null
+ @end smallexample
+ @end ignore
  
  
  @node     Installation
***************
*** 324,329 ****
--- 367,373 ----
  @menu
  * Add a database::              How to create a new database
  * Renaming a Category::         
+ * Changing Fields::             
  @end menu
  
  @node Add a database
***************
*** 387,395 ****
  
        @code{/usr/local/gnats/db2:GreatNewDB}
  
! Gnatsd reads it on startup (and as it is started by inetd, this
! means it becomes effective with the next connection to gnatsd).
! @ref{Gnatsweb} learns the database list from gnatsd, so it will offer
  you the new database "GreatNewDB" when it is invoked next time.
  
  If you do not know where @address@hidden lives, run:
--- 431,439 ----
  
        @code{/usr/local/gnats/db2:GreatNewDB}
  
! Gnatsd reads it on startup (and as it is started by inetd, this means
! it becomes effective with the next connection to gnatsd).  Gnatsweb
! (see @ref{Gnatsweb}) learns the database list from gnatsd, so it will offer
  you the new database "GreatNewDB" when it is invoked next time.
  
  If you do not know where @address@hidden lives, run:
***************
*** 435,445 ****
  database.  Make sure that the directory (in our example,
  @address@hidden/usr/local/gnats/db2}}) can be created by the @sc{gnats} user.
  
  Gnatsd reads the file @address@hidden on startup (and as it is
  started by inetd, this means it becomes effective with the next
! connection to gnatsd).  @ref{Gnatsweb} learns the database list from
! gnatsd, so it will offer you the new database "GreatNewDB" when it is
! invoked next time.
  
  If you do not know where @address@hidden lives, run:
  
--- 479,494 ----
  database.  Make sure that the directory (in our example,
  @address@hidden/usr/local/gnats/db2}}) can be created by the @sc{gnats} user.
  
+ (Note that there @emph{must} be a database named @code{default}.  It
+ is used as a fallback by some tools if no database is specified.  You
+ need not use it actively, but you should have run @samp{mkdb default}.)
+ 
+ 
  Gnatsd reads the file @address@hidden on startup (and as it is
  started by inetd, this means it becomes effective with the next
! connection to gnatsd).  Gnatsweb (see @ref{Gnatsweb}) learns the
! database list from gnatsd, so it will offer you the new database
! "GreatNewDB" when it is invoked next time.
  
  If you do not know where @address@hidden lives, run:
  
***************
*** 512,517 ****
--- 561,592 ----
  
  @end enumerate
  
+ @node Changing Fields
+ @comment  node-name,  next,  previous,  up
+ @subsection How do I add, remove, or rename a PR field?
+ 
+ @noindent
+ @b{A: (@sc{gnats} 3.1xx)} The fields and their names are fixed in
+ @sc{gnats} 3.1xx, so this is not possible.
+ 
+ @noindent
+ @b{A: (@sc{gnats} 4.x)} Edit the file @file{dbconfig} to reflect your
+ changes.
+ 
+ Note that the PR fields with the builtin-names @code{severity},
+ @code{priority} and @code{state} are required if you want automatic
+ reminders (@code{notify-about-expired-prs = true}).  In this case, the
+ file @file{submitters} must also contain a response time.
+ @c The reminder is filed if:
+ @c - "response time" is not -1, and
+ @c - @code{notify-about-expired-prs} = true, and
+ @c - (@code{severity} = @code{critical})
+ @c   or ( @code{severity} = @code{serious}
+ @c        and @code{priority} = @code{high} )
+ The @code{severity} field is checked for values @code{critical} and
+ @code{serious}, and @code{priority} for value @code{high}.
+ This is currently not configurable.
+ 
  
  @node Gnatsd
  @comment  node-name,  next,  previous,  up
***************
*** 865,870 ****
--- 940,946 ----
  @comment  node-name,  next,  previous,  up
  @subsection General Gnatsweb Questions
  
+ Currently none.
  
  
  @node Gnatsweb Login Questions