Date: Tue, 20 Jan 2004 15:10:16 -0800 (PST) From: Ceri Davies <ceri@submonkey.net> To: freebsd-doc@FreeBSD.org Subject: Re: docs/61653: [patch] cleanup after recent changes to Porter's Handbook Message-ID: <200401202310.i0KNAGIm080152@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
The following reply was made to PR docs/61653; it has been noted by GNATS. From: Ceri Davies <ceri@submonkey.net> To: Mark Linimon <linimon@lonesome.com> Cc: FreeBSD-gnats-submit@FreeBSD.org Subject: Re: docs/61653: [patch] cleanup after recent changes to Porter's Handbook Date: Tue, 20 Jan 2004 23:04:46 +0000 --6zipuvUKAEymKn2g Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Tue, Jan 20, 2004 at 04:47:28PM -0600, Mark Linimon wrote: Mark, Please commit this (with my approval), proviso the inline comments below. Thanks for following up on this. > @@ -348,8 +348,19 @@ > Also add a short description of the program you ported > to the <quote>Description</quote> field of the PR and > the shar or uuencoded tarfile to the > - <quote>Fix</quote> field. The latter one helps the committers > - a lot, who use scripts for the ports-work.</para> > + <quote>Fix</quote> field.</para> > + > + <note> > + <para>You can make our work a lot easier, if you use a good > + description in the synopsis of the problem report. > + We prefer something like > + <quote>New port: <category>/<portname> > + <short description of the port></quote> for new ports and > + <quote>Update port: <category>/<portname> > + <short description of the update></quote> for port updates. > + If you stick to this scheme, the chance that someone takes a > + look at your PR soon is much bigger.</para> s/someone takes/someone will take/, s/bigger/better/ (I can be swayed on the second - your call). > @@ -2793,7 +2793,9 @@ > <para>Set your mail-address here. Please. <!-- smiley > --><emphasis>:-)</emphasis></para> > =20 > - <para>The format used should be <literal>user@hostname.domain</literal>. > + <para>Note that only a single address without comment part is > + allowed as a <makevar>MAINTAINER</makevar> value. > + The format used should be <literal>user@hostname.domain</literal>. s/without comment/the comment/ ? > @@ -4634,23 +4636,23 @@ > =20 > <para>If the maintainer asks you to do the upgrade or the maintain= er > is <literal>ports@FreeBSD.org</literal>, > - please make the upgrade and send the > + please make the upgrade and save the result of the > recursive <command>diff</command> output > of the new and old > - ports directories to us (e.g., if your modified port directory is > + ports directories. (e.g., if your modified port directory is There shouldn't be a period there. > called <filename>superedit</filename> and the original is in our tree > - as <filename>superedit.bak</filename>, then send us the result of > + as <filename>superedit.bak</filename>, then save the result of > <command>diff -ruN superedit.bak superedit</command>). Either > unified or context diff is fine, but port committers generally > prefer unified diffs. Note the use of the <literal>-N</literal> > option—this is the accepted way to force diff to properly > deal with the case of new files being added or old files being > - deleted.</para> > + deleted. Before sendingus the diff, please examine the > + output to make sure all the changes make sense.</para> s/sendingus/sending us/ Cheers, Ceri --=20 --6zipuvUKAEymKn2g Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.4 (FreeBSD) iD8DBQFADbQOocfcwTS3JF8RAv2MAJ4iGYYC8K9R4QQIvgz917N0QlBlbACgp4WB d46zQieSUVcjvt+owKeyaWU= =p1NN -----END PGP SIGNATURE----- --6zipuvUKAEymKn2g--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200401202310.i0KNAGIm080152>