svn commit: r44436 - head/en_US.ISO8859-1/books/porters-handbook/makefiles
Warren Block
wblock at FreeBSD.org
Fri Apr 4 01:55:03 UTC 2014
Author: wblock
Date: Fri Apr 4 01:55:02 2014
New Revision: 44436
URL: http://svnweb.freebsd.org/changeset/doc/44436
Log:
Whitespace-only fixes, translators please ignore.
Modified:
head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Fri Apr 4 01:46:32 2014 (r44435)
+++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Fri Apr 4 01:55:02 2014 (r44436)
@@ -351,108 +351,120 @@ PORTEPOCH= 1</programlisting>
<variablelist xml:id="porting-pkgname-format">
<varlistentry xml:id="porting-pkgname-language">
<term><filename><replaceable>language_region-</replaceable></filename></term>
- <listitem>
- <para>&os; strives to support the native language of its
- users. The <replaceable>language-</replaceable> part
- is a two letter abbreviation of the natural
- language defined by ISO-639 when the port is specific to a
- certain language. Examples are <literal>ja</literal> for
- Japanese, <literal>ru</literal> for Russian,
- <literal>vi</literal> for Vietnamese,
- <literal>zh</literal> for Chinese, <literal>ko</literal>
- for Korean and <literal>de</literal> for German.</para>
-
- <para>If the port is specific to a certain region within the
- language area, add the two letter country code as well.
- Examples are <literal>en_US</literal> for US English and
- <literal>fr_CH</literal> for Swiss French.</para>
-
- <para>The <replaceable>language-</replaceable> part is
- set in the <varname>PKGNAMEPREFIX</varname>
- variable.</para>
- </listitem>
+
+ <listitem>
+ <para>&os; strives to support the native language of its
+ users. The <replaceable>language-</replaceable> part is
+ a two letter abbreviation of the natural language
+ defined by ISO-639 when the port is specific to a
+ certain language. Examples are <literal>ja</literal>
+ for Japanese, <literal>ru</literal> for Russian,
+ <literal>vi</literal> for Vietnamese,
+ <literal>zh</literal> for Chinese, <literal>ko</literal>
+ for Korean and <literal>de</literal> for German.</para>
+
+ <para>If the port is specific to a certain region within
+ the language area, add the two letter country code as
+ well. Examples are <literal>en_US</literal> for US
+ English and <literal>fr_CH</literal> for Swiss
+ French.</para>
+
+ <para>The <replaceable>language-</replaceable> part is
+ set in the <varname>PKGNAMEPREFIX</varname>
+ variable.</para>
+ </listitem>
</varlistentry>
<varlistentry xml:id="porting-pkgname-name">
<term><filename><replaceable>name</replaceable></filename></term>
- <listitem>
- <para>The first letter of the <filename>name</filename> part
- should be lowercase. (The rest of the name may contain
- capital letters, so use your own discretion when
- converting a software name that has some capital letters
- in it.) There is a tradition of naming
- <literal>Perl 5</literal> modules by prepending
- <literal>p5-</literal> and converting the double-colon
- separator to a hyphen. For example, the
- <literal>Data::Dumper</literal> module becomes
- <literal>p5-Data-Dumper</literal>.</para>
- <para>Make sure that the port's name and version are clearly
- separated and placed into the <varname>PORTNAME</varname>
- and <varname>PORTVERSION</varname> variables. The only
- reason for <varname>PORTNAME</varname> to contain a
- version part is if the upstream distribution is really
- named that way, as in the
- <filename>textproc/libxml2</filename> or
- <filename>japanese/kinput2-freewnn</filename> ports.
- Otherwise, the <varname>PORTNAME</varname> should not
- contain any version-specific information. It is quite
- normal for several ports to have the same
- <varname>PORTNAME</varname>, as the
- <filename>www/apache*</filename> ports do; in that case,
- different versions (and different index entries) are
- distinguished by the <varname>PKGNAMEPREFIX</varname> and
- <varname>PKGNAMESUFFIX</varname> values.</para>
- </listitem>
+
+ <listitem>
+ <para>The first letter of the <filename>name</filename>
+ part should be lowercase. (The rest of the name may
+ contain capital letters, so use your own discretion when
+ converting a software name that has some capital letters
+ in it.) There is a tradition of naming
+ <literal>Perl 5</literal> modules by prepending
+ <literal>p5-</literal> and converting the double-colon
+ separator to a hyphen. For example, the
+ <literal>Data::Dumper</literal> module becomes
+ <literal>p5-Data-Dumper</literal>.</para>
+
+ <para>Make sure that the port's name and version are
+ clearly separated and placed into the
+ <varname>PORTNAME</varname> and
+ <varname>PORTVERSION</varname> variables. The only
+ reason for <varname>PORTNAME</varname> to contain a
+ version part is if the upstream distribution is really
+ named that way, as in the
+ <filename>textproc/libxml2</filename> or
+ <filename>japanese/kinput2-freewnn</filename> ports.
+ Otherwise, the <varname>PORTNAME</varname> should not
+ contain any version-specific information. It is quite
+ normal for several ports to have the same
+ <varname>PORTNAME</varname>, as the
+ <filename>www/apache*</filename> ports do; in that case,
+ different versions (and different index entries) are
+ distinguished by the <varname>PKGNAMEPREFIX</varname>
+ and <varname>PKGNAMESUFFIX</varname> values.</para>
+ </listitem>
</varlistentry>
<varlistentry xml:id="porting-pkgname-compiled-specifics">
<term><filename><replaceable>-compiled.specifics</replaceable></filename></term>
- <listitem>
- <para>If the port can be built with different
- <link linkend="makefile-masterdir">hardcoded
- defaults</link> (usually part of the directory name in a
- family of ports), the
- <replaceable>-compiled.specifics</replaceable> part should
- state the compiled-in defaults (the hyphen is optional).
- Examples are paper size and font units.</para>
-
- <para>The <replaceable>-compiled.specifics</replaceable>
- part is set in the <varname>PKGNAMESUFFIX</varname>
- variable.</para>
- </listitem>
+
+ <listitem>
+ <para>If the port can be built with different <link
+ linkend="makefile-masterdir">hardcoded defaults</link>
+ (usually part of the directory name in a family of
+ ports), the
+ <replaceable>-compiled.specifics</replaceable> part
+ should state the compiled-in defaults (the hyphen is
+ optional). Examples are paper size and font
+ units.</para>
+
+ <para>The <replaceable>-compiled.specifics</replaceable>
+ part is set in the <varname>PKGNAMESUFFIX</varname>
+ variable.</para>
+ </listitem>
</varlistentry>
<varlistentry xml:id="porting-pkgname-version-numbers">
<term><filename><replaceable>-version.numbers</replaceable></filename></term>
- <listitem>
- <para>The version string follows a dash
- (<literal>-</literal>) and is a period-separated list of
- integers and single lowercase alphabetics. In particular,
- it is not permissible to have another dash inside the
- version string. The only exception is the string
- <literal>pl</literal> (meaning <quote>patchlevel</quote>),
- which can be used <emphasis>only</emphasis> when there are
- no major and minor version numbers in the software. If
- the software version has strings like
- <quote>alpha</quote>, <quote>beta</quote>,
- <quote>rc</quote>, or <quote>pre</quote>, take the first
- letter and put it immediately after a period. If the
- version string continues after those names, the numbers
- should follow the single alphabet without an extra period
- between them.</para>
-
- <para>The idea is to make it easier to sort ports by looking
- at the version string. In particular, make sure version
- number components are always delimited by a period, and if
- the date is part of the string, use the
- <literal>0.0.<replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal> format, not
- <literal><replaceable>dd</replaceable>.<replaceable>mm</replaceable>.<replaceable>yyyy</replaceable></literal> or the non-Y2K compliant
- <literal><replaceable>yy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal> format. It is important to
- prefix the version with <literal>0.0.</literal> in case a
- release with an actual version number is made, which would
- of course be numerically less than
- <literal><replaceable>yyyy</replaceable></literal>.</para>
- </listitem>
+
+ <listitem>
+ <para>The version string follows a dash
+ (<literal>-</literal>) and is a period-separated list of
+ integers and single lowercase alphabetics. In
+ particular, it is not permissible to have another dash
+ inside the version string. The only exception is the
+ string <literal>pl</literal> (meaning
+ <quote>patchlevel</quote>), which can be used
+ <emphasis>only</emphasis> when there are no major and
+ minor version numbers in the software. If the software
+ version has strings like <quote>alpha</quote>,
+ <quote>beta</quote>, <quote>rc</quote>, or
+ <quote>pre</quote>, take the first letter and put it
+ immediately after a period. If the version string
+ continues after those names, the numbers should follow
+ the single alphabet without an extra period between
+ them.</para>
+
+ <para>The idea is to make it easier to sort ports by
+ looking at the version string. In particular, make sure
+ version number components are always delimited by a
+ period, and if the date is part of the string, use the
+ <literal>0.0.<replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal>
+ format, not
+ <literal><replaceable>dd</replaceable>.<replaceable>mm</replaceable>.<replaceable>yyyy</replaceable></literal>
+ or the non-Y2K compliant
+ <literal><replaceable>yy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal>
+ format. It is important to prefix the version with
+ <literal>0.0.</literal> in case a release with an actual
+ version number is made, which would of course be
+ numerically less than
+ <literal><replaceable>yyyy</replaceable></literal>.</para>
+ </listitem>
</varlistentry>
</variablelist>
@@ -604,7 +616,8 @@ PORTEPOCH= 1</programlisting>
string to <literal>1.0</literal> (like the
<literal>piewm</literal> example above). Otherwise, ask the
original author or use the date string
- (<literal>0.0.<replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal>) as the version.</para>
+ (<literal>0.0.<replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal>)
+ as the version.</para>
</sect2>
</sect1>
@@ -1992,8 +2005,9 @@ DISTFILES= source1.tar.gz:source1 \
<orderedlist>
<listitem>
- <para>Elements can be postfixed with <literal>:<replaceable>n</replaceable></literal>
- where <replaceable>n</replaceable> is
+ <para>Elements can be postfixed with
+ <literal>:<replaceable>n</replaceable></literal> where
+ <replaceable>n</replaceable> is
<literal>[^:,]+</literal>, i.e.,
<replaceable>n</replaceable> could conceptually be any
alphanumeric string but we will limit it to
@@ -2099,8 +2113,9 @@ DISTFILES= source1.tar.gz:source1 \
be terminated with the forward slash
<literal>/</literal> character. If any elements
belong to any groups, the group postfix
- <literal>:<replaceable>n</replaceable></literal> must come right after the
- terminator <literal>/</literal>. The
+ <literal>:<replaceable>n</replaceable></literal>
+ must come right after the terminator
+ <literal>/</literal>. The
<literal>MASTER_SITES:n</literal> mechanism relies
on the existence of the terminator
<literal>/</literal> to avoid confusing elements
@@ -2392,9 +2407,9 @@ PATCHFILES= patch1:test</programlisting>
<para>All current ports remain the same. The
<literal>MASTER_SITES:n</literal> feature code is only
activated if there are elements postfixed with
- <literal>:<replaceable>n</replaceable></literal> like elements according to the
- aforementioned syntax rules, especially as shown in
- item <xref
+ <literal>:<replaceable>n</replaceable></literal> like
+ elements according to the aforementioned syntax rules,
+ especially as shown in item <xref
linkend="porting-master-sites-n-group-semantics"/>.</para>
</listitem>
@@ -4257,16 +4272,16 @@ PORTVERSION= 1.0</programlisting>
files in the port's <buildtarget>*-install</buildtarget>
targets. Set ownership directly in
<filename>pkg-plist</filename> with the corresponding entries,
- such as <literal>@owner <replaceable>owner</replaceable></literal> and
- <literal>@group <replaceable>group</replaceable></literal>. These operators work until
- being overridden, or until the end of
- <filename>pkg-plist</filename>, so do not forget to reset them
- after they are no longer needed. The default ownership is
- <literal>root:wheel</literal>.</para>
+ such as
+ <literal>@owner <replaceable>owner</replaceable></literal> and
+ <literal>@group <replaceable>group</replaceable></literal>.
+ These operators work until being overridden, or until the end
+ of <filename>pkg-plist</filename>, so do not forget to reset
+ them after they are no longer needed. The default ownership
+ is <literal>root:wheel</literal>.</para>
<itemizedlist>
<listitem>
-
<para><varname>INSTALL_PROGRAM</varname> is a command to
install binary executables.</para>
</listitem>
More information about the svn-doc-head
mailing list