groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 53/53: [me]: Generate doc sources from *.in files.


From: G. Branden Robinson
Subject: [groff] 53/53: [me]: Generate doc sources from *.in files.
Date: Tue, 14 Dec 2021 01:22:05 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit a426abc6a77ec125f7fecdeeeca9c852be74035e
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Dec 6 02:34:28 2021 +1100

    [me]: Generate doc sources from *.in files.
    
    Generate me(7) manual sources as part of the build.  We had been
    shipping 'me' sources with the string '@VERSION@' in them and only
    sed-replacing that to produce generated PostScript, but this replacement
    was not occurring for users who processed the documents themselves.
    
    * doc/meintro.me:
    * doc/meintro_fr.me:
    * doc/meref.me: Rename these to...
    * doc/meintro.me.in:
    * doc/meintro_fr.me.in:
    * doc/meref.me.in: ...these.
    
    * doc/doc.am (DOCFILES): Add the new *.in files.  Move the *.me files
      from here...
      (GENERATEDDOCFILES): ...to this new variable.
    
      (dist_otherdoc_DATA, EXTRA_DIST): Add `$(GENERATEDDOCFILES)`.
    
      (doc/me{intro{,_fr},ref}.me): Add new target rules.
    
    * src/utils/grog/tests/smoke-test.sh: Update test to look for the above
      source tree documents under their new names.
---
 ChangeLog                               | 24 ++++++++++++++++++++++++
 doc/doc.am                              | 27 ++++++++++++++++++++++-----
 doc/{meintro.me => meintro.me.in}       |  0
 doc/{meintro_fr.me => meintro_fr.me.in} |  0
 doc/{meref.me => meref.me.in}           |  0
 src/utils/grog/tests/smoke-test.sh      |  6 +++---
 6 files changed, 49 insertions(+), 8 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 3fd74fd..90c7559 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -85,6 +85,30 @@
 
 2021-12-06  G. Branden Robinson <g.branden.robinson@gmail.com>
 
+       Generate me(7) manual sources as part of the build.  We had been
+       shipping 'me' sources with the string '@VERSION@' in them and
+       only sed-replacing that to produce generated PostScript, but
+       this replacement was not occurring for users who processed the
+       documents themselves.
+
+       * doc/meintro.me:
+       * doc/meintro_fr.me:
+       * doc/meref.me: Rename these to...
+       * doc/meintro.me.in:
+       * doc/meintro_fr.me.in:
+       * doc/meref.me.in: ...these.
+
+       * doc/doc.am (DOCFILES): Add the new *.in files.  Move the *.me
+       files from here...
+       (GENERATEDDOCFILES): ...to this new variable.
+       (dist_otherdoc_DATA, EXTRA_DIST): Add `$(GENERATEDDOCFILES)`.
+       (doc/me{intro{,_fr},ref}.me): Add new target rules.
+
+       * src/utils/grog/tests/smoke-test.sh: Update test to look for
+       the above source tree documents under their new names.
+
+2021-12-06  G. Branden Robinson <g.branden.robinson@gmail.com>
+
        * doc/doc.am (.me.txt, .ms.txt): Drop unused suffix rules.
 
 2021-12-06  G. Branden Robinson <g.branden.robinson@gmail.com>
diff --git a/doc/doc.am b/doc/doc.am
index 3185b61..4b6abde 100644
--- a/doc/doc.am
+++ b/doc/doc.am
@@ -51,11 +51,16 @@ if BUILD_OTHERDOC
 # Files located in the source tree
 DOCFILES= \
   doc/me-revisions \
-  doc/meintro.me \
-  doc/meintro_fr.me \
-  doc/meref.me \
+  doc/meintro.me.in \
+  doc/meintro_fr.me.in \
+  doc/meref.me.in \
   doc/ms.ms \
   doc/pic.ms
+# Files that undergo a transformation prior to groff processing
+GENERATEDDOCFILES = \
+  doc/meintro.me \
+  doc/meintro_fr.me \
+  doc/meref.me
 # Files generated in the build tree
 PROCESSEDDOCFILES = \
   doc/meref.ps \
@@ -65,11 +70,11 @@ PROCESSEDDOCFILES = \
   doc/pic.ps
 
 otherdocdir = $(docdir)
-dist_otherdoc_DATA = $(DOCFILES)
+dist_otherdoc_DATA = $(DOCFILES) $(GENERATEDDOCFILES)
 nodist_otherdoc_DATA = $(PROCESSEDDOCFILES)
 MOSTLYCLEANFILES += $(PROCESSEDDOCFILES)
 else
-EXTRA_DIST += $(DOCFILES)
+EXTRA_DIST += $(DOCFILES) $(GENERATEDDOCFILES)
 endif
 
 # pdf doc, written in mom and therefore using contrib/mom/mom.am
@@ -137,6 +142,18 @@ EXTRA_DIST += \
   doc/gnu.xpm \
   doc/txi-en.tex
 
+doc/meintro.me: $(doc_srcdir)/meintro.me.in
+       $(GROFF_V)$(MKDIR_P) `dirname $@` \
+       && $(DOC_SED) $< >$@
+
+doc/meintro_fr.me: $(doc_srcdir)/meintro_fr.me.in
+       $(GROFF_V)$(MKDIR_P) `dirname $@` \
+       && $(DOC_SED) $< >$@
+
+doc/meref.me: $(doc_srcdir)/meref.me.in
+       $(GROFF_V)$(MKDIR_P) `dirname $@` \
+       && $(DOC_SED) $< >$@
+
 # The me(7) intro French translation gets its own target rule because it
 # needs the "-mfr" option.
 doc/meintro_fr.ps: doc/meintro_fr.me
diff --git a/doc/meintro.me b/doc/meintro.me.in
similarity index 100%
rename from doc/meintro.me
rename to doc/meintro.me.in
diff --git a/doc/meintro_fr.me b/doc/meintro_fr.me.in
similarity index 100%
rename from doc/meintro_fr.me
rename to doc/meintro_fr.me.in
diff --git a/doc/meref.me b/doc/meref.me.in
similarity index 100%
rename from doc/meref.me
rename to doc/meref.me.in
diff --git a/src/utils/grog/tests/smoke-test.sh 
b/src/utils/grog/tests/smoke-test.sh
index fdd5cc7..9cf31bc 100755
--- a/src/utils/grog/tests/smoke-test.sh
+++ b/src/utils/grog/tests/smoke-test.sh
@@ -49,17 +49,17 @@ echo "testing tbl(1)-using mdoc(7) page $doc" >&2
 "$grog" "$doc" | \
     grep -Fqx 'groff -t -mdoc '"$doc"
 
-doc=$src/doc/meintro.me
+doc=$src/doc/meintro.me.in
 echo "testing me(7) document $doc" >&2
 "$grog" "$doc" | \
     grep -Fqx 'groff -me '"$doc"
 
-doc=$src/doc/meintro_fr.me
+doc=$src/doc/meintro_fr.me.in
 echo "testing tbl(1)-using me(7) document $doc" >&2
 "$grog" "$doc" | \
     grep -Fqx 'groff -t -me '"$doc"
 
-doc=$src/doc/meref.me
+doc=$src/doc/meref.me.in
 echo "testing me(7) document $doc" >&2
 "$grog" "$doc" | \
     grep -Fqx 'groff -me '"$doc"



reply via email to

[Prev in Thread] Current Thread [Next in Thread]