Skip to content

Commit

Permalink
document distro keyword
Browse files Browse the repository at this point in the history
As reported in #64, the distro keyword wasn't described well. Also
improve the flavors context a bit.
  • Loading branch information
joufellasfl committed May 13, 2019
1 parent e7c3e38 commit 44e0406
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,8 @@ template, which defaults to ``%Po-%Pn.tar.xz``.

### Flavors ###

You may also want to build a specific build flavor, for a regular build
or a release. To do so use the -b option, for example:

$ cqfd -b debug run

When building with a flavor, as when building a regular project, the
``run`` option can be omitted.
Flavors are used to create alternate build scenarios. For example, to
use another container or another build command.

## The .cqfdrc file ##

Expand Down Expand Up @@ -131,6 +126,10 @@ specified for the archive to be stored at the root of the archive,
which is desired in some scenarios. This feature is not supported with
.zip archives.

``distro``: the name of the directory containing the Dockerfile. By
default, cqfd uses ``"docker"``, and ``.cqfd/docker/Dockerfile` is
used.

``flavors``: the list of build flavors (see below). Each flavor has its
own command just like build.command.

Expand All @@ -144,17 +143,21 @@ In the .cqfdrc file, one or more flavors may be listed in the
``[build]`` section, referencing other sections named following
flavor's name.

[centos7]
command='make CENTOS=1'
distro='centos7'

[debug]
command='make DEBUG=1'
files='myprogram Symbols.map'

[build]
command='make'
files='myprogram'
flavors='debug'
flavors='centos7 debug'

A flavor will typically redefine the keys of the build section:
command, files, archive.
A flavor will typically redefine some keys of the build section:
command, files, archive, distro.

Flavors from a `.cqfdrc` file can be listed using the `flavors` argument.

Expand Down

0 comments on commit 44e0406

Please sign in to comment.