Date: Sun, 25 Nov 2001 00:46:18 +0200 From: Peter Pentchev <roam@ringlet.net> To: Dag-Erling Smorgrav <des@ofug.org> Cc: doc@FreeBSD.org Subject: Re: Add an "Other resources" section to the problem reports article Message-ID: <20011125004618.C580@straylight.oblivion.bg> In-Reply-To: <xzpu1vj94m5.fsf@flood.ping.uio.no>; from des@ofug.org on Sat, Nov 24, 2001 at 11:38:26PM %2B0100 References: <20011125002117.B580@straylight.oblivion.bg> <xzpu1vj94m5.fsf@flood.ping.uio.no>
next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, Nov 24, 2001 at 11:38:26PM +0100, Dag-Erling Smorgrav wrote:
> Peter Pentchev <roam@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>
+ </listitem>
+ </itemizedlist>
+ </sect1>
</article>
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20011125004618.C580>