Penguin
Recent Changes
Annotated edit history of cvsbug(8) version 4, including all changes. View license author blame.
Rev Author # Line
1 perry 1 CVSBUG
2 !!!CVSBUG
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 ENVIRONMENT
8 HOW TO FILL OUT A PROBLEM REPORT
9 HOW TO SUBMIT TEST CASES, CODE, ETC.
10 FILES
11 INSTALLATION AND CONFIGURATION
12 SEE ALSO
13 AUTHORS
14 COPYING
15 ----
16 !!NAME
17
18
19 cvsbug - send problem report (PR) about CVS to a central support site
20 !!SYNOPSIS
21
22
23 __cvsbug__ [[ ''site'' ] [[ __-f__
24 ''problem-report'' ] [[ __-t__ ''mail-address''
25 ]
26
27
28 [[ __-P__ ] [[ __-L__ ] [[ __--request-id__ ] [[
29 __-v__ ]
30 !!DESCRIPTION
31
32
33 __cvsbug__ is a tool used to submit ''problem
34 reports'' (PRs) to a central support site. In most cases
35 the correct ''site'' will be the default. This argument
36 indicates the support site which is responsible for the
37 category of problem involved. Some sites may use a local
38 address as a default. ''site'' values are defined by
39 using the aliases(5).
40
41
42 __cvsbug__ invokes an editor on a problem report template
43 (after trying to fill in some fields with reasonable default
44 values). When you exit the editor, __cvsbug__ sends the
45 completed form to the ''Problem Report Management
46 System'' (__GNATS__) at a central support site. At the
47 support site, the PR is assigned a unique number and is
48 stored in the __GNATS__ database according to its
49 category and submitter-id. __GNATS__ automatically
50 replies with an acknowledgement, citing the category and the
51 PR number.
52
53
54 To ensure that a PR is handled promptly, it should contain
55 your (unique) ''submitter-id'' and one of the available
56 ''categories'' to identify the problem area. (Use
57 __`cvsbug -L'__ to see a list of
58 categories.)
59
60
61 The __cvsbug__ template at your site should already be
62 customized with your submitter-id (running
63 `__install-sid__ ''submitter-id''' to accomplish this
64 is part of the installation procedures for __cvsbug__).
65 If this hasn't been done, see your system administrator for
66 your submitter-id, or request one from your support site by
67 invoking __`cvsbug --request-id'.__ If your site does not
68 distinguish between different user sites, or if you are not
69 affiliated with the support site, use __`net'__ for this
70 field.
71
72
73 The more precise your problem description and the more
74 complete your information, the faster your support team can
75 solve your problems.
76 !!OPTIONS
77
78
79 __-f__ ''problem-report''
80
81
82 specify a file (''problem-report'') which already
83 contains a complete problem report. __cvsbug__ sends the
84 contents of the file without invoking the editor. If the
85 value for ''problem-report'' is __`-'__, then
86 __cvsbug__ reads from standard input.
87
88
89 __-t__ ''mail-address''
90
91
92 Change mail address at the support site for problem reports.
93 The default ''mail-address'' is the address used for the
94 default ''site''. Use the ''site'' argument rather
95 than this option in nearly all cases.
96
97
98 __-P__
99
100
101 print the form specified by the environment variable
102 __PR_FORM__ on standard output. If __PR_FORM__ is not
103 set, print the standard blank PR template. No mail is
104 sent.
105
106
107 __-L__
108
109
110 print the list of available categories. No mail is
111 sent.
112
113
114 __--request-id__
115
116
117 sends mail to the default support site, or ''site'' if
118 specified, with a request for your ''submitter-id''. If
119 you are not affiliated with ''site'', use a
120 ''submitter-id'' of __net__'.
121
122
123 __-v__
124
125
126 Display the __cvsbug__ version number.
127
128
129 Note: use __cvsbug__ to submit problem reports rather
130 than mailing them directly. Using both the template and
131 __cvsbug__ itself will help ensure all necessary
132 information will reach the support site.
133 !!ENVIRONMENT
134
135
136 The environment variable __EDITOR__ specifies the editor
137 to invoke on the template.
138 default: __vi__
139
140
141 If the environment variable __PR_FORM__ is set, then its
142 value is used as the file name of the template for your
143 problem-report editing session. You can use this to start
144 with a partially completed form (for example, a form with
145 the identification fields already completed).
146 !!HOW TO FILL OUT A PROBLEM REPORT
147
148
149 Problem reports have to be in a particular form so that a
150 program can easily manage them. Please remember the
151 following guidelines:
152
153
154 describe only __one problem__ with each problem
155 report.
156
157
158 For follow-up mail, use the same subject line as the one in
159 the automatic acknowledgent. It consists of category, PR
160 number and the original synopsis line. This allows the
161 support site to relate several mail messages to a particular
162 PR and to record them automatically.
163
164
165 Please try to be as accurate as possible in the subject
166 and/or synopsis line.
167
168
169 The subject and the synopsis line are not confidential. This
170 is because open-bugs lists are compiled from them. Avoid
171 confidential information there.
172
173
174 See the GNU __Info__ file __cvsbug.info__ or the
175 document ''Reporting Problems With cvsbug'' for detailed
176 information on reporting problems
177 !!HOW TO SUBMIT TEST CASES, CODE, ETC.
178
179
180 Submit small code samples with the PR. Contact the support
181 site for instructions on submitting larger test cases and
182 problematic source code.
183 !!FILES
184
185
186 /tmp/p$$ copy of PR used in editing session
187 /tmp/pf$$ copy of empty PR form, for testing purposes
188 /tmp/pbad$$ file for rejected PRs
189 !!INSTALLATION AND CONFIGURATION
190
191
192 See __INSTALL__ for installation
193 instructions.
194 !!SEE ALSO
195
196
4 perry 197 __gnats__(l), query-pr(1), __edit-pr__(1),
198 gnats(8), queue-pr(8), __at-pr__(8),
1 perry 199 mkcat(8), mkdist(8).
200 !!AUTHORS
201
202
203 Jeffrey Osier, Brendan Kehoe, Jason Merrill, Heinz G. Seidl
204 (Cygnus Support)
205 !!COPYING
206
207
208 Copyright (c) 1992, 1993 Free Software Foundation,
209 Inc.
210
211
212 Permission is granted to make and distribute verbatim copies
213 of this manual provided the copyright notice and this
214 permission notice are preserved on all copies.
215
216
217 Permission is granted to copy and distribute modified
218 versions of this manual under the conditions for verbatim
219 copying, provided that the entire resulting derived work is
220 distributed under the terms of a permission notice identical
221 to this one.
222
223
224 Permission is granted to copy and distribute translations of
225 this manual into another language, under the above
226 conditions for modified versions, except that this
227 permission notice may be included in translations approved
228 by the Free Software Foundation instead of in the original
229 English.
230 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.