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 3e08ed34fb..992d4bce96 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 @@ -20,7 +20,7 @@ /usr/ports/distfiles. - The following steps assume that the software compiled + These 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 This is not a manual or an in-depth description on how to use or compile the port! Please be careful when copying from the - README or manpage; too + 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 - spacing, which looks particularly bad with monospaced - fonts). + are in an awkward format. For example, manpages have + justified spacing, which looks particularly bad with + monospaced fonts. A well-written pkg-descr describes @@ -116,7 +116,7 @@ COMMENT= Cat chasing a mouse all over the screen one of the websites (pick the most common one) with WWW: (followed by single space) so that automated tools will work correctly. If the - URI is the root of the website or directory, it should be + URI is the root of the website or directory, it must be terminated with a slash. @@ -125,8 +125,8 @@ COMMENT= Cat chasing a mouse all over the screen moved, was renamed, or is hosted elsewhere. - The following example shows how the - pkg-descr should look: + This example shows how + pkg-descr looks: This is a port of oneko, in which a cat chases a poor mouse all over the screen. @@ -182,8 +182,8 @@ lib/X11/oneko/mouse.xpm PLIST_DIRS, respectively, within the port's Makefile. For instance, we could get along without pkg-plist in - the above oneko port by adding the - following lines to the Makefile: + the above oneko port by adding these + lines to the Makefile: PLIST_FILES= bin/oneko \ man/man1/oneko.1.gz \ @@ -193,12 +193,12 @@ lib/X11/oneko/mouse.xpm lib/X11/oneko/mouse.xpm PLIST_DIRS= lib/X11/oneko - Of course, PLIST_DIRS should be left - unset if a port installs no directories of its own. + Of course, PLIST_DIRS does not need to + be set if a port installs no directories of its own. Several ports can share a common directory. In that - case, PLIST_DIRS should be replaced by + case, PLIST_DIRS must be replaced by PLIST_DIRSTRY so that the directory is removed only if empty, otherwise it is silently ignored. PLIST_DIRS and @@ -351,26 +351,30 @@ PLIST_DIRS= lib/X11/oneko is located, and then type: shar `find oneko` > oneko.shar + - Classify the bug report as Category - ports and Class - change-request. Do not - mark the report confidential! Add a short + To submit oneko.shar, use the bug submit + form (category Ports Tree). + Add a short description of the program to the Description field of the PR - (perhaps a short version of the COMMENT), and - add the .shar file to the Fix field. + (perhaps a short version of COMMENT), and + don't forget to add oneko.shar as an + attachment. - Giving a good description in the synopsis of the problem + Giving a good description in the summary of the problem report makes the work of port committers a lot easier. We prefer something like New port: - <category>/<portname> <short description of - the port> for new ports. Using this + category/portname short description of + the port for new ports. Using this scheme makes it easier and faster to begin the work of committing the new port. @@ -388,7 +392,7 @@ PLIST_DIRS= lib/X11/oneko xlink:href="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?category=ports">. After looking at the new port, we will reply if necessary, - and put it in the tree. Your name will also be added to the + and commit it to the tree. The submitter's name will also be added to the list of Additional &os; Contributors and other files.