]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
Update to support ** and *** lists
authorAlan T. DeKok <aland@freeradius.org>
Tue, 9 Jun 2026 06:09:46 +0000 (09:09 +0300)
committerAlan T. DeKok <aland@freeradius.org>
Tue, 9 Jun 2026 06:09:46 +0000 (09:09 +0300)
doc/wrap.md
scripts/asciidoc/wrap.py

index d489653f7587da1bcf51ecde8fefd48a25cf1ba8..5b2bfcc2da42f94a4c9a5c2088231257f5fb84f4 100644 (file)
@@ -4,7 +4,8 @@ The "*.adoc" files should have all text paragraphs wrapped at 80
 columns.
 
 If there are multiple blank lines in a row, then the output should
-contain only one blank line.
+contain only one blank line.  If there are blank lines at the end of
+the file, they should be removed.
 
 Trailing spaces on lines should be removed.
 
@@ -41,12 +42,12 @@ wrapped.
 
 Paragraphs should have a blank line between them.
 
-List entries are lines that start with "* " or "- ".  They should be
-wrapped individually.  That is, each list entry should be word wrapped
-all by itself, and should not include text from other list entries.
-If a list entry spans multiple lines, the second line should be
-indented another 2 spaces, so that it is aligned with the text, and
-not with the leading "* ".
+List entries are lines that start with "* " ("** " or "*** "), or "-
+".  They should be wrapped individually.  That is, each list entry
+should be word wrapped all by itself, and should not include text from
+other list entries.  If a list entry spans multiple lines, the second
+line should be indented another 2 spaces, so that it is aligned with
+the text, and not with the leading "* ".
 
 Numbered list entries are lines that start with a number, followed by
 a dot.  e.g. "1.".  Those list entries should be word wrapped just
index 13282c8718d2f1b24d5bc80ec9aea1e6864903ef..174bb4d267bc25282a45c7739fbbe13cebca7778 100755 (executable)
@@ -23,10 +23,11 @@ Rules:
   - Lines that start with "[" (e.g. "[NOTE]", "[source,c]") are left
     unchanged on their own line.
   - Lines starting with "|" (tables) are left unchanged.
-  - List entries begin with "* " or "- ", or with a number followed by
-    "." (e.g. "1.").  Each entry is wrapped on its own; continuation
-    lines are indented so they align with the text after the marker.
-    For numbered entries the leading number is preserved as-is.
+  - List entries begin with one to four "*" markers ("* ", "** ",
+    "*** ", "**** "), with "- ", or with a number followed by "."
+    (e.g. "1.").  Each entry is wrapped on its own; continuation lines
+    are indented so they align with the text after the marker.  For
+    numbered entries the leading number is preserved as-is.
 
        $Id$
 """
@@ -105,7 +106,7 @@ def is_comment(line):
     return line.lstrip().startswith("//")
 
 
-_LIST_MARKER_RE = re.compile(r"^(?:[*-]|\d+\.)\s+")
+_LIST_MARKER_RE = re.compile(r"^(?:\*{1,4}|-|\d+\.)\s+")
 
 
 def list_marker_len(line):