[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Changes to gnats/doc/p-admin.texi
From: |
Yngve Svendsen |
Subject: |
Changes to gnats/doc/p-admin.texi |
Date: |
Sun, 27 Oct 2002 07:43:36 -0500 |
Index: gnats/doc/p-admin.texi
diff -c gnats/doc/p-admin.texi:1.29 gnats/doc/p-admin.texi:1.30
*** gnats/doc/p-admin.texi:1.29 Sat Oct 26 18:02:53 2002
--- gnats/doc/p-admin.texi Sun Oct 27 07:43:36 2002
***************
*** 13,22 ****
@table @emph
@item emptying the @code{pending} directory
@cindex emptying the @code{pending} directory
! If a Problem Report arrives with a @samp{>Category:} value that is
unrecognized by the @file{categories} file, or if that field is missing,
@sc{gnats} places the PR in the @address@hidden directory
! (@pxref{Locations,,Where the tools and utilities reside}). PRs
submitted in free-form by email will always be filed in the
@address@hidden directory. If so configured, @sc{gnats} sends a
notice to the @code{gnats-admin} and to the party responsible for that
--- 13,22 ----
@table @emph
@item emptying the @code{pending} directory
@cindex emptying the @code{pending} directory
! If a Problem Report arrives with a @code{Category} value that is
unrecognized by the @file{categories} file, or if that field is missing,
@sc{gnats} places the PR in the @address@hidden directory
! (@pxref{Locations,,Where @sc{gnats} lives}). PRs
submitted in free-form by email will always be filed in the
@address@hidden directory. If so configured, @sc{gnats} sends a
notice to the @code{gnats-admin} and to the party responsible for that
***************
*** 122,130 ****
overall behaviour across all the databases on your machine, while the
@dfn{database-specific} configuration files determine how @sc{gnats}
behaves when dealing with a specific database. In addition, there is
! a single file that needs to to be set up for the send-pr tool to work
! properly. These files can be edited at any time --- the next time a
! @sc{gnats} tool is invoked, the new parameters will take effect.
These are the site-wide configuration files used by @sc{gnats}:
--- 122,131 ----
overall behaviour across all the databases on your machine, while the
@dfn{database-specific} configuration files determine how @sc{gnats}
behaves when dealing with a specific database. In addition, there is
! a single file that needs to be set up for the @code{send-pr} tool to
! work properly. These files can be edited at any time --- the next
! time a @sc{gnats} tool is invoked, the new parameters will take
! effect.
These are the site-wide configuration files used by @sc{gnats}:
***************
*** 137,147 ****
--- 138,160 ----
clients to determine the location of a database referred to by name.
@xref{databases file,,The @code{databases} file}.
+ @item defaults
+ @cindex @file{defaults}
+ This directory contains the set of default per-database configuration
+ files used when a new database is created with @code{mkdb}.
+
@item gnatsd.host_access
@cindex @file{gnatsd.host_access}
Controls access levels for the different machines that will do lookups
in the databases on this machine. @xref{Access Control,,@sc{gnats}
access control}.
+
+ @item gnatsd.user_access
+ @cindex @file{gnatsd.user_access}
+ Controls user access levels for the databases on this server. The
+ settings apply to all databases (there is also a database-specific
+ user access level file). @xref{Access Control,,@sc{gnats} access
+ control}.
@end table
@noindent The database-specific configuration is determined by the
***************
*** 157,163 ****
@cindex @code{categories} file
@item categories
The list of categories that @sc{gnats} accepts as valid for the
! @samp{>Category:} field, and the maintainers responsible for each
category. Update this file whenever you have a new category, or
whenever a category is no longer valid. You must also update this file
whenever responsibility for a category changes, or if a maintainer is
--- 170,176 ----
@cindex @code{categories} file
@item categories
The list of categories that @sc{gnats} accepts as valid for the
! @code{Category} field, and the maintainers responsible for each
category. Update this file whenever you have a new category, or
whenever a category is no longer valid. You must also update this file
whenever responsibility for a category changes, or if a maintainer is
***************
*** 183,189 ****
@item addresses
Mappings between submitter IDs and submitters' e-mail addresses. Use of
this file is optional. If you get Problem reports where the
! @samp{>Submitter} field is not filled in, @sc{gnats} will use entries in
this file to try to derive the submitter ID from the e-mail headers.
@xref{addresses file,,The @code{addresses} file}.
--- 196,202 ----
@item addresses
Mappings between submitter IDs and submitters' e-mail addresses. Use of
this file is optional. If you get Problem reports where the
! @code{Submitter} field is not filled in, @sc{gnats} will use entries in
this file to try to derive the submitter ID from the e-mail headers.
@xref{addresses file,,The @code{addresses} file}.
***************
*** 256,263 ****
Note that if you add a new local database, you must create its data
directory, including appropriate subdirectories and administrative
! files. This is to be best done using the @code{mkdb} tool,
! @xref{mkdb}.
@node dbconfig file
--- 269,275 ----
Note that if you add a new local database, you must create its data
directory, including appropriate subdirectories and administrative
! files. This is best done using the @code{mkdb} tool, @xref{mkdb}.
@node dbconfig file
***************
*** 1210,1216 ****
@item responsible
A name-tag description of the party in question, such as her or his user
name, or the name of the group. This name is listed in the PR in
! the @samp{>Responsible:} field.
@item full-name
The full name of the party (``Charlotte Bronte''; ``Compiler Group'').
--- 1222,1228 ----
@item responsible
A name-tag description of the party in question, such as her or his user
name, or the name of the group. This name is listed in the PR in
! the @code{Responsible} field.
@item full-name
The full name of the party (``Charlotte Bronte''; ``Compiler Group'').
***************
*** 1275,1289 ****
expertise, etc., or it can remain blank.
@item resp-time
! Optional quoted response time in @dfn{business hours}. If the database
! @file{dbconfig} file has the @code{notify-about-expired-prs} entry set
! to @var{true} (@pxref{Overall database configuration,,Overall database
! configuration}, GNATS will use this field to schedule when @sc{gnats}
! should notify the gnats-admin, responsible person and submitter contact
! that the PR wasn't analyzed within the agreed response time. Business
! hours and business-week days are set in the @file{dbconfig} file. For
! information on @code{at-pr}, the program which sends out this reminder,
! see @ref{at-pr,,Timely Reminders}.
@item contact
The name tag of the main @dfn{contact} at the Support Site for this
--- 1287,1302 ----
expertise, etc., or it can remain blank.
@item resp-time
! Optional quoted response time in @dfn{business hours}. If the
! database @file{dbconfig} file has the @code{notify-about-expired-prs}
! entry set to @var{true} (@pxref{Overall database
! configuration,,Overall database configuration}, @sc{gnats} will use
! this field to schedule when it should notify the gnats-admin,
! responsible person and submitter contact that the PR wasn't analyzed
! within the agreed response time. Business hours and business-week
! days are set in the @file{dbconfig} file. For information on
! @code{at-pr}, the program which sends out this reminder, see
! @ref{at-pr,,Timely Reminders}.
@item contact
The name tag of the main @dfn{contact} at the Support Site for this
***************
*** 1307,1313 ****
@noindent
In this example, when a PR comes in from the University of Hades (who
has an eternal contract), it should have @samp{univ-hell} in its
! @samp{Submitter-Id} field. This Problem Report goes to @code{beelzebub}
(who should be in the @file{responsible} file), and if it is not
analyzed within three business hours a reminder message is sent.
@code{lucifer} also receives a copy of the bug, and a copy of the
--- 1320,1326 ----
@noindent
In this example, when a PR comes in from the University of Hades (who
has an eternal contract), it should have @samp{univ-hell} in its
! @code{Submitter-Id} field. This Problem Report goes to @code{beelzebub}
(who should be in the @file{responsible} file), and if it is not
analyzed within three business hours a reminder message is sent.
@code{lucifer} also receives a copy of the bug, and a copy of the
***************
*** 1318,1324 ****
@cindex disabling @var{submitter-id}
To disable the feature of @sc{gnats} which tracks the
! @samp{>Submitter-Id:}, simply alter the @file{submitters} file to only
contain one @var{submitter-id} value, and instruct your submitters to
ignore the field.
--- 1331,1337 ----
@cindex disabling @var{submitter-id}
To disable the feature of @sc{gnats} which tracks the
! @code{Submitter-Id}, simply alter the @file{submitters} file to only
contain one @var{submitter-id} value, and instruct your submitters to
ignore the field.
***************
*** 1566,1572 ****
A plain-text index contains single-line entries for all PR fields
except for the multitext fields such as Description, How-To-Repeat,
etc. Fields are separated by bars (@samp{|}) except for
! @samp{>Category:} and @samp{>Number:}, which are separated by a slash
(@samp{/}).
Binary indexes are not meant to be human-readable, but they are safer
--- 1579,1585 ----
A plain-text index contains single-line entries for all PR fields
except for the multitext fields such as Description, How-To-Repeat,
etc. Fields are separated by bars (@samp{|}) except for
! @code{Category} and @code{Number}, which are separated by a slash
(@samp{/}).
Binary indexes are not meant to be human-readable, but they are safer
***************
*** 1859,1868 ****
@table @code
@item -q
@itemx --queue
! Accepts standard input as an incoming mail message, placing this message
! in an incrementally numbered file in the @address@hidden directory
! under @address@hidden@var{DATABASEDIR}}} (@pxref{Locations,,Where @sc{gnats}
! lives}).
@item -r
@itemx --run
--- 1872,1881 ----
@table @code
@item -q
@itemx --queue
! Accepts standard input as an incoming mail message, placing this
! message in an incrementally numbered file in the
! @address@hidden directory under the database directory
! (@pxref{Locations,,Where @sc{gnats} lives}).
@item -r
@itemx --run
***************
*** 1902,1922 ****
@code{queue-pr} hands off queued Problem Reports to @code{file-pr} one
at a time. @code{file-pr} checks each Problem Report for correct
! information in its fields (particularly a correct @samp{>Category:}),
assigns it an identification number, and files it in the database under
the appropriate category.
! If the @samp{>Category:} field does not contain a valid category value
(i.e., matching a line in the @code{categories} file; @pxref{categories
file,,The @code{categories} file}), the PR is assigned to the default
category, as set in the @code{dbconfig} file. If there is no default
! category defined, the PR is given a @samp{>Category:} value of
@samp{pending} and is placed in the @file{pending} directory. The
@sc{gnats} administrator is notified of the unplaceable PR.
@code{file-pr} assigns the Problem Report an identification number,
files it in the @sc{gnats} database (under the default, if the
! @samp{>Category:} field contains an invalid category), and sends
acknowledgments to appropriate parties. For the default @sc{gnats}
configuration, the person responsible for that category of problem
(@pxref{categories file,,The @code{categories} file}) and the person
--- 1915,1935 ----
@code{queue-pr} hands off queued Problem Reports to @code{file-pr} one
at a time. @code{file-pr} checks each Problem Report for correct
! information in its fields (particularly a correct @code{Category}),
assigns it an identification number, and files it in the database under
the appropriate category.
! If the @code{Category} field does not contain a valid category value
(i.e., matching a line in the @code{categories} file; @pxref{categories
file,,The @code{categories} file}), the PR is assigned to the default
category, as set in the @code{dbconfig} file. If there is no default
! category defined, the PR is given a @code{Category} value of
@samp{pending} and is placed in the @file{pending} directory. The
@sc{gnats} administrator is notified of the unplaceable PR.
@code{file-pr} assigns the Problem Report an identification number,
files it in the @sc{gnats} database (under the default, if the
! @code{Category} field contains an invalid category), and sends
acknowledgments to appropriate parties. For the default @sc{gnats}
configuration, the person responsible for that category of problem
(@pxref{categories file,,The @code{categories} file}) and the person