Add SI95 transport library to doc
[ric-plt/lib/rmr.git] / doc / src / rtd / Makefile
index 4c64278..878229e 100644 (file)
 # {X}fm is required to compile the source. 
 
 
-%.rst:: %.xfm
+%.rst:: %.xfm  man_list.im
        OUTPUT_TYPE=rst tfm $< | sed 's/^ //' >$@
 
-%.ps:: %.xfm
+%.ps:: %.xfm   man_list.im
        OUTPUT_TYPE=ps pfm $< $@
 
-%.txt:: %.xfm
+%.txt:: %.xfm  man_list.im
        OUTPUT_TYPE=txt tfm $< $@
 
-%.md:: %.xfm
+%.md:: %.xfm   man_list.im
        OUTPUT_TYPE=markdown tfm $<  | sed 's/^ //' >$@
 
 docs = config-deploy developer-guide user-guide rel-notes overview
 
-all:: $(docs:%=%.rst) $(docs:%=%.txt) $(docs:%=%.md) 
+all:: $(docs:%=%.rst) $(docs:%=%.txt) $(docs:%=%.md)
 
-rel-notes.xfm:
+man_list.im:: always
+       bash gen_man_list.sh >man_list.im
+
+rel-notes.xfm:: always
        ksh fmt_changes.ksh >rel-notes.xfm
 
+
+# we force the docs to always be out of date so that we don't have to
+# manage the list of man pages and other files that are read to generate the
+# output needed for RTD.
+#
+$(docs:%=%.rst): always
+$(docs:%=%.txt): always
+$(docs:%=%.md): always
+
+
 # copy the .rst files which have changed into the docs (plural) directory at the root of the repo
 publish : $(docs:%=%.rst)
        for f in *.rst;\
@@ -51,11 +64,23 @@ publish : $(docs:%=%.rst)
                fi;\
        done
 
+# just list what would be published
+verify : $(docs:%=%.rst)
+       for f in *.rst;\
+       do\
+               if ! diff -N -q $$f ../../../docs/$$f >/dev/null 2>&1;\
+               then\
+                       echo "$$f would be published";\
+               fi;\
+       done
+
 # ditch any intermediate files
 clean:
        rm -f rel-notes.xfm *.sp *.ca
 
 # ditch anything that can be rebuilt
 nuke: clean
-       rm -f *.ps *.pdf *.rst *.md
+       rm -f *.ps *.pdf *.rst *.md *.txt
 
+# make hack to force a rule to always be out of date
+always: