From 22ed8ca125892039b5efe263b8eb246b493049f1 Mon Sep 17 00:00:00 2001 From: Warren Block Date: Tue, 24 Jun 2014 14:18:20 +0000 Subject: [PATCH] Clarify language in quick-porting chapter. Remove "you" and "your" where possible. --- .../quick-porting/chapter.xml | 56 +++++++++---------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml b/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml index edab2e370b..6706cf3dab 100644 --- a/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml +++ b/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml @@ -10,20 +10,20 @@ Quick Porting - This section tells you how to quickly create a new port. In - many cases, it is not sufficient, so you will have to read - further on into the document. + This section describes how to quickly create a new port. For + applications where this quick method is not adequate, the full + Slow Porting process is described in + . First, get the original tarball and put it into DISTDIR, which defaults to /usr/ports/distfiles. - The following assumes that the software compiled - out-of-the-box, i.e., there was absolutely no change required - for the port to work on your &os; box. If you needed to - change something, you will have to refer to the next section - too. + The following steps assume that the software compiled + out-of-the-box. In other words, absolutely no changes were required + for the application to work on a &os; system. If anything had to be + changed, refer to . @@ -64,12 +64,12 @@ COMMENT= Cat chasing a mouse all over the screen is being phased out. - See if you can figure it out. Do not worry about the + Try to figure it out. Do not worry about the contents of the $FreeBSD$ line, it will be filled in automatically by Subversion when the port is - imported to our main ports tree. You can find a more detailed - example in the + imported to our main ports tree. A more detailed + example is shown in the sample Makefile section. @@ -94,7 +94,7 @@ COMMENT= Cat chasing a mouse all over the screen This is not a manual or an in-depth description on how to use or compile the port! - Please be careful if you are copying from the + Please be careful when copying from the README or manpage; too often they are not a concise description of the port or are in an awkward format (e.g., manpages have justified @@ -124,7 +124,7 @@ COMMENT= Cat chasing a mouse all over the screen moved, was renamed, or is hosted elsewhere. - The following example shows how your + The following example shows how the pkg-descr should look: This is a port of oneko, in which a cat chases a poor mouse all over @@ -161,9 +161,9 @@ lib/X11/oneko/mouse.xpm on the packing list. - It is recommended that you keep all the filenames in + It is recommended to keep all the filenames in this file sorted alphabetically. It will make verifying - the changes when you upgrade the port much easier. + changes when upgrading the port much easier. @@ -207,13 +207,13 @@ PLIST_DIRS= lib/X11/oneko . - The price for this way of listing port's files and - directories is that you cannot use command sequences - described in &man.pkg-create.8;. Therefore, it is suitable + The price for this way of listing a port's files and + directories is that then command sequences + described in &man.pkg-create.8; cannot be used. Therefore, it is suitable only for simple ports and makes them even simpler. At the same time, it has the advantage of reducing the number of files in the ports collection. Please consider using this - technique before you resort to + technique before resorting to pkg-plist. Later we will see how pkg-plist @@ -234,9 +234,9 @@ PLIST_DIRS= lib/X11/oneko Testing the Port - You should make sure that the port rules do exactly what - you want them to do, including packaging up the port. These - are the important points you need to verify. + Make sure that the port rules do exactly what + is desired, including packaging up the port. These + are the important points to verify: @@ -315,14 +315,14 @@ PLIST_DIRS= lib/X11/oneko - Checking Your Port with + <title>Checking the Port with <command>portlint</command> - Please use portlint to see if your port + Please use portlint to see if the port conforms to our guidelines. The ports-mgmt/portlint - program is part of the ports collection. In particular, you - may want to check if the + program is part of the ports collection. In particular, + check that the Makefile is in the right shape and the package is named @@ -336,7 +336,7 @@ PLIST_DIRS= lib/X11/oneko DOs and DON'Ts section. - Once happy with your port, the only thing remaining is to + Once happy with the port, the only thing remaining is to put it in the main &os; ports tree and make everybody else happy about it too. We do not need the work directory or the @@ -375,7 +375,7 @@ PLIST_DIRS= lib/X11/oneko One more time, do not include the original source distfile, the work directory, or - the package you built with + the package built with make package; and, do use &man.shar.1; for new ports, not &man.diff.1;.