| Age | Commit message (Collapse) | Author |
|---|
|
This makes sure that the version / date file is always re-generated.
Otherwise it is hard to make sure that e.g. the version is always
aligned with the real state.
|
|
Since otherwise the Git describe output / version information is only
embedded into the file name the risk is given that Git version
information is lost by renaming the file.
|
|
Using the date of the build makes it not-reproducible. This should be
avoided. Furthermore the date on the front page should anyway reflect
when the source of the document was created. Not when it was converted
into a PDF.
|
|
The full soundbox-<version>- prefix was only used for the artifact tar
archive name so far. This has the advantage that the file names inside
that archive are shorter like 'documentation.pdf'.
But sometimes it is useful to pass only the documentation around as a
PDF file because it is easier for people to open it compared to a tar
file.
For this purpose a second artifact installation for the documentation
PDF is added including the soundbox-<version>- prefix.
|
|
Inside the artifacts folder aswell as inside the source folder adding a
'soundbox-' prefix to files is uncommon. In both cases only the root level
folder should contain the name 'soundbox' to remove redundancies.
|
|
This target will skip generating the artifacts directory. This avoids a
bloated build directory while the default target 'all' still generates
the artifacts.
|
|
All build files relevant for users (artifacts) should be provided in
build/artifacts. This folder has subdirectories for every revision and a
corresponding Zstandard-compressed Tar archive.
This archive contains the full result of the build of the current source
directory and can easily be shared.
|
|
The build system should convert the documentation source files
automatically to a single PDF file to make documentation generation
trivial.
|
|
This target removes the build directory and is thus repository-global.
|
|
The build system of this repository should be used from the repository
root. Subdirectories should only contain additional *.mk files which
will be included by the central Makefile.
This should allow to have dependencies between subdirectories if
required and easily allows to build everything.
|
