Date: Sat, 11 May 2002 02:00:09 -0700 (PDT) From: Giorgos Keramidas <keramida@freebsd.org> To: freebsd-doc@FreeBSD.org Subject: Re: docs/37693: Minor correxion to FreeBSD Porter's Handbook Message-ID: <200205110900.g4B909Z26324@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
The following reply was made to PR docs/37693; it has been noted by GNATS. From: Giorgos Keramidas <keramida@freebsd.org> To: Harry Newton <harry_newton@telinco.co.uk> Cc: bug-followup@freebsd.org Subject: Re: docs/37693: Minor correxion to FreeBSD Porter's Handbook Date: Sat, 11 May 2002 11:58:16 +0300 On 2002-05-03 00:02, Harry Newton wrote: > --- book.sgml Thu May 2 23:43:55 2002 > +++ book.sgml_original Thu May 2 23:33:29 2002 > @@ -3878,18 +3878,20 @@ > <title>Automated package list creation</title> > > <para>First, make sure your port is almost complete, with only > - <filename>pkg-plist</filename> missing.</para> > + <filename>pkg-plist</filename> missing. Create an empty > + <filename>pkg-plist</filename>.</para> You could probably expand this a bit, saying why an empty pkg-plist is needed. This change seems fine though. > - <para>Next, create a temporary set of directories into which > - your port can be installed, and install any > - dependencies.</para> > + <screen>&prompt.root; <userinput>touch pkg-plist</userinput></screen> > + > + <para>Next, create a new set of directories which your port can be > + installed, and install any dependencies.</para> The new text is probably wrong too. How about something like: <para>Then, create a new set of directories where your port can be installed, and install any dependencies.</para> > - <screen>&prompt.root; <userinput>(cd /var/tmp/<replaceable>port-name</replaceable> && find -d * -type d) | sort - > OLD-DIRS</userinput></screen> > + <screen>&prompt.root; <userinput>(cd /var/tmp/<replaceable>port-name</replaceable> && find -d * -type d) > OLD-DIRS</userinput></screen> You are removing a `sort -' command here. Why? I think I have seen commits in ports that were done with messages like: Sort plist. I'm not sure this is a good thing to change. > - <screen>&prompt.root; <userinput>(cd /var/tmp/<replaceable>port-name</replaceable> && find -d * -type d) | sort - | comm -13 OLD-DIRS - | sed -e 's#^#@dirrm #' >> pkg-plist</userinput></screen> > + <screen>&prompt.root; <userinput>(cd /var/tmp/<replaceable>port-name && find -d * -type d) | comm -13 OLD-DIRS - | sed -e 's#^#@dirrm #' >> pkg-plist</replaceable></userinput></screen> Not everything is replaceable. The <replaceable> element must surround things that can be thrown away in their entirety and replaced with whatever the user feels like. By marking it all as replaceable you are effectively encouraging the reader to throw away a major part of the command :) - Giorgos 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?200205110900.g4B909Z26324>