1CVSBUG(8) System Manager's Manual CVSBUG(8)
2
3
4
6 cvsbug - send problem report (PR) about CVS to a central support site
7
9 cvsbug [ site ] [ -f problem-report ] [ -t mail-address ]
10 [ -P ] [ -L ] [ --request-id ] [ -v ]
11
13 cvsbug is a tool used to submit problem reports (PRs) to a central sup‐
14 port site. In most cases the correct site will be the default. This
15 argument indicates the support site which is responsible for the cate‐
16 gory of problem involved. Some sites may use a local address as a
17 default. site values are defined by using the aliases(5).
18
19 cvsbug invokes an editor on a problem report template (after trying to
20 fill in some fields with reasonable default values). When you exit the
21 editor, cvsbug sends the completed form to the Problem Report Manage‐
22 ment System (GNATS) at a central support site. At the support site,
23 the PR is assigned a unique number and is stored in the GNATS database
24 according to its category and submitter-id. GNATS automatically
25 replies with an acknowledgement, citing the category and the PR number.
26
27 To ensure that a PR is handled promptly, it should contain your
28 (unique) submitter-id and one of the available categories to identify
29 the problem area. (Use `cvsbug -L' to see a list of categories.)
30
31 The cvsbug template at your site should already be customized with your
32 submitter-id (running `install-sid submitter-id' to accomplish this is
33 part of the installation procedures for cvsbug). If this hasn't been
34 done, see your system administrator for your submitter-id, or request
35 one from your support site by invoking `cvsbug --request-id'. If your
36 site does not distinguish between different user sites, or if you are
37 not affiliated with the support site, use `net' for this field.
38
39 The more precise your problem description and the more complete your
40 information, the faster your support team can solve your problems.
41
43 -f problem-report
44 specify a file (problem-report) which already contains a com‐
45 plete problem report. cvsbug sends the contents of the file
46 without invoking the editor. If the value for problem-report is
47 `-', then cvsbug reads from standard input.
48
49 -t mail-address
50 Change mail address at the support site for problem reports.
51 The default mail-address is the address used for the default
52 site. Use the site argument rather than this option in nearly
53 all cases.
54
55 -P print the form specified by the environment variable PR_FORM on
56 standard output. If PR_FORM is not set, print the standard
57 blank PR template. No mail is sent.
58
59 -L print the list of available categories. No mail is sent.
60
61 --request-id
62 sends mail to the default support site, or site if specified,
63 with a request for your submitter-id. If you are not affiliated
64 with site, use a submitter-id of net'.
65
66 -v Display the cvsbug version number.
67
68 Note: use cvsbug to submit problem reports rather than mailing them
69 directly. Using both the template and cvsbug itself will help ensure
70 all necessary information will reach the support site.
71
73 The environment variable EDITOR specifies the editor to invoke on the
74 template.
75 default: vi
76
77 If the environment variable PR_FORM is set, then its value is used as
78 the file name of the template for your problem-report editing session.
79 You can use this to start with a partially completed form (for example,
80 a form with the identification fields already completed).
81
83 Problem reports have to be in a particular form so that a program can
84 easily manage them. Please remember the following guidelines:
85
86 · describe only one problem with each problem report.
87
88 · For follow-up mail, use the same subject line as the one in the
89 automatic acknowledgement. It consists of category, PR number and
90 the original synopsis line. This allows the support site to relate
91 several mail messages to a particular PR and to record them automat‐
92 ically.
93
94 · Please try to be as accurate as possible in the subject and/or syn‐
95 opsis line.
96
97 · The subject and the synopsis line are not confidential. This is
98 because open-bugs lists are compiled from them. Avoid confidential
99 information there.
100
101 See the GNU Info file cvsbug.info or the document Reporting Problems
102 With cvsbug for detailed information on reporting problems
103
105 Submit small code samples with the PR. Contact the support site for
106 instructions on submitting larger test cases and problematic source
107 code.
108
110 /tmp/p$$ copy of PR used in editing session
111 /tmp/pf$$ copy of empty PR form, for testing purposes
112 /tmp/pbad$$ file for rejected PRs
113
115 See INSTALL for installation instructions.
116
118 gnats(l), query-pr(1), edit-pr(1), gnats(8), queue-pr(8), at-pr(8),
119 mkcat(8), mkdist(8).
120
122 Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl (Cygnus
123 Support)
124
126 Copyright (c) 1992, 1993 Free Software Foundation, Inc.
127
128 Permission is granted to make and distribute verbatim copies of this
129 manual provided the copyright notice and this permission notice are
130 preserved on all copies.
131
132 Permission is granted to copy and distribute modified versions of this
133 manual under the conditions for verbatim copying, provided that the
134 entire resulting derived work is distributed under the terms of a per‐
135 mission notice identical to this one.
136
137 Permission is granted to copy and distribute translations of this man‐
138 ual into another language, under the above conditions for modified ver‐
139 sions, except that this permission notice may be included in transla‐
140 tions approved by the Free Software Foundation instead of in the origi‐
141 nal English.
142
143
144
145
146February 1993 xVERSIONx CVSBUG(8)