diff options
| author | Sachi King <nakato@nakato.io> | 2015-06-22 11:59:07 +1000 |
|---|---|---|
| committer | Sachi King <nakato@nakato.io> | 2015-06-22 13:31:54 +1000 |
| commit | 868ea6a9678fbdb4819673869bc9e045cfc6d313 (patch) | |
| tree | e538134e37fa7861adae4c8f39be3838546ab85b | |
| parent | e41a9180ed3103bb45fa1d1be93ba951016b029c (diff) | |
| download | pbr-868ea6a9678fbdb4819673869bc9e045cfc6d313.tar.gz | |
This documents the use of comments that work between 2.6, 2.7 and 3.4
Comments are not directly handled by PBR, this documents a reasonable working
set of comments that can be used in setup.cfg.
Comments are parsed out over three locations, configparser, which varies rather
significantly between two and three, pkg_resources, and lastly when pip runs.
Change-Id: Iedebc5baca4e21081708971540d6eab89e043f05
| -rw-r--r-- | doc/source/index.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 331a2d3..b9e49eb 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -305,6 +305,22 @@ all found Python modules are included; some of them can be excluded by listing them in `autodoc_exclude_modules`. This list of modules can contains `fnmatch` style pattern (e.g. `myapp.tests.*`) to exclude some modules. +Comments +-------- + +Comments may be used in setup.cfg, however all comments should start with a +`#` and may be on a single line, or in line, with at least one white space +character immediately preceding the `#`. Semicolons are not a supported +comment delimiter. For instance:: + + [section] + # A comment at the start of a dedicated line + key = + value1 # An in line comment + value2 + # A comment on a dedicated line + value3 + Additional Docs =============== |