forked from openss7/openss7
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathPROBLEMS
278 lines (227 loc) · 12.2 KB
/
PROBLEMS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
OpenSS7 -- problem reports. 2018-11-19
$Id: PROBLEMS,v 1.1.2.25 2011-05-10 13:45:30 brian Exp $
Copyright (c) 2008-2018 Monavacon Limited. <http://www.monavacon.com/>
Copyright (c) 2001-2008 OpenSS7 Corporation. <http://www.openss7.com/>
Copyright (c) 1997-2001 Brian Bidulock <[email protected]>
See the end for copying conditions (for this file).
8.2 Problem Reports
===================
8.2.1 Problem Report Guidelines
-------------------------------
Problem reports in the following categories should include a log file as
indicated in the table below:
'./configure'
A problem with the configuration process occurs that causes the
'./configure' command to fail. The problem report must include the
'config.log' file that was generated by 'configure'.
'make compile.log'
A problem with the build process occurs that causes the 'make'
command to fail. Perform 'make clean' and then 'make compile.log'
and attach the 'config.log' and 'compile.log' files to the problem
report.
'make check.log'
A problem occurs with the 'make check' target that causes it to
fail. Perform 'make check-clean check.log' and attach the
'config.log', 'compile.log' and 'check.log' files to the problem
report.
'sudo make install.log'
A problem occurs with 'sudo make install' that causes it to fail.
Perform 'sudo make uninstall' and 'sudo make install.log' and
attach the 'config.log', 'compile.log', 'check.log', and
'install.log' files to the problem report.
'[sudo] make installcheck.log'
A problem occurs with the 'make installcheck' target that causes
the test suite to fail. Attach the resulting 'tests/testsuite.log'
and 'installcheck.log' file to the problem report. There is no
need to attach the other files as they are included in
'tests/testsuite.log'.
'[sudo] make uninstall.log'
A problem occurs with the 'make uninstall' target that causes the
test suite to fail. Perform 'sudo make uninstall.log' and attach
the 'config.log', 'compile.log', 'check.log', 'install.log',
'installcheck.log', 'tests/testsuite.log' and 'uninstall.log' file
to the problem report.
'[sudo] make remove.log'
A problem occurs with the 'make remove' target that causes the test
suite to fail. Perform 'sudo make remove.log' and attach the
'config.log', 'compile.log', 'check.log', 'install.log',
'installcheck.log', 'tests/testsuite.log' and 'remove.log' file to
the problem report.
For other problems that occur during the use of the 'OpenSS7' package,
please write a test case for the test suite that recreates the problem
if one does not yet exist and provide a test program patch with the
problem report. Also include whatever log files are generated by the
kernel ('cmn_err(9)') or by the 'strerr(8)' or 'strace(1)' facilities
('strlog(9)').
8.2.2 Generating Problem Reports
--------------------------------
'The OpenSS7 Project' uses the 'GNU GNATS' system for problem reporting.
Although the 'send-pr' tool from the 'GNU GNATS' package can be used for
bug reporting to the project's 'GNATS' database using electronic mail,
it is not always convenient to download and install the 'GNATS' system
to gain access to the 'send-pr' tool.
Therefore, the 'OpenSS7' package provides the 'send-pr' shell script
that can be used for problem reporting. The 'send-pr' shell script can
invoked directly and is a work-alike for the 'GNU' 'send-pr' tool.
The 'send-pr' tool takes the same flags and can be used in the same
fashion, however, whereas 'send-pr' is an interactive tool(1), 'send-pr'
is also able to perform batch processing. Whereas 'send-pr' takes its
field information from local databases or from using the 'query-pr'
C-language program to query a remote database, the 'send-pr' tool has
the field database internal to the tool.
Problem reports can be generate using 'make', *Note Problem Report
Targets::. An example of how simple it is to generate a problem report
is illustrated in *note Example 8.6: autopr:ex0.
% make pr
SEND-PR:
SEND-PR: send-pr: send-pr was invoked to generate an external report. An
SEND-PR: automated problem report has been created in the file named
SEND-PR: 'problem.pr' in the current directory. This problem report can
SEND-PR: be sent to [email protected] by calling this script as
SEND-PR: '/home/brian/os7/scripts/send-pr --file="problem.pr"'.
SEND-PR:
SEND-PR: It is possible to edit some of the fields before sending on the
SEND-PR: problem report. Please remember that there is NO WARRANTY. See
SEND-PR: the file 'COPYING' in the top level directory.
SEND-PR:
SEND-PR: Please do not send confidential information to the bug report
SEND-PR: address. Inspect the file 'problem.pr' for confidential
SEND-PR: information before mailing.
SEND-PR:
% vim problem.pr # <--- follow instructions at head of file
% make send-pr
Example 8.6: _Invoking Problem Report Generation_
Using the 'make pr' target to generate a problem report has the
advantages that it will assemble any available '*.log' files in the
build directory and attach them to the problem report.
---------- Footnotes ----------
(1) 'send-pr' launches the user's EDITOR to edit the problem report
before submitting it.
8.2.3 Automatic Problem Reports
-------------------------------
The 'OpenSS7' package also provides a feature for automatic problem
report generation that meets the problem report submission guidelines
detailed in the preceding sections.
Whenever a logging makefile target (*note Logging Targets::) is invoked,
if the primary target fails, the 'send-pr' shell script is invoked to
automatically generate a problem report file suitable for the
corresponding target (as described above under *note Problem Report
Guidelines::). An example is shown in *note Example 8.7: autopr:ex1.
% make compile.log
...
...
make[5]: *** [libXNSdrvs_a-ip.o] Error 1
make[5]: Leaving directory `/u6/buildel4/strxns'
make[4]: *** [all-recursive] Error 1
make[4]: Leaving directory `/u6/buildel4/strxns'
make[3]: *** [all] Error 2
make[3]: Leaving directory `/u6/buildel4/strxns'
make[2]: *** [all-recursive] Error 1
make[2]: Leaving directory `/u6/buildel4'
make[1]: *** [all] Error 2
make[1]: Leaving directory `/u6/buildel4'
SEND-PR:
SEND-PR: send-pr: Make target compile.log failed in the compile stage. An
SEND-PR: automated problem report has been created in the file named
SEND-PR: 'problem.pr' in the current directory. This problem report can
SEND-PR: be sent to [email protected] by calling 'make send-pr'.
SEND-PR:
SEND-PR: It is possible to edit some of the fields before sending on the
SEND-PR: problem report. Please remember that there is NO WARRANTY. See
SEND-PR: the file 'COPYING' in the top level directory.
SEND-PR:
SEND-PR: Please do not send confidential information to the bug report
SEND-PR: address. Inspect the file 'problem.pr' for confidential
SEND-PR: information before mailing.
SEND-PR:
% vim problem.pr # <--- follow instructions at head of file
% make send-pr
Example 8.7: _Problem Report from Failed Logging Target_
8.2.4 Stand Alone Problem Reports
---------------------------------
The 'OpenSS7' package installs the 'send-pr' script and its
configuration file 'send-pr.config' in '${libexecdir}/openss7' along
with the validation 'testsuite', see *Note Test Suites::. As with the
'testsuite', this allows the 'send-pr' script to be used for problem
report generation on an installed system that does not have a build
directory.
An example of invoking the package 'testsuite' and then generating a
problem report for failed cases is shown in *note Example 8.8:
autopr:ex2.
% [sudo] /usr/libexec/openss7/testsuite
% # test cases failed...
% /usr/libexec/openss7/send-pr
SEND-PR:
SEND-PR: send-pr: send-pr was invoked to generate an external report. An
SEND-PR: automated problem report has been created in the file named
SEND-PR: 'problem.pr' in the current directory. This problem report can
SEND-PR: be sent to [email protected] by calling this script as
SEND-PR: '/usr/libexec/openss7/send-pr --file problem.pr'.
SEND-PR:
SEND-PR: It is possible to edit some of the fields before sending on the
SEND-PR: problem report. Please remember that there is NO WARRANTY. See
SEND-PR: the file 'COPYING' in the top level directory.
SEND-PR:
SEND-PR: Please do not send confidential information to the bug report
SEND-PR: address. Inspect the file 'problem.pr' for confidential
SEND-PR: information before mailing.
SEND-PR:
% vim problem.pr # <--- follow instructions at head of file
% /usr/libexec/openss7/send-pr --file problem.pr
Example 8.8: _Invoking 'send-pr' Directly_
The advantage of the approach shown in the example is that the 'send-pr'
script is capable of collecting the 'testsuite.log' file and the failed
test cases and debugging scripts from the 'testsuite.dir' directory and
including them in the problem report, as well as all package pertinent
information from the installed 'send-pr.config'.
8.3 Known Problems
==================
'The OpenSS7 Project' does not ship software with known bugs. All bugs
are unknown.
Verified behaviour is that behaviour that has been verified by
conformance test suites that are shipped with the 'OpenSS7' package.
Unverified behaviour may contain unknown bugs.
Please remember that there is *NO WARRANTY*.
See also *note Bugs::, or file 'BUGS' in the release directory.
-----
=========================================================================
Copyright (c) 2008-2011 Monavacon Limited <http://www.monavacon.com/>
Copyright (c) 2001-2008 OpenSS7 Corporation <http://www.openss7.com/>
Copyright (c) 1997-2001 Brian Bidulock <[email protected]>
All Rights Reserved.
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one
Since the Linux kernel and libraries are constantly changing, this
manual page may be incorrect or out-of-date. The author(s) assume no
responsibility for errors or omissions, or for damages resulting from
the use of the information contained herein. The author(s) may not
have taken the same level of care in the production of this manual,
which is licensed free of charge, as they might when working
professionally.
Formatted or processed versions of this manual, if unaccompanied by the
source, must acknowledge the copyright and authors of this work.
-------------------------------------------------------------------------
U.S. GOVERNMENT RESTRICTED RIGHTS. If you are licensing this Software
on behalf of the U.S. Government ("Government"), the following
provisions apply to you. If the Software is supplied by the Department
of Defense ("DoD"), it is classified as "Commercial Computer Software"
under paragraph 252.227-7014 of the DoD Supplement to the Federal
Acquisition Regulations ("DFARS") (or any successor regulations) and
the Government is acquiring only the license rights granted herein (the
license rights customarily provided to non-Government users). If the
Software is supplied to any unit or agency of the Government other than
DoD, it is classified as "Restricted Computer Software" and the
Government's rights in the Software are defined in paragraph 52.227-19
of the Federal Acquisition Regulations ("FAR") (or any successor
regulations) or, in the cases of NASA, in paragraph 18.52.227-86 of the
NASA Supplement to the FAR (or any successor regulations).
=========================================================================
Commercial licensing and support of this software is available from
OpenSS7 Corporation at a fee. See http://www.openss7.com/
=========================================================================
vim: ft=README tw=72 nocindent nosmartindent formatoptions+=tcqlorn