diff options
| author | Luciano Bello <luciano@debian.org> | 2018-10-27 16:11:55 -0400 |
|---|---|---|
| committer | Luciano Bello <luciano.bello@ibm.com> | 2018-10-28 14:14:58 -0400 |
| commit | f79598b7acc17b8d6c05d7a9fec502f41b7e8be5 (patch) | |
| tree | 6221cacbca3b3f6916f314c190000bf1ad15b188 /README.rst | |
| parent | b72e86857802b257cc72d420c706624daf5f97ec (diff) | |
| download | setuptools-scm-f79598b7acc17b8d6c05d7a9fec502f41b7e8be5.tar.gz | |
Add option git_describe_command
The option git_describe_command is added to allow the user to manipulate how `git describe` is called.
Fixes #303
Fixes #283
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 7 |
1 files changed, 7 insertions, 0 deletions
@@ -210,6 +210,13 @@ The currently supported configuration keys are: defaults to the value of ``setuptools_scm.config.DEFAULT_TAG_REGEX`` (see `config.py <src/setuptools_scm/config.py>`_). +:git_describe_command: + This command will be used instead the default `git describe` command. + Use with caution, this is a function for advanced use, and you should be + familiar with the setuptools_scm internals to use it. + + The default value is set by ``setuptools_scm.git.DEFAULT_DESCRIBE`` + (see `git.py <src/setuptools_scm/git.py>`_). To use setuptools_scm in other Python code you can use the ``get_version`` function: |