FreeBSD Documentation Project Primer for New Contributors
Prev		Next

Chapter 7. The Documentation Build Process

Table of Contents
71
7.1. The FreeBSD Documentation Build Toolset
7.2. Understanding Makefiles in the Documentation tree
7.3. FreeBSD Documentation Project make includes

This chapter's main purpose is to clearly explain how the documentation build process is organised, and how to affect modifications to this process.

After you have finished reading this chapter you should:

Know what you need to build the FDP documentation, in addition to those mentioned in the SGML tools chapter.
Be able to read and understand the make instructions that are present in each document's Makefiles, as well as an overview of the doc.project.mk includes.
Be able to customize the build process by using make variables and make targets.

7.1. The FreeBSD Documentation Build Toolset

Here are your tools. Use them every way you can.

The primary build tool you will need is make, but specifically Berkeley Make.
Package building is handled by FreeBSD's pkg_create. If you are not using FreeBSD, you will either have to live without packages, or compile the source yourself.
gzip is needed to create compressed versions of the document. bzip2 compression and zip archives are also supported. tar is supported, but package building demands it.
install is the default method to install the documentation. There are alternatives, however.

Note: It is unlikely you will not be able to find these last two, they are mentioned for completeness.

Prev	Home	Next
Document specific information		Understanding Makefiles in the Documentation tree