Index: en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml =================================================================== --- en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml +++ en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml @@ -24,17 +24,17 @@ %%PERL_VER%%, and %%PERL_VERSION%% will be substituted for appropriately. The value of %%OSREL%% is the - numeric revision of the operating system (e.g., + numeric revision of the operating system (for example, 4.9). %%PERL_VERSION%% and %%PERL_VER%% is the full version number - of perl (e.g., 5.8.9). + of perl (for example, 5.8.9). Several other %%VARS%% related to port's documentation files are described in the relevant section. - If you need to make other substitutions, you can set the + To make other substitutions, set the PLIST_SUB variable with a list of VAR=VALUE pairs and instances of @@ -42,8 +42,8 @@ substituted with VALUE in the pkg-plist. - For instance, if you have a port that installs many files - in a version-specific subdirectory, you can put something + For instance, if a port that installs many files + in a version-specific subdirectory, put something like OCTAVE_VERSION= 2.0.13 @@ -51,12 +51,12 @@ in the Makefile and use %%OCTAVE_VERSION%% wherever the version shows - up in pkg-plist. That way, when you - upgrade the port, you will not have to change dozens (or in some + up in pkg-plist. That way, when + upgrading the port, change dozens (or in some cases, hundreds) of lines in the - pkg-plist. + pkg-plist will not be needed. - If your port installs files conditionally on the options + If the port installs files conditionally on the options set in the port, the usual way of handling it is prefixing the pkg-plist lines with a %%OPT%% for lines needed when the option is @@ -72,7 +72,7 @@ OPTIONS_DEFINE= X11 OPTIONS_SUB= yes - In the pkg-plist file, put + In pkg-plist, put %%X11%% in front of the lines only being installed when the option is enabled, like this : @@ -83,9 +83,9 @@ do-install targets, by reading from PLIST and writing to TMPPLIST (default: - WRKDIR/.PLIST.mktmp). So if your port + WRKDIR/.PLIST.mktmp). So if the port builds PLIST on the fly, do so in or before - pre-install. Also, if your port + pre-install. Also, if the port needs to edit the resulting file, do so in post-install to a file named TMPPLIST. @@ -108,7 +108,7 @@ PLIST_DIRSTRY, respectively. To take effect, PLIST_FILES, PLIST_DIRS, and PLIST_DIRSTRY must be set before - TMPPLIST is written, i.e., in + TMPPLIST is written, that is, in pre-install or earlier. From time to time, the OPTIONS_SUB @@ -139,8 +139,8 @@ When being de-installed, A port has to remove empty directories it created. This is usually accomplished by adding @dirrm lines for all directories - that are specifically created by the port. You need to delete - subdirectories before you can delete parent + that are specifically created by the port. Subdirectories need to be deleted + before deleting parent directories. : @@ -152,8 +152,8 @@ @dirrm lib/X11/oneko However, sometimes @dirrm will give - you errors because other ports share the same directory. You - can use @dirrmtry to remove only empty + errors because other ports share the same directory. + Use @dirrmtry to remove only empty directories without warning. @dirrmtry share/doc/gimp @@ -184,9 +184,9 @@ Configuration Files - If your port installs configuration files to + If the port installs configuration files to PREFIX/etc (or elsewhere) do - not simply list them in the + not list them in the pkg-plist. That will cause pkg delete to remove the files carefully edited by the user, and a re-installation will wipe them @@ -194,7 +194,7 @@ Instead, install sample file(s) as filename.sample, - and for each sample file, add this line to your + and for each sample file, add this line to pkg-plist. @sample etc/orbit.conf.sample @@ -209,19 +209,19 @@ When a port installs its configuration in a subdirectory - of ${PREFIX}/etc, it should be in + of ${PREFIX}/etc, use ETCDIR, which defaults to ${PREFIX}/etc/${PORTNAME}, it can be overridden in the ports Makefile if there is a convention for the port to use some other directory. The - %%ETCDIR%% macro should be used in its - stead in the pkg-plist file. + %%ETCDIR%% macro will be used in its + stead in pkg-plist. The sample configuration files should always have the .sample suffix. If for some historical - reason you cannot use the standard suffix, you can still use + reason using the standard suffix is not possible, use this construct: @unexec if cmp -s %D/etc/orbit.conf-dist %D/etc/orbit.conf; then rm -f %D/etc/orbit.conf; fi @@ -253,15 +253,15 @@ Dynamic Versus Static Package List A static package list is a package - list which is available in the Ports Collection either as a - pkg-plist file (with or without variable + list which is available in the Ports Collection either as + pkg-plist (with or without variable substitution), or embedded into the Makefile via PLIST_FILES, PLIST_DIRS, and PLIST_DIRSTRY. Even if the contents are auto-generated by a tool or a target in the Makefile before the inclusion into the Ports - Collection by a committer (e.g., using make + Collection by a committer (for example, using make makeplist>), this is still considered a static list, since it is possible to examine it without having to download or compile the distfile. @@ -281,7 +281,7 @@ the package list changes drastically based upon optional features of the port (and thus maintaining a static package list is infeasible), or ports which change the package list based - upon the version of dependent software used (e.g., ports which + upon the version of dependent software used (for example, ports which generate docs with Javadoc). @@ -290,7 +290,7 @@ First, make sure the port is almost complete, with only pkg-plist missing. Running make - makeplist will show what should be put in + makeplist will show an example for pkg-plist. The output of makeplist must be double checked for correctness as it tries to automatically guess a few things, and @@ -298,12 +298,12 @@ User configuration files should be installed as filename.sample, - as it is described in . The - info/dir file should not be listed and - appropriate install-info lines should be + as it is described in . + info/dir must not be listed and + appropriate install-info lines must be added as noted in the info files section. Any libraries installed by the port - should be listed as specified in the shared libraries section. @@ -412,9 +412,9 @@ command Execute command as part of - the unpacking process. If command contains any of the - following sequences somewhere in it, they are expanded - inline. For the following examples, assume that + the unpacking process. If command contains any of these + sequences somewhere in it, they are expanded + inline. For these examples, assume that @cwd is set to /usr/local and the last extracted file was bin/emacs. @@ -527,7 +527,7 @@ By default, directories created by a package installation are not deleted when the package is deinstalled. This provides an explicit directory cleanup method. These - directives should appear at the end of the package list. If + directives must appear at the end of the package list. If the directory is not empty a warning is printed, and the directory is not removed. @@ -542,8 +542,8 @@ - - Creating Your Own Keyword + + Creating New Keywords Package list files can be extended by keywords that are defined in the YAML file named keyword.yaml. - The file must contain at least one of the following + The file must contain at least one of the next sections: