Add an "Other resources" section to the problem reports article

[Peter Pentchev]

Hi,

What do you think about the attached patch that adds a "Other resources"
section to your article on writing problem reports, and includes a link
to Simon G. Tatham's wonderful essay on submitting problem reports?

G'luck,
Peter

--
What would this sentence be like if pi were 3?

Index: doc/en_US.ISO8859-1/articles/problem-reports/article.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/problem-reports/article.sgml,v
retrieving revision 1.6
diff -u -r1.6 article.sgml
--- doc/en_US.ISO8859-1/articles/problem-reports/article.sgml 23 Nov 2001 21:13:13 -0000 1.6
+++ doc/en_US.ISO8859-1/articles/problem-reports/article.sgml 24 Nov 2001 22:16:15 -0000
@@ -491,4 +491,21 @@
above) saying that the problem report can be closed, and, if
possible, explaining how or when the problem was fixed.</para>
</sect1>
+
+ <sect1 id="resources">
+ <title>Other resources</title>
+
+ <para>This is a list of resources relevant to the proper submitting
+ and processing of problem reports. It is by no means complete.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><ulink
+ url="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html">
+ How to Report Bugs Effectively</ulink> - an excellent
+ essay on submitting useful (non-FreeBSD-specific) problem reports
+ by Simon G. Tatham.</para>
+ </listitem>
+ </itemizedlist>
+ </sect1>
</article>

To Unsubscribe: send mail to majo...@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message

[Dag-Erling Smorgrav]

Peter Pentchev <ro...@ringlet.net> writes:
> What do you think about the attached patch that adds a "Other resources"
> section to your article on writing problem reports, and includes a link
> to Simon G. Tatham's wonderful essay on submitting problem reports?

I have a few amendments:

- change the title to "Further Reading"
- change the section ID to "pr-further"
- change "submitting" to "writing"
- move "by Simon G. Tatham" to right after "essay"

DES
--
Dag-Erling Smorgrav - d...@ofug.org

[Peter Pentchev]

On Sat, Nov 24, 2001 at 11:38:26PM +0100, Dag-Erling Smorgrav wrote:
> Peter Pentchev <ro...@ringlet.net> writes:
> > What do you think about the attached patch that adds a "Other resources"
> > section to your article on writing problem reports, and includes a link
> > to Simon G. Tatham's wonderful essay on submitting problem reports?
>

> I have a few amendments:
>
> - change the title to "Further Reading"
> - change the section ID to "pr-further"
> - change "submitting" to "writing"
> - move "by Simon G. Tatham" to right after "essay"

Okay, updated patch attached. I was not quite sure which instance
of 'submitting' you had in mind, so I changed both in different ways :)
Also, I removed the dot after the 'G' in Simon G. Tatham, since some
browsers place additional whitespace after it.

G'luck,
Peter

--
I am the meaning of this sentence.

Index: doc/en_US.ISO8859-1/articles/problem-reports/article.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/problem-reports/article.sgml,v
retrieving revision 1.6
diff -u -r1.6 article.sgml
--- doc/en_US.ISO8859-1/articles/problem-reports/article.sgml 23 Nov 2001 21:13:13 -0000 1.6

+++ doc/en_US.ISO8859-1/articles/problem-reports/article.sgml 24 Nov 2001 22:42:44 -0000

@@ -491,4 +491,21 @@
above) saying that the problem report can be closed, and, if
possible, explaining how or when the problem was fixed.</para>
</sect1>
+

+ <sect1 id="pr-further">
+ <title>Further Reading</title>
+
+ <para>This is a list of resources relevant to the proper writing

+ and processing of problem reports. It is by no means complete.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><ulink
+ url="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html">
+ How to Report Bugs Effectively</ulink> - an excellent

+ essay by Simon G Tatham on composing useful (non-FreeBSD-specific)
+ problem reports.</para>

[Gary W. Swearingen]

Peter Pentchev <ro...@ringlet.net> writes:

> Also, I removed the dot after the 'G' in Simon G. Tatham, since some
> browsers place additional whitespace after it.

That seems a poor reason to violate standard English. Browsers should
REMOVE whitespace after it, like Netscape does. But you're doin' the
work, so I can't complain (much).

BTW, Harry S Truman's name was not Harry S. Truman (if periods mean
anything). He said his middle name was a compromise between the
competing names of grandparents. He often used a period in his
signature and the "U.S. Government Printing Office Style Manual"
recommends its use in his name.

"The Chicago Manual of Style" suggests use of the period even for
single-letter middle names.

Cf. http://www.trumanlibrary.org/speriod.htm

P.S. Thanks for the reply about "penv".

[Peter Pentchev]

On Sat, Nov 24, 2001 at 04:03:58PM -0800, Gary W. Swearingen wrote:
> Peter Pentchev <ro...@ringlet.net> writes:
>
> > Also, I removed the dot after the 'G' in Simon G. Tatham, since some
> > browsers place additional whitespace after it.
>
> That seems a poor reason to violate standard English. Browsers should
> REMOVE whitespace after it, like Netscape does. But you're doin' the
> work, so I can't complain (much).

OK, so I'll add it back. I'll commit the attached patch in about
twelve hours, if there are no serious objections.

Thanks for the feedback; I was holding back on the commit just to see
if somebody could see something wrong with the patch - it turns out
that there was something wrong indeed :)

G'luck,
Peter

--
If the meanings of 'true' and 'false' were switched, then this sentence wouldn't be false.

Index: doc/en_US.ISO8859-1/articles/problem-reports/article.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/problem-reports/article.sgml,v
retrieving revision 1.6
diff -u -r1.6 article.sgml
--- doc/en_US.ISO8859-1/articles/problem-reports/article.sgml 23 Nov 2001 21:13:13 -0000 1.6

+++ doc/en_US.ISO8859-1/articles/problem-reports/article.sgml 24 Nov 2001 22:45:14 -0000

@@ -491,4 +491,21 @@
above) saying that the problem report can be closed, and, if
possible, explaining how or when the problem was fixed.</para>
</sect1>
+

+ <sect1 id="pr-further">
+ <title>Further Reading</title>
+
+ <para>This is a list of resources relevant to the proper writing

+ and processing of problem reports. It is by no means complete.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><ulink
+ url="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html">
+ How to Report Bugs Effectively</ulink> - an excellent

+ essay by Simon G. Tatham on composing useful (non-FreeBSD-specific)
+ problem reports.</para>