Difference between revisions of "Build Tools"

Revision as of 15:58, 11 May 2021

The GnuCash project uses several different tools to build the program, the docs, and OS specific packages.

Basic Tools

These control the build process at a low level.

Make

Make is a build automation tool that builds targets from source by interpreting recipe files called Makefiles which specify how to transform the source file(s) into the target file(s). Many "Integrated Development Environments" or "IDEs" use make (or its Microsoft cousin nmake) to perform the build. Makefiles can be written by hand (as is the case for gnucash-htdocs.git) or generated by Autotools or CMake. Make can be invoked recursively to build complex programs and use file timestamps to only recompile files and libraries where a dependency has been changed. Makefiles ususally specify a number of targets of the build which may be supplied as arguments when make is called to perform specific actions to produce specific outputs.

Ninja

Ninja is a small build system with a focus on speed. It is designed to have its input files generated by a higher-level build system, and it is designed to run builds as fast as possible.

Note

The commands change then from make [target] to ninja [target].

Note

Some Linux distributions name the command ninja-build to distinguish it from another program called ninja.

A comparison of CMake with the make utility is available here

CMake is commonly used to configure ninja build files: To do so pass -G Ninja among the cmake arguments.

Tool Chains

In addition, GnuCash uses different tool chains to control the basic tools mentioned above. The program makes use of the CMake as the base of its tool chain, while the user documentation uses the Autotools as the base of the tool chain. The website is compiled directly using Make. The API documentation is created from the source code using Make or Ninja, depending on how the source code build system is configured.

CMake

To set up or configure the program build system, we use CMake. It should also be used for the Gnucash-docs.

It is a cross-platform free and open-source software application for managing the build process of software using a compiler-independent method. It supports directory hierarchies and applications that depend on multiple libraries. It is used in conjunction with native build environments such as make, Apple's Xcode, and Microsoft Visual Studio. It has minimal dependencies, requiring only a C++ compiler on its own build system. At present, CMake is primarily used to configure the build system by creating the input files for either the make or the ninja build programs which compile and link the program and its libraries. These utilities also control installation of the program and libraries. See CMake#GnuCash Configuration Variables.

Autotools (deprecated)

We used to rely on the GNU Build System to set up or configure the Gnucash-docs build system. This is also often referred to as "autotools". We plan to drop it in Gnucash 4.9xx!

It's a complex and capable system for configuring and building a wide range of projects on a wide range of platforms. The Autotools Mythbuster provides an excellent tutorial and reference for those wishing to learn about creating and building projects using the system.

For those who simply need to build the documentation from source, the following three commands will suffice:

1. autogen.sh: Checks that all required parts of the build system are installed, then builds the configure program from its source, configure.ac and the intermediate Makefiles Makefile.in from their source Makefile.am. You'll run autogen.sh after you first clone gnucash-docs.git, any time you edit a Makefile.am or configure.ac, and any time you pull commits with changes to those files. Since it does no harm to run it unnecessarily we recommend that you run it after any git pull.
2. (not required, but suggested)

   mkdir .build
   cd .build
   

   Note

   configure and make commands are run from this ${BUILDDIR} while sources are edited in the parental ${SOURCEDIR}.

3. configure: This shell script, generated by autogen.sh as described above, examines your system and its arguments to convert the intermediate Makefile.in<code> to <code>Makefile that the make command will use to actually generate the documentation product files. One can get a listing of the arguments and environment variables that any particular configure understands by running configure --help.
4. make: Using Makefile as a template, make runs the various programs and scripts needed to perform the build. Its arguments are the targets to be built; there are two special targets, make check runs tests to ensure that the project has been built correctly and make install moves the build products to the locations from which they may be used.

Return to:

Building GnuCash