apibuild: Don't include the Copyright in the <description> of a module

When building the top level description from a header file the
'parseTopComment' method of the 'CParser' would include all trailing
lines into the <description> field. This was designed to concatenate
multi-line descriptions, but unfortunately in all cases also included
the Copyright statement which followed.

Explicitly end the scanning of the header on a line which starts with
'Copyright (C)' and truncate the spaces from the end of the last item.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Peter Krempa 2022-11-03 11:07:12 +01:00
parent ed2109d272
commit 1bea629cbc

View File

@ -721,6 +721,14 @@ class CParser:
item = m.group(1) item = m.group(1)
line = m.group(2).lstrip() line = m.group(2).lstrip()
# don't include the Copyright in the last 'item'
if line.startswith("Copyright (C)"):
# truncate any whitespace originating from newlines
# before the Copyright
if item:
res[item] = res[item].rstrip()
break
if item: if item:
if item in res: if item in res:
res[item] = res[item] + " " + line res[item] = res[item] + " " + line