pkgdev commit - create git commit

Synopsis

pkgdev commit [–config CONFIG_FILE] [–domain DOMAIN] [-h] [–debug] [-q] [-v] [–color BOOLEAN] [-b BUG] [-c CLOSES[:RESOLUTION]] [-T NAME:VALUE] [-n] [-s [BOOLEAN]] [-A [BOOLEAN]] [–mangle [BOOLEAN]] [–signoff [BOOLEAN]] [–gpg-sign | –no-gpg-sign] [-d DISTDIR] [-m MSG | -M FILE] [-e] [-u | -a]

Config Options

--config CONFIG_FILE

Load custom pkgdev scan settings from a given file.

Note that custom user settings override all other system and repo-level settings.

It’s also possible to disable all types of settings loading by specifying an argument of ‘false’ or ‘no’.

--domain DOMAIN

custom pkgcore domain to use for this operation

Base Options

-h, --help

Show this help message and exit. To get more information see the related man page.

--debug

Enable debug checks and show verbose debug output.

-q, --quiet

Suppress non-error, informational messages.

-v, --verbose

Increase the verbosity of various output.

--color BOOLEAN

Toggle colored output support. This can be used to forcibly enable color support when piping output or other situations where stdout is not a tty.

Commit Options

-b, --bug BUG

add Bug tag for a given Gentoo or upstream bug

-c, --closes CLOSES[:RESOLUTION]

Indicate that a bug or PR may be closed. The optional resolution string for Gentoo’s Bugzilla describes what happened to a bug. It is case-insensitive and must be one of FIXED, OBSOLETE or PKGREMOVED.

-T, --tag NAME:VALUE

add commit tag

-n, --dry-run

Perform all actions without creating a commit.

-s, --scan [BOOLEAN]

By default, pkgdev commit doesn’t scan for QA errors. This option enables using pkgcheck to scan the staged changes for issues, erroring out if any failures are found.

-A, --ask [BOOLEAN]

When running with the -s/–scan option enabled, pkgdev commit will ask for confirmation before creating a commit if it detects failure results.

--mangle [BOOLEAN]

File mangling automatically modifies the content of relevant staged files including updating copyright headers and fixing EOF newlines.

This is performed by default for the gentoo repo, but can be forcibly disabled or enabled as required.

--signoff [BOOLEAN]

Add a Signed-off-by trailer by the committer at the end of the commit log message.

For committing to the Gentoo repository, under GLEP-76, the committer shall certify agreement to the Certificate of Origin by adding Signed-off-by line containing the committer’s legal name.

--gpg-sign, --no-gpg-sign

Pass --gpg-sign or --no-gpg-sign to the git commit command. This option enables to override the default behavior or the behavior defined by sign-commits = true in metadata/layout.conf file.

-d, --distdir DISTDIR

Use a specified target directory for downloads instead of the configured DISTDIR.

-m, --message MSG

Use a given message as the commit message. If multiple -m options are specified, their values are concatenated as separate paragraphs.

Note that the first value will be used for the commit summary and if it’s empty then a generated summary will be used if available.

-M, --message-template FILE

Use content from the given file as a commit message template. The commit summary prefix ‘*: ‘ is automatically replaced by a generated prefix if one exists for the related staged changes.

-e, --edit

This option will ask git to open the commit message in an editor before commit. The git configuration is used to select the editor.

-u, --update

stage all changed files

-a, --all

stage all changed/new/removed files