Difference between revisions of "Build Tools"
(The GnuCash project uses several different tools to build the program, the docs, the OS specific packages.) |
(several minor edits) |
||
| Line 18: | Line 18: | ||
=== Autotools === | === Autotools === | ||
| − | Gnucash-docs is using Autotools, which consists of | + | '''Gnucash-docs''' is using Autotools, which consists of several parts, from which 2 are important: |
[https://en.wikipedia.org/wiki/Autoconf Autoconf] is a tool for producing '''configure''' scripts for building, installing and packaging software on computer systems where a [https://en.wikipedia.org/wiki/Bourne_shell Bourne shell] is available. | [https://en.wikipedia.org/wiki/Autoconf Autoconf] is a tool for producing '''configure''' scripts for building, installing and packaging software on computer systems where a [https://en.wikipedia.org/wiki/Bourne_shell Bourne shell] is available. | ||
| Line 27: | Line 27: | ||
# After checking out of the repository run <code>./autogen.sh</code>. | # After checking out of the repository run <code>./autogen.sh</code>. | ||
#* Decide, which build directory to use and run the following steps in your build dir. | #* Decide, which build directory to use and run the following steps in your build dir. | ||
| − | # After | + | # After you |
| + | #* installed ''updates'' of your tools or | ||
| + | #* modified ''makefile.am'' or ''configure.ac'' | ||
| + | #: run <code>configure [options]</code>. | ||
# Finally after your edits run <code>make <target></code>. Some common targets are <tt>all</tt>, <tt>check</tt>, <tt>install</tt>. | # Finally after your edits run <code>make <target></code>. Some common targets are <tt>all</tt>, <tt>check</tt>, <tt>install</tt>. | ||
=== CMake === | === CMake === | ||
| − | [https://en.wikipedia.org/wiki/CMake CMake] 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. | + | For the '''program''' we use [https://en.wikipedia.org/wiki/CMake CMake].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. |
[[Category:Development]] | [[Category:Development]] | ||
Revision as of 23:23, 12 September 2018
The GnuCash project uses several different tools to build the program, the docs, the OS specific packages.
Basic Tools
This control the build process at a low level.
Make
Make is a build automation tool that automatically builds executable programs and libraries from source code by reading files called Makefiles which specify how to derive the target program. Though integrated development environments and language-specific compiler features can also be used to manage a build process, Make remains widely used, especially in Unix and Unix-like operating systems.
It is directly used in gnucash-htdocs, indirectly by #Autotools and optionally by #CMake.
Ninja
Ninja is a small build system with a focus on speed. It differs from other build systems in two major respects: 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.
You can use it in #CMake.
Tool Chains
More complex projects use this tools to control the basic tools.
Autotools
Gnucash-docs is using Autotools, which consists of several parts, from which 2 are important:
Autoconf is a tool for producing configure scripts for building, installing and packaging software on computer systems where a Bourne shell is available.
Automake automatically generates one or more Makefile.in from files called Makefile.am. Each Makefile.am contains, among other things, useful variable definitions for the compiled software, such as compiler and linker flags, dependencies and their versions, etc. The generated Makefile.ins are portable and compliant with the Makefile conventions in the GNU Coding Standards, and may be used by configure scripts to generate a working Makefile.
So there remain 3 basic steps:
- After checking out of the repository run
./autogen.sh.- Decide, which build directory to use and run the following steps in your build dir.
- After you
- installed updates of your tools or
- modified makefile.am or configure.ac
- run
configure [options].
- Finally after your edits run
make <target>. Some common targets are all, check, install.
CMake
For the program we use CMake.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.
