[PATCH libSM] doc: clean-up generated html images

Gaetan Nadon memsize at videotron.ca
Tue Jan 26 17:23:52 PST 2010


Generate images in /images as is the convention
Provide a base file name for images rather than process ID
Remove images directory when running make clean

Signed-off-by: Gaetan Nadon <memsize at videotron.ca>
---
 doc/.gitignore  |    2 +-
 doc/Makefile.am |    5 ++++-
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/doc/.gitignore b/doc/.gitignore
index 5077603..84d7456 100644
--- a/doc/.gitignore
+++ b/doc/.gitignore
@@ -5,4 +5,4 @@
 *.html.raw
 *.ps.raw
 *.txt.raw
-grohtml-*.png
+/images
diff --git a/doc/Makefile.am b/doc/Makefile.am
index b1fccc0..05fee05 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -33,6 +33,9 @@ doc_DATA = SMlib.txt SMlib.ps SMlib.html xsmp.txt xsmp.ps xsmp.html
 CLEANFILES = $(doc_DATA)
 MOSTLYCLEANFILES = index.*
 
+mostlyclean-local:
+	@rm -fr images
+
 # Pass version string as a troff string for substitution
 GROFF_DEFS = -dxV="$(PACKAGE_STRING)"
 
@@ -51,6 +54,6 @@ SUFFIXES = .ms .ps .txt .html
 	 $< 2> index.$@.raw > $@
 
 .ms.html:
-	$(AM_V_GEN) $(GROFF) -Thtml $(GROFF_FLAGS) $< 2> index.$@.raw > $@
+	$(AM_V_GEN) $(GROFF) -Thtml -P-Dimages -P-I$*-image $(GROFF_FLAGS) $< 2> index.$@.raw > $@
 
 endif BUILD_DOCS
-- 
1.6.0.4

This is much better:
$ ls -1 images
SMlib-image1.png
SMlib-image2.png
SMlib-image3.png
xsmp-image1.png
xsmp-image2.png
xsmp-image3.png

The reason why those images are generated is another story. Comparing the html doc with
the ps doc, a table is missing and a ref to an image takes in place.
This is in section 7 of libSM following the paragraph "A type of SmCARD8 indicates that there is a single 1-byte value."




More information about the xorg-devel mailing list