diff --git a/README.md b/README.md index 03ad920..499b950 100644 --- a/README.md +++ b/README.md @@ -510,11 +510,11 @@ Options: -v, --verbose Control log level. -vv for debug level. Commands: - update Increment the current version string and update project files. grep Search file(s) for a version pattern. init Initialize [bumpver] configuration. show Show current version of your project. test Increment a version number for demo purposes. + update Update project files with the incremented version string. ``` @@ -525,30 +525,31 @@ Commands: $ bumpver update --help Usage: bumpver update [OPTIONS] - Increment the current version string and update project files. + Update project files with the incremented version string. Options: - -v, --verbose Control log level. -vv for debug level. - -f, --fetch / -n, --no-fetch Sync tags from remote origin. -d, --dry Display diff of changes, don't rewrite files. + -f, --fetch / -n, --no-fetch Sync tags from remote origin. + -v, --verbose Control log level. -vv for debug level. --allow-dirty Commit even when working directory is has uncomitted changes. (WARNING: The commit will still be aborted if there are uncomitted to files with version strings. - --major Increment major component. - -m, --minor Increment minor component. - -p, --patch Increment patch component. - -t, --tag Override release tag of current_version. Valid - options are: alpha, beta, rc, post, final. + --set-version Set version explicitly. + --date Set explicit date in format YYYY-0M-0D (e.g. + 2020-10-20). + --pin-date Leave date components unchanged. --tag-num Increment release tag number (rc1, rc2, rc3..). - --pin-date Leave date components unchanged. - --date Set explicit date in format YYYY-0M-0D (e.g. - 2020-10-16). + -t, --tag Override release tag of current_version. Valid + options are: alpha, beta, rc, post, final. + -p, --patch Increment patch component. + -m, --minor Increment minor component. + --major Increment major component. --help Show this message and exit. ``` diff --git a/src/bumpver/cli.py b/src/bumpver/cli.py index 81784eb..f4d5b42 100755 --- a/src/bumpver/cli.py +++ b/src/bumpver/cli.py @@ -607,7 +607,7 @@ def _try_update( @verbose_option @dry_option def init(verbose: int = 0, dry: bool = False) -> None: - """Initialize [calver] configuration.""" + """Initialize [bumpver] configuration.""" _configure_logging(verbose=max(_VERBOSE, verbose)) ctx, cfg = config.init(project_path=".", cfg_missing_ok=True)