[groff] 01/01: tmac/strip.sed: Explain operations.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit a8debe333518d6915bca1c92f5a7906640972d7d
Author: G. Branden Robinson <address@hidden>
Date:   Tue Nov 7 14:43:51 2017 -0500

    tmac/strip.sed: Explain operations.
    
    Signed-off-by: G. Branden Robinson <address@hidden>
---
 tmac/strip.sed | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/tmac/strip.sed b/tmac/strip.sed
index e52f93f..407fb01 100644
--- a/tmac/strip.sed
+++ b/tmac/strip.sed
@@ -2,6 +2,18 @@
 .\\" This is a generated file, created by `tmac/strip.sed' in groff's\
 .\\" source code bundle from a file having `-u' appended to its name.
 # strip comments, spaces, etc., after a line containing `%beginstrip%'
+#
+# 1. Strip whitespace after a leading ".".
+# 2. Reduce old-style comment lines (.\") to the empty request (.).
+# 3. Reduce new-style comment lines (\#) to the empty request.
+# 4. Truncate trailing old-style comments.
+# 5. Truncate trailing new-style comments (keeping line continuation).
+# 6. Remove trailing whitespace and truncated old-style comments on
+#    all lines that do not define or append to string registers.
+# 7. Remove truncated old-style comments, preserving trailing
+#    whitespace, on lines that defined or append to string registers.
+# 8. Shorten mdoc symbol names.
+# 9. Delete all lines containing only the empty request.
 /%beginstrip%/,$ {
   s/^\.[        ]*/./
   s/^\.\\".*/./