From: Peter Krempa <pkrempa@redhat.com>
Date: Thu, 3 Nov 2022 10:07:12 +0000 (+0100)
Subject: apibuild: Don't include the Copyright in the <description> of a module
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=1bea629cbce7d6d0994ec4b66ae72e00f915e992;p=libvirt.git

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>
---

diff --git a/scripts/apibuild.py b/scripts/apibuild.py
index c232b4e2c8..9614709e6c 100755
--- a/scripts/apibuild.py
+++ b/scripts/apibuild.py
@@ -721,6 +721,14 @@ class CParser:
                 item = m.group(1)
                 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 in res:
                     res[item] = res[item] + " " + line