From f79598b7acc17b8d6c05d7a9fec502f41b7e8be5 Mon Sep 17 00:00:00 2001 From: Luciano Bello Date: Sat, 27 Oct 2018 16:11:55 -0400 Subject: 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 --- README.rst | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 4765803..dc7a4d7 100644 --- a/README.rst +++ b/README.rst @@ -210,6 +210,13 @@ The currently supported configuration keys are: defaults to the value of ``setuptools_scm.config.DEFAULT_TAG_REGEX`` (see `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 `_). To use setuptools_scm in other Python code you can use the ``get_version`` function: -- cgit v1.2.1