aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/books/fdp-primer/doc-build
diff options
context:
space:
mode:
authorWarren Block <wblock@FreeBSD.org>2013-07-20 01:28:57 +0000
committerWarren Block <wblock@FreeBSD.org>2013-07-20 01:28:57 +0000
commit46eb499afa03d2e4c21d77a80fc018a8c7c62398 (patch)
tree9e0a5c045c44201a503d40b7daf28447e1767200 /en_US.ISO8859-1/books/fdp-primer/doc-build
parent93bfc7e929245e741dd369bcae2374cc322bf9da (diff)
downloaddoc-46eb499afa03d2e4c21d77a80fc018a8c7c62398.tar.gz
doc-46eb499afa03d2e4c21d77a80fc018a8c7c62398.zip
Whitespace-only fixes. Translators, please ignore.
Notes
Notes: svn path=/head/; revision=42329
Diffstat (limited to 'en_US.ISO8859-1/books/fdp-primer/doc-build')
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml82
1 files changed, 38 insertions, 44 deletions
diff --git a/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml
index e83d4afa21..95ab3e73a0 100644
--- a/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml
@@ -34,20 +34,18 @@
<chapter id="doc-build">
<title>The Documentation Build Process</title>
- <para>This chapter covers organization of the
- documentation build process
- and how &man.make.1; is used to control
- it.</para>
+ <para>This chapter covers organization of the documentation build
+ process and how &man.make.1; is used to control it.</para>
<sect1 id="doc-build-toolset">
<title>The &os; Documentation Build Toolset</title>
- <para>These are the tools used to build and install the <acronym>FDP</acronym> documentation.</para>
+ <para>These are the tools used to build and install the
+ <acronym>FDP</acronym> documentation.</para>
<itemizedlist>
<listitem>
- <para>The primary build tool is
- &man.make.1;, specifically
+ <para>The primary build tool is &man.make.1;, specifically
<application>Berkeley Make</application>.</para>
</listitem>
@@ -57,16 +55,14 @@
</listitem>
<listitem>
- <para>&man.gzip.1; is used to create
- compressed versions of the document.
- &man.bzip2.1; archives are also supported.
- &man.tar.1; is used for package
- building.</para>
+ <para>&man.gzip.1; is used to create compressed versions of
+ the document. &man.bzip2.1; archives are also supported.
+ &man.tar.1; is used for package building.</para>
</listitem>
<listitem>
- <para>&man.install.1; is used
- to install the documentation.</para>
+ <para>&man.install.1; is used to install the
+ documentation.</para>
</listitem>
</itemizedlist>
</sect1>
@@ -116,10 +112,10 @@ COMPAT_SYMLINK = en
DOC_PREFIX?= ${.CURDIR}/..
.include "${DOC_PREFIX}/share/mk/doc.project.mk"</programlisting>
- <para>The first four non-empty lines define
- the &man.make.1; variables
- <makevar>SUBDIR</makevar>, <makevar>COMPAT_SYMLINK</makevar>,
- and <makevar>DOC_PREFIX</makevar>.</para>
+ <para>The first four non-empty lines define the &man.make.1;
+ variables <makevar>SUBDIR</makevar>,
+ <makevar>COMPAT_SYMLINK</makevar>, and
+ <makevar>DOC_PREFIX</makevar>.</para>
<para>The <makevar>SUBDIR</makevar> statement and
<makevar>COMPAT_SYMLINK</makevar> statement show how to
@@ -148,24 +144,24 @@ DOC_PREFIX?= ${.CURDIR}/..
point to <filename>en_US.ISO-8859-1</filename>).</para>
<para><makevar>DOC_PREFIX</makevar> is the path to the root of
- the &os; Document Project tree. This is not always that
- easy to find, and is also easily overridden, to allow for
- flexibility. <makevar>.CURDIR</makevar> is a
- &man.make.1; builtin variable with the path
- to the current directory.</para>
-
- <para>The final line includes the &os; Documentation
- Project's project-wide &man.make.1; system
- file <filename>doc.project.mk</filename> which is the glue
- which converts these variables into build instructions.</para>
+ the &os; Document Project tree. This is not always that easy
+ to find, and is also easily overridden, to allow for
+ flexibility. <makevar>.CURDIR</makevar> is a &man.make.1;
+ builtin variable with the path to the current
+ directory.</para>
+
+ <para>The final line includes the &os; Documentation Project's
+ project-wide &man.make.1; system file
+ <filename>doc.project.mk</filename> which is the glue which
+ converts these variables into build instructions.</para>
</sect2>
<sect2 id="doc-make">
<title>Documentation <filename>Makefile</filename>s</title>
- <para>These <filename>Makefile</filename>s set
- &man.make.1; variables that describe how to
- build the documentation contained in that directory.</para>
+ <para>These <filename>Makefile</filename>s set &man.make.1;
+ variables that describe how to build the documentation
+ contained in that directory.</para>
<para>Here is an example:</para>
@@ -185,10 +181,9 @@ DOC_PREFIX?= ${.CURDIR}/../../..
.include "$(DOC_PREFIX)/share/mk/docproj.docbook.mk"</programlisting>
- <para>The <makevar>MAINTAINER</makevar> variable
- allows committers to claim
- ownership of a document in the &os; Documentation
- Project, and take responsibility for maintaining
+ <para>The <makevar>MAINTAINER</makevar> variable allows
+ committers to claim ownership of a document in the &os;
+ Documentation Project, and take responsibility for maintaining
it.</para>
<para><makevar>DOC</makevar> is the name (sans the
@@ -215,8 +210,8 @@ DOC_PREFIX?= ${.CURDIR}/../../..
<title>&os; Documentation Project
<application>Make</application> Includes</title>
- <para>&man.make.1; includes are best explained by inspection of the code. Here are
- the system include files:</para>
+ <para>&man.make.1; includes are best explained by inspection of
+ the code. Here are the system include files:</para>
<itemizedlist>
<listitem>
@@ -293,11 +288,10 @@ PRI_LANG?= en_US.ISO8859-1
<title>Conditionals</title>
<para>The <literal>.if defined(DOC)</literal> line is an
- example of a &man.make.1; conditional
- which, like in other programs, defines behavior if some
- condition is true or if it is false.
- <literal>defined</literal> is a function which returns
- whether the variable given is defined or not.</para>
+ example of a &man.make.1; conditional which, like in other
+ programs, defines behavior if some condition is true or if
+ it is false. <literal>defined</literal> is a function which
+ returns whether the variable given is defined or not.</para>
<para><literal>.if ${DOCFORMAT} == "docbook"</literal>, next,
tests whether the <makevar>DOCFORMAT</makevar> variable is
@@ -312,8 +306,8 @@ PRI_LANG?= en_US.ISO8859-1
<sect2>
<title><filename>doc.subdir.mk</filename></title>
- <para>This file is too long to explain in detail. These
- notes describe the most important features.</para>
+ <para>This file is too long to explain in detail. These notes
+ describe the most important features.</para>
<sect3>
<title>Variables</title>