The documentation script tells the bt_doc module (see Chapter 3, Build time documentation) which documents can be read before building the package. These are often used to tell the user specific details about the build process, the package license or some other additional information.

The script is located inside the docs function, to be placed in the Generic.bt file (see Chapter 8, Script files).

The bt_doc function is used to tell the module which documents are available. Its syntax:

The first argument specifies the document file name, relative to the project's top directory. The second argument is a short sentence indicating what the document contents are.

docs() {
    bt_doc "CHANGES" "Major changes between package versions"
    bt_doc "PEOPLE" "Authors and contributors"
    bt_doc "README" "General documentation"
    bt_doc "TODO" "Missing things"
}