diff options
Diffstat (limited to 'template.conf.sample')
| -rw-r--r-- | template.conf.sample | 48 |
1 files changed, 38 insertions, 10 deletions
diff --git a/template.conf.sample b/template.conf.sample index f28b5e5..629b927 100644 --- a/template.conf.sample +++ b/template.conf.sample @@ -1,12 +1,40 @@ -# This is a sample configuration file for a porteur template. To configure a template -# `mytemplate` create a file `⟨etc⟩/porteur/tmpl/mytemplate/.config` and put the -# configuration values in there. +# This is a sample configuration file for a porteur template. To configure a +# template `mytemplate` create a file `⟨etc⟩/porteur/tmpl/mytemplate/.config` +# and put the configuration values in there. -# The Makefile target that will be executed to prepare the source tree before creating the -# distribution. This target should execute what needs to be executed to deterministically -# build the port's source (e.g. vendoring). It needs to be defined in the port's Makefile -# within the template. When executing this target, porteur sets WRKSRC to the Git repository -# of the port. -# If no such target is defined, the preparation step will be skipped. -dist-prepare-target = prepare-dist + +# Without any configuration a single distribution file is created by archiving +# the whole source tree. However, to make the distribution more flexible the +# following options are available: +# +# dist.prepare-target +# The name of a port's Makefile target, that is executed before the +# archiving step. This target will be used to prepare the source tree +# for its distribution (e.g. vendoring). When executed, porteur sets +# the WRKSRC variable to the path of the port's Git repository. If this +# option is absent or empty, no preparation step will be executed. +# +# dist.archive.root +# The root path of the archive file. This path is relative to the source +# tree and declares the new root of the distributed files for the archive. +# If the root is absent or empty, the source tree is the root of the +# archive. +# +# dist.archive.paths +# A space separated list of paths that should be included in the archive +# file. The paths are relative to the configured root directory. With this +# option it is possible to only distribute specific parts of the source +# tree. If no paths are defined, the whole source tree will be archived. +# +# It is also possible to define a distribution consisting of multiple archives, +# where each archive needs to have a unique name. This name can be assigned +# using the following format: `dist.archive[⟨name⟩].*`. The corresponding +# template variable that references a named archive is `.distname.⟨name⟩`. +# There can be up to 16 different archive files. +dist.prepare-target = prepare-dist +dist.archive.root = . +dist.archive.paths = src lib +dist.archive[docs].root = docs +dist.archive[docs].paths = samples + = manpages |