bn8/gitdch
1
0
Fork 0
Code Issues Pull requests Projects Releases 9 Wiki Activity Actions

Update usage in README.md

Browse source
This commit is contained in:
Benjamin Renard 2022-12-12 19:47:47 +01:00
parent 70381153b9
commit e99758fe0e
1 changed files with 33 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -32,9 +32,13 @@ chmod +x /usr/local/bin/gitdch
# Usage # Usage
``` ```
usage: gitdch [-h] [-d] [-v] [-w] [-l LOGFILE] [-q] [-p GIT_PATH] [-o OUTPUT] [-n PACKAGE_NAME] [-V VERSION] [--version-suffix VERSION_SUFFIX] [-c CODE_NAME] [-u URGENCY] usage: gitdch [-h] [-d] [-v] [-w] [-l LOGFILE] [-q] [-p GIT_PATH] [-o OUTPUT] [-A]
[-n PACKAGE_NAME] [-V VERSION] [--version-suffix VERSION_SUFFIX]
[-c CODE_NAME] [-u URGENCY] [-N MAINTAINER_NAME] [-E MAINTAINER_EMAIL]
[-R RELEASE_NOTES] [--revision REVISION] [-C CLEAN_TAGS_REGEX]
[-x EXCLUDE]
Generate Debian package changelog from git Generate Debian package changelog from git (version: 0.0)
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
@ -43,21 +47,46 @@ optional arguments:
-w, --warning Show warning messages -w, --warning Show warning messages
-l LOGFILE, --log-file LOGFILE -l LOGFILE, --log-file LOGFILE
Log file path Log file path
-q, --quiet Quiet mode: do not log on console (only if log file is provided) -q, --quiet Quiet mode: do not log on console (only if log file is
provided)
-p GIT_PATH, --path GIT_PATH -p GIT_PATH, --path GIT_PATH
Git repository path (default: ./) Git repository path (default: ./)
-o OUTPUT, --output OUTPUT -o OUTPUT, --output OUTPUT
Generated Debian changelog output path (default: stdout) Generated Debian changelog output path (default: stdout)
-A, --append Append mode: if the output changelog file already exists,
append generated changelog lines at the begining of the file
(optional, default: overwriting the file)
-n PACKAGE_NAME, --package-name PACKAGE_NAME -n PACKAGE_NAME, --package-name PACKAGE_NAME
Package name Package name
-V VERSION, --version VERSION -V VERSION, --version VERSION
Currrent version (default: autodetected using git describe --always --tags) Currrent version (default: autodetected using git describe
--always --tags)
--version-suffix VERSION_SUFFIX --version-suffix VERSION_SUFFIX
Suffix for autodetected version Suffix for autodetected version
-c CODE_NAME, --code-name CODE_NAME -c CODE_NAME, --code-name CODE_NAME
Debian code name (default: unstable) Debian code name (default: unstable)
-u URGENCY, --urgency URGENCY -u URGENCY, --urgency URGENCY
Package urgency (default: medium) Package urgency (default: medium)
-N MAINTAINER_NAME, --maintainer-name MAINTAINER_NAME
Maintainer name (default: last commit author name)
-E MAINTAINER_EMAIL, --maintainer-email MAINTAINER_EMAIL
Maintainer email (default: last commit author email)
-R RELEASE_NOTES, --release-notes RELEASE_NOTES
Specify an optional Markdown release notes output path
--revision REVISION Specify the revision to use to generate the changelog (see
git-rev-parse for viable options, optional, default:
generate the changelog with all commits of the current
branch)
-C CLEAN_TAGS_REGEX, --clean-tags-regex CLEAN_TAGS_REGEX
Clean tags regex: you could specify regex to clean tag names
when computing package versions. For instance, to drop a
"-eeXXX" suffix of tag names, specify -C "\-ee[0-9]{3}$"
(optional, multiple regex allowed)
-x EXCLUDE, --exclude EXCLUDE
Commit exclusion regex: you could specify regex to exclude
some commits from generated changelog entries. For instance,
to exclude commits with message starting with "CI: ",
specify -x "^CI: " (optional, multiple regex allowed)
``` ```
## Copyright ## Copyright