Date: Fri, 9 May 2003 02:21:46 +0200 From: "Simon L. Nielsen" <simon@nitro.dk> To: Mark Linimon <linimon@lonesome.com> Cc: freebsd-doc@freebsd.org Subject: Re: RFC: additions to the article "problem-reports" Message-ID: <20030509002145.GA5787@nitro.dk> In-Reply-To: <200305081851.41118.linimon@lonesome.com> References: <200305081851.41118.linimon@lonesome.com>
next in thread | previous in thread | raw e-mail | index | archive | help
--/WwmFnJnmDyWGHa4 Content-Type: multipart/mixed; boundary="J2SCkAp4GZ/dPZZf" Content-Disposition: inline --J2SCkAp4GZ/dPZZf Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On 2003.05.08 18:51:41 -0500, Mark Linimon wrote: > While working on my project to classify ports PRs in the database, > I've come across more than my fair share of PRs that are really > badly written. Although the problem-reports article touches on > this to some degree, I really feel that some of the most obvious > mistakes bear further explanation. >=20 [CUT] >=20 > In any case I think this is a necessary, but probably insufficient, > change for the documentation, and I'd like to see what other > people think. Consider it a starting point. There were a few markup errors but considering that you havn't tried to build it I actually think it was very few :-) - Patch to be applyed after your patch should be attached. You mention the subject of the pr but actually this is called Synopsis when using send-pr(1) so I think that you should use that term instead. Other than that I really like the change and I think the tips are good. Nice work! Btw. if you want to see how it looks build I just put it at http://simon.nitro.dk/freebsd/files/misc/pr-article-with-tips.html . --=20 Simon L. Nielsen --J2SCkAp4GZ/dPZZf Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename="pr-tips-patch.patch" Content-Transfer-Encoding: quoted-printable --- article.sgml Fri May 9 02:02:14 2003 +++ article.sgml.sln Fri May 9 02:16:16 2003 @@ -234,7 +234,7 @@ <para><emphasis>If you are a maintainer, say so</emphasis> By convention, if you are maintaining a part of the source code (for instance, a port), put the string - <literal>[maintainer update]</listeral> at the + <literal>[maintainer update]</literal> at the beginning of your Subject: line.</para> </listitem> =20 @@ -246,7 +246,7 @@ running (there is a place to put that, see below); which architecture you are running on; whether you are running from a release CDROM, or from - a system maintained by &cvsup.1; (and, if so, how + a system maintained by &man.cvsup.1; (and, if so, how recently you updated); and, if a kernel problem, if you have read <literal>src/UPDATING</literal> (someone is guaranteed to ask). You do not necessarily @@ -276,7 +276,7 @@ Although this has already been mentioned above, it bears repeating here. It only take a minute or two to use the web-based search engine. (Of course, everyone is guilty of - forgetting to do this now and then.) + forgetting to do this now and then.)</para> </listitem> =20 <listitem> @@ -298,7 +298,7 @@ thing to keep in mind at all times on Open Source projects.</para> </listitem> - =20 + </itemizedlist> </section> =20 <section> --J2SCkAp4GZ/dPZZf-- --/WwmFnJnmDyWGHa4 Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.1 (FreeBSD) iD8DBQE+uvSZ8kocFXgPTRwRArAuAJ4r6S/YZV0RSoj9WOZUyGse0Kkh8wCfVOYV NWoeCCxH68+EWWPzE39s1Pw= =C8YW -----END PGP SIGNATURE----- --/WwmFnJnmDyWGHa4--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030509002145.GA5787>