The translation is temporarily closed for contributions due to maintenance, please come back later.

Source string Read only

(itstool) path: sect2/para
Context English State
<link linkend="sub-make">Subdirectory <filename>Makefile</filename>s</link> simply pass commands to those directories below them.
<link linkend="doc-make">Documentation <filename>Makefile</filename>s</link> describe the documents that are produced from this directory.
<link linkend="make-includes"><application>Make</application> includes</link> are the glue that perform the document production, and are usually of the form <filename>doc.<replaceable>xxx</replaceable>.mk</filename>.
Subdirectory <filename>Makefile</filename>s
These <filename>Makefile</filename>s usually take the form of:
SUBDIR =articles


.include "${DOC_PREFIX}/share/mk/"
The first four non-empty lines define the <citerefentry><refentrytitle>make</refentrytitle><manvolnum>1</manvolnum></citerefentry> variables <varname>SUBDIR</varname>, <varname>COMPAT_SYMLINK</varname>, and <varname>DOC_PREFIX</varname>.
The <varname>SUBDIR</varname> statement and <varname>COMPAT_SYMLINK</varname> statement show how to assign a value to a variable, overriding any previous value.
The second <varname>SUBDIR</varname> statement shows how a value is appended to the current value of a variable. The <varname>SUBDIR</varname> variable is now <literal>articles books</literal>.
The <varname>DOC_PREFIX</varname> assignment shows how a value is assigned to the variable, but only if it is not already defined. This is useful if <varname>DOC_PREFIX</varname> is not where this <filename>Makefile</filename> thinks it is - the user can override this and provide the correct value.
What does it all mean? <varname>SUBDIR</varname> mentions which subdirectories below this one the build process should pass any work on to.
<varname>COMPAT_SYMLINK</varname> is specific to compatibility symlinks (amazingly enough) for languages to their official encoding (<filename>doc/en</filename> would point to <filename>en_US.ISO-8859-1</filename>).
<varname>DOC_PREFIX</varname> is the path to the root of the FreeBSD Document Project tree. This is not always that easy to find, and is also easily overridden, to allow for flexibility. <varname>.CURDIR</varname> is a <citerefentry><refentrytitle>make</refentrytitle><manvolnum>1</manvolnum></citerefentry> builtin variable with the path to the current directory.
The final line includes the FreeBSD Documentation Project's project-wide <citerefentry><refentrytitle>make</refentrytitle><manvolnum>1</manvolnum></citerefentry> system file <filename></filename> which is the glue which converts these variables into build instructions.
Documentation <filename>Makefile</filename>s
These <filename>Makefile</filename>s set <citerefentry><refentrytitle>make</refentrytitle><manvolnum>1</manvolnum></citerefentry> variables that describe how to build the documentation contained in that directory.
Here is an example:

DOC?= book

FORMATS?= html-split html


# SGML content
SRCS= book.xml

DOC_PREFIX?= ${.CURDIR}/../../..

.include "$(DOC_PREFIX)/share/mk/"
The <varname>MAINTAINER</varname> variable allows committers to claim ownership of a document in the FreeBSD Documentation Project, and take responsibility for maintaining it.
<varname>DOC</varname> is the name (sans the <filename>.xml</filename> extension) of the main document created by this directory. <varname>SRCS</varname> lists all the individual files that make up the document. This should also include important files in which a change should result in a rebuild.
<varname>FORMATS</varname> indicates the default formats that should be built for this document. <varname>INSTALL_COMPRESSED</varname> is the default list of compression techniques that should be used in the document build. <varname>INSTALL_ONLY_COMPRESS</varname>, empty by default, should be non-empty if only compressed documents are desired in the build.
The <varname>DOC_PREFIX</varname> and include statements should be familiar already.
FreeBSD Documentation Project <application>Make</application> Includes
<citerefentry><refentrytitle>make</refentrytitle><manvolnum>1</manvolnum></citerefentry> includes are best explained by inspection of the code. Here are the system include files:
<filename></filename> is the main project include file, which includes all the following include files, as necessary.
<filename></filename> handles traversing of the document tree during the build and install processes.
<filename></filename> provides variables that affect ownership and installation of documents.
<filename></filename> is included if <varname>DOCFORMAT</varname> is <literal>docbook</literal> and <varname>DOC</varname> is set.
By inspection:
DOCFORMAT?= docbook

PREFIX?= /usr/local
PRI_LANG?= en_US.ISO8859-1

.if defined(DOC)
.if ${DOCFORMAT} == "docbook"
.include ""

.include ""
.include ""


No matching activity found.

Browse all component changes

Things to check

Multiple failing checks

Following checks are failing:
XML markup: Portuguese (Brazil)
Zero-width space: Portuguese (Brazil)


Source information

Source string comment
(itstool) path: sect2/para
Source string location
String age
a year ago
Source string age
a year ago
Translation file
books/fdp-primer.pot, string 242