chg: doc: gitchangelog: don't break lines on hyphens in relnotes

When release notes are generated, the text is wrapped and line breaks
are inserted into each paragraph (sourced from the commit message's
body). Prevent line breaks after hyphens, as these are often used for
option names. This makes it possible to easily find the options
afterwards.

Merge branch 'nicki/gitchangelog-dont-break-on-hyphens' into 'main'

See merge request isc-projects/bind9!9801
This commit is contained in:
Petr Špaček
2024-12-02 13:53:38 +00:00

View File

@@ -561,7 +561,8 @@ def paragraph_wrap(text, regexp="\n\n", separator="\n"):
"""
regexp = re.compile(regexp, re.MULTILINE)
return separator.join(
"\n".join(textwrap.wrap(paragraph.strip())) for paragraph in regexp.split(text)
"\n".join(textwrap.wrap(paragraph.strip(), break_on_hyphens=False))
for paragraph in regexp.split(text)
).strip()
@@ -1514,7 +1515,12 @@ def rest_py(data, opts={}):
if opts["include_commit_sha"]:
subject += " ``%s``" % commit["commit"].sha1_short
entry = indent("\n".join(textwrap.wrap(subject)), first="- ").strip() + "\n"
entry = (
indent(
"\n".join(textwrap.wrap(subject, break_on_hyphens=False)), first="- "
).strip()
+ "\n"
)
if commit["body"]:
entry += "\n" + indent(commit["body"])