airframes srcparser.py: Allow non-param comments

Add a "@desc" tag that gets ignored by the parameter parser.  This
allows you to add (multi-line) documentation to airframe init files.
This commit is contained in:
JacobCrabill 2020-02-28 21:09:58 -08:00 committed by Lorenz Meier
parent 032b9909fa
commit b186614857
1 changed files with 4 additions and 1 deletions

View File

@ -273,7 +273,7 @@ class SourceParser(object):
re_remove_dots = re.compile(r'\.+$')
re_remove_carriage_return = re.compile('\n+')
valid_tags = set(["url", "maintainer", "output", "arch", "name", "type"])
valid_tags = set(["url", "maintainer", "output", "arch", "name", "type", "desc"])
# Order of parameter groups
priority = {
@ -394,6 +394,9 @@ class SourceParser(object):
airframe_class = tags[tag]
elif tag == "name":
airframe_name = tags[tag]
elif tag == "desc":
# General documentation - not a parameter to be saved.
pass
elif tag not in self.valid_tags:
sys.stderr.write("Aborting due to invalid documentation tag: '%s'\n" % tag)
return False