From owner-svn-doc-head@freebsd.org Thu Oct 1 14:34:32 2015 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id DF59CA0C28E; Thu, 1 Oct 2015 14:34:32 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id CF0201618; Thu, 1 Oct 2015 14:34:32 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.70]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id t91EYW1B026778; Thu, 1 Oct 2015 14:34:32 GMT (envelope-from mat@FreeBSD.org) Received: (from mat@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id t91EYWNR026777; Thu, 1 Oct 2015 14:34:32 GMT (envelope-from mat@FreeBSD.org) Message-Id: <201510011434.t91EYWNR026777@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: mat set sender to mat@FreeBSD.org using -f From: Mathieu Arnold Date: Thu, 1 Oct 2015 14:34:32 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r47468 - head/en_US.ISO8859-1/books/porters-handbook/plist X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.20 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 01 Oct 2015 14:34:33 -0000 Author: mat Date: Thu Oct 1 14:34:32 2015 New Revision: 47468 URL: https://svnweb.freebsd.org/changeset/doc/47468 Log: Whitespace fixes, translators can ignore. Sponsored by: Absolight Modified: head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml Thu Oct 1 14:34:26 2015 (r47467) +++ head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml Thu Oct 1 14:34:32 2015 (r47468) @@ -27,8 +27,8 @@ numeric revision of the operating system (for example, 4.9). %%PERL_VERSION%% and %%PERL_VER%% is the full version number - of perl (for example, 5.8.9). - Several other + of perl (for example, + 5.8.9). Several other %%VARS%% related to port's documentation files are described in the relevant @@ -54,8 +54,8 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSI in the Makefile and use %%OCTAVE_VERSION%% wherever the version shows up in pkg-plist. When - the port is upgraded, it will not be necessary to edit dozens (or in some - cases, hundreds) of lines in + the port is upgraded, it will not be necessary to edit dozens + (or in some cases, hundreds) of lines in pkg-plist. If files are installed conditionally on the options @@ -113,7 +113,8 @@ OPTIONS_SUB= yes From time to time, using OPTIONS_SUB is not enough. In those cases, adding a specific - TAG to PLIST_SUB + TAG to + PLIST_SUB inside the Makefile with a special value of @comment, makes package tools to ignore the line. For instance, if some files are only installed @@ -175,13 +176,13 @@ PLIST_SUB+= X11I386="@comment " PREFIX/etc (or elsewhere) do not list them in pkg-plist. That will cause - pkg delete to remove files that have been carefully - edited by the user, and a re-installation will wipe them - out. + pkg delete to remove files that have been + carefully edited by the user, and a re-installation will wipe + them out. Instead, install sample files with a filename.sample - extension. The @sample macro automates this, + extension. The @sample macro automates this, see for what it does exactly. For each sample file, add a line to pkg-plist: @@ -259,8 +260,9 @@ PLIST_SUB+= X11I386="@comment " 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. For example, ports which - generate docs with Javadoc. + upon the version of dependent software used. For example, ports + which generate docs with + Javadoc. @@ -635,8 +637,8 @@ PLIST_SUB+= X11I386="@comment " command (Deprecated) Execute command as part of - the installation or deinstallation process. Please use instead. + the installation or deinstallation process. Please use + instead. @@ -703,194 +705,189 @@ PLIST_SUB+= X11I386="@comment " - - <literal>attributes</literal> + + <literal>attributes</literal> - Changes the owner, group, or mode used by the - keyword. Contains an associative array where the - possible keys are owner, - group, and mode. - The values are, respectively, a user name, a group name, - and a file mode. For example: - - attributes: { owner: "games", group: "games", mode: 0555 } - - - - <literal>action</literal> - - Defines what happens to the keyword's parameter. - Contains an array where the possible values are: - - - - setprefix - - - Set the prefix for the next plist - entries. - - - - - dir - - - Register a directory to be created on - install and removed on deinstall. - - - - - dirrm - - - Register a directory to be deleted on - deinstall. Deprecated. - - - - - dirrmtry - - - Register a directory to try and deleted on - deinstall. Deprecated. - - - - - file - - - Register a file. - - - - - setmode - - - Set the mode for the next plist - entries. - - - - - setowner - - - Set the owner for the next plist - entries. - - - - - setgroup - - - Set the group for the next plist - entries. - - - - - comment - - - Does not do anything, equivalent to not - entering an action - section. - - - - - ignore_next - - - Ignore the next entry in the plist. - - - - - - - <literal>arguments</literal> - - If set to true, adds argument - handling, splitting the whole line, %@, - into numbered arguments, %1, - %2, and so on. For example, for this - line: + Changes the owner, group, or mode used by the keyword. + Contains an associative array where the possible keys are + owner, group, and + mode. The values are, respectively, a + user name, a group name, and a file mode. For + example: - @foo some.content other.content + attributes: { owner: "games", group: "games", mode: 0555 } + + + + <literal>action</literal> + + Defines what happens to the keyword's parameter. + Contains an array where the possible values are: + + + + setprefix + + + Set the prefix for the next plist entries. + + + + + dir + + + Register a directory to be created on install and + removed on deinstall. + + + + + dirrm + + + Register a directory to be deleted on deinstall. + Deprecated. + + + + + dirrmtry + + + Register a directory to try and deleted on + deinstall. Deprecated. + + + + + file + + + Register a file. + + + + + setmode + + + Set the mode for the next plist entries. + + + + + setowner + + + Set the owner for the next plist entries. + + - %1 and %2 - will contain: + + setgroup + + + Set the group for the next plist entries. + + + + + comment - some.content + + Does not do anything, equivalent to not entering + an action section. + + + + + ignore_next + + + Ignore the next entry in the plist. + + + + + + + <literal>arguments</literal> + + If set to true, adds argument + handling, splitting the whole line, %@, + into numbered arguments, %1, + %2, and so on. For example, for this + line: + + @foo some.content other.content + + %1 and %2 will + contain: + + some.content other.content - It also affects how the action - entry works. When there is more than one argument, the - argument number must be specified. For example: - - actions: [file(1)] - - - - <literal>pre-install</literal>, - <literal>post-install</literal>, - <literal>pre-deinstall</literal>, - <literal>post-deinstall</literal>, - <literal>pre-upgrade</literal>, - <literal>post-upgrade</literal> - - These keywords contains a &man.sh.1; script to be - executed before or after installation, deinstallation, - or upgrade of the package. In addition to the usual - @exec - %foo - placeholders described in , there is a new - one, %@, which represents the - argument of the keyword. - + It also affects how the action + entry works. When there is more than one argument, the + argument number must be specified. For example: + + actions: [file(1)] + + + + <literal>pre-install</literal>, + <literal>post-install</literal>, + <literal>pre-deinstall</literal>, + <literal>post-deinstall</literal>, + <literal>pre-upgrade</literal>, + <literal>post-upgrade</literal> + + These keywords contains a &man.sh.1; script to be + executed before or after installation, deinstallation, or + upgrade of the package. In addition to the usual + @exec + %foo + placeholders described in , there is a new one, + %@, which represents the argument of the + keyword. + Custom Keyword Examples - - Example of a <literal>@dirrmtryecho</literal> - Keyword - - This keyword does two things, it adds a - @dirrmtry - directory line to the - packing list, and echoes the fact that the directory is - removed when deinstalling the package. + + Example of a <literal>@dirrmtryecho</literal> + Keyword + + This keyword does two things, it adds a + @dirrmtry + directory line to + the packing list, and echoes the fact that the directory + is removed when deinstalling the package. - actions: [dirrmtry] + actions: [dirrmtry] post-deinstall: <<EOD echo "Directory %D/%@ removed." EOD - + - - Real Life Example, How <literal>@sample</literal> - is Implemented - - This keyword does three things. It adds the first - filename passed as an argument to - @sample to the packing list, it adds to - the post-install script instructions to - copy the sample to the actual configuration file if it does - not already exist, and it adds to the - post-deinstall instructions to remove the - configuration file if it has not been modified. + + Real Life Example, How <literal>@sample</literal> is + Implemented + + This keyword does three things. It adds the first + filename passed as an argument + to @sample to the packing list, it adds + to the post-install script instructions + to copy the sample to the actual configuration file if it + does not already exist, and it adds to the + post-deinstall instructions to remove + the configuration file if it has not been modified. - actions: [file(1)] + actions: [file(1)] arguments: true post-install: <<EOD case "%1" in @@ -932,7 +929,7 @@ pre-deinstall: <<EOD echo "You may need to manually remove ${target_file} if it is no longer needed." fi EOD - +