[32812] trunk/doc-new/Makefile

[simon at macports.org]

Revision: 32812
          http://trac.macosforge.org/projects/macports/changeset/32812
Author:   simon at macports.org
Date:     2008-01-13 15:27:07 -0800 (Sun, 13 Jan 2008)

Log Message:
-----------
doc-new: Added some documentation.

Modified Paths:
--------------
    trunk/doc-new/Makefile

Modified: trunk/doc-new/Makefile
===================================================================
--- trunk/doc-new/Makefile	2008-01-13 23:23:02 UTC (rev 32811)
+++ trunk/doc-new/Makefile	2008-01-13 23:27:07 UTC (rev 32812)
@@ -50,6 +50,7 @@
 
 all: guide man
 
+# Generate the html guide using DocBook from the xml sources in $(GUIDE-SRC).
 guide:
 	$(MKDIR) -p $(GUIDE-RESULT)
 	$(CP) $(GUIDE)/resources/$(STYLESHEET) $(GUIDE-RESULT)/$(STYLESHEET)
@@ -57,6 +58,10 @@
 	$(XSLTPROC) --xinclude $(STRINGPARAMS) --output $(GUIDE-RESULT)/index.html \
 	    $(GUIDE-XSL) $(GUIDE-SRC)/guide.xml
 
+# Generate the man pages using DocBook from the xml source in $(MAN-SRC).
+# The portfile-*.xml files in $(GUIDE-SRC) are copied to $(MAN-TMP) and
+# modified (section -> refsection) so they can be used as man xml source files
+# and then xincluded in the real man xml files in $(MAN-SRC).
 man:
 	$(MKDIR) -p $(MAN-RESULT)
 	$(MKDIR) -p $(MAN-TMP)
@@ -70,6 +75,7 @@
 	    $(MAN-SRC)/porthier.7.xml
 	$(RM) -r $(MAN-TMP)
 
+# Remove all temporary files generated by guide: and man:.
 clean:
 	$(RM) -rf $(GUIDE-RESULT)
 	$(RM) -rf $(MAN-RESULT)

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20080113/6cee29a6/attachment.html