diff options
author | Siddhesh Poyarekar <siddhesh@gotplt.org> | 2020-08-20 08:43:47 +0530 |
---|---|---|
committer | Paul Eggert <eggert@cs.ucla.edu> | 2020-08-20 10:40:20 -0700 |
commit | a8dcb5ecdff8048c08a7a80d1e10782b3ee0ea7e (patch) | |
tree | e787334d8b909cbc68dc5258727ebe6b37ee7910 /build-aux/vcstocl | |
parent | 6ca8bb18851a4838cf0a7b4f17363fc9116a7b85 (diff) | |
download | gnulib-a8dcb5ecdff8048c08a7a80d1e10782b3ee0ea7e.tar.gz |
Sync up ProjectQuirks comments and documentation
Transform the ProjectQuirks comments into a docstring so that it can
be accessed from python as ProjectQuirks.__doc__ and harmonize
descriptions with the documentation.
* build-aux/vcstocl/projectquirks.py (ProjectQuirks):
Transform comments into a docstring.
* doc/vcs-to-changelog.texi: Sync up description with
comments.
Diffstat (limited to 'build-aux/vcstocl')
-rw-r--r-- | build-aux/vcstocl/projectquirks.py | 39 |
1 files changed, 25 insertions, 14 deletions
diff --git a/build-aux/vcstocl/projectquirks.py b/build-aux/vcstocl/projectquirks.py index 6561e387d0..ddb34a6055 100644 --- a/build-aux/vcstocl/projectquirks.py +++ b/build-aux/vcstocl/projectquirks.py @@ -16,21 +16,32 @@ class ProjectQuirks: - # This is a list of regex substitutions for C/C++ macros that are known to - # break parsing of the C programs. Each member of this list is a dict with - # the key 'orig' having the regex and 'sub' having the substitution of the - # regex. - MACRO_QUIRKS = [] + ''' Base class for project quirks - # This is a list of macro definitions that are extensively used and are - # known to break parsing due to some characteristic, mainly the lack of a - # semicolon at the end. - C_MACROS = [] + The following members can be overridden in the subclass: - # The repo type, defaults to git. - repo = 'git' + - MACRO_QUIRKS + A list of dictionary entries with indexes as `orig` and `sub` where `orig` + is a Python regular expression pattern to match and `sub` is the + substitution. These substitutions are used to work around C/C++ macros + that are known to break parsing of C programs. + + - C_MACROS + This is a list of macro definitions that are extensively used and are + known to break parsing due to some characteristic, mainly the lack of a + semicolon at the end. + + - IGNORE_LIST + A list of files to ignore in the changesets, either because they are not + needed (such as the ChangeLog) or because they are not parseable. For + example, glibc has a header file that is only assembly code, which breaks + the C parser. - # List of files to ignore either because they are not needed (such as the - # ChangeLog) or because they are non-parseable. For example, glibc has a - # header file that is only assembly code, which breaks the C parser. + - repo + Specify the project repo source control. The default value is `git`. + + ''' + MACRO_QUIRKS = [] + C_MACROS = [] + repo = 'git' IGNORE_LIST = ['ChangeLog'] |