[Gzz-commits] navidoc Makefile TODO-navidoc

[Asko Soukka]

CVSROOT:        /cvsroot/navidoc
Module name:    navidoc
Changes by:     Asko Soukka <address@hidden>    03/04/25 04:25:34

Modified files:
        .              : Makefile TODO-navidoc 

Log message:
        twid

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/navidoc/navidoc/Makefile.diff?tr1=1.13&tr2=1.14&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/navidoc/navidoc/TODO-navidoc.diff?tr1=1.6&tr2=1.7&r1=text&r2=text

Patches:
Index: navidoc/Makefile
diff -u navidoc/Makefile:1.13 navidoc/Makefile:1.14
--- navidoc/Makefile:1.13       Thu Apr 24 07:00:32 2003
+++ navidoc/Makefile    Fri Apr 25 04:25:33 2003
@@ -1,12 +1,45 @@
-#$Id: Makefile,v 1.13 2003/04/24 11:00:32 humppake Exp $
+#$Id: Makefile,v 1.14 2003/04/25 08:25:33 humppake Exp $
+
+all: java docs navilink
+
+docs:
+       make html RST="doc/"
+
+pegs:
+       make html RST="doc/pegboard/"
+
+navilink:
+       make navilink RST="doc/"
+
+clean:
+       @echo "Removing everything found in .cvsignores"
+       find . -name ".cvsignore"|while read ign; do (cd `dirname $$ign` && cat 
.cvsignore|while read files; do rm -Rf $$files; done); done
+       find . -name "*.pyc" | xargs rm -f
+       find . -name "*.class" | xargs rm -f
+       rm -rf CLASSES
 
-all: java doc pegs
 
 ##########################################################################
+# Defining variables
+NAVIDOC_DEPENDS = ../navidoc-depends
 CLASSPATH =$(NAVIDOC_DEPENDS)/jython.jar:$(shell echo $$CLASSPATH)
+JVMFLAGS= -Xms64M -Xmx128M # -Xincgc
+CLASSDIR=CLASSES/
+
 export CLASSPATH
 
-JVMFLAGS= -Xms64M -Xmx128M # -Xincgc
+ifeq (,$(JYTHONPATH))  
+ 
JYTHONPATH=.:$(NAVIDOC_DEPENDS)/jythonlib.jar:$(NAVIDOC_DEPENDS)/pythonlib.jar:$(NAVIDOC_DEPENDS)/docutils.jar
+endif
+
+ifeq (,$(PYTHON))
+ PYTHON=/usr/bin/python
+endif
+
+ifeq (,$(JYTHON))
+# python.verbose can be: "error", "warning", "message", "comment", "debug"
+ JYTHON=$(JAVA) $(JVMFLAGS) -Dpython.cachedir=. -Dpython.path=$(JYTHONPATH) 
-Dpython.verbose=message $(EDITOR_OPTION) org.python.util.jython
+endif
 
 ifeq (,$(JAVA))
  JAVA=java
@@ -16,50 +49,33 @@
  JAVAC=javac
 endif
 
-CLASSDIR=CLASSES/
-
 ifneq (,$(EDITOR))
        EDITOR_OPTION=-Duser.editor=$(EDITOR)
 else
        EDITOR_OPTION=
 endif
 
-ifeq (,$(JYTHONPATH))  
- 
JYTHONPATH=.:$(NAVIDOC_DEPENDS)/jythonlib.jar:$(NAVIDOC_DEPENDS)/pythonlib.jar:$(NAVIDOC_DEPENDS)/docutils.jar
-endif
-
-ifeq (,$(JYTHON))
-# python.verbose can be: "error", "warning", "message", "comment", "debug"
- JYTHON=$(JAVA) $(JVMFLAGS) -Dpython.cachedir=. -Dpython.path=$(JYTHONPATH) 
-Dpython.verbose=message $(EDITOR_OPTION) org.python.util.jython
-endif
 ##########################################################################
-
-NAVIDOC_DEPENDS = ../navidoc-depends
-
+# General
 java:
        mkdir -p $(CLASSDIR)
        $(JAVAC) -g -d $(CLASSDIR) `find org -name '*.java'`
 
-clean:
-       @echo "Removing everything found in .cvsignores"
-       find . -name ".cvsignore"|while read ign; do (cd `dirname $$ign` && cat 
.cvsignore|while read files; do rm -Rf $$files; done); done
-       find . -name "*.pyc" | xargs rm -f
-       find . -name "*.class" | xargs rm -f
+##########################################################################
+# Navidoc targets
+peg: # Creates new PEG, uses python for quick use
+       $(PYTHON) newpeg.py $(PEGDIR)
+html: # converts ReST to HTML, directories are processed recursively
+       $(JYTHON) rst2any.py --html -d navidoc -d docutils -d pegboard -d 
pegboard.fail -d mp.fail $(DBG) $(RST)
 
-html:
-       $(JYTHON) rst2any.py --html --imagemap -d navidoc -d docutils -d 
pegboard -d pegboard.fail -d mp.fail $(DBG) $(RST)
+html-loop: # Loop version for quick recompiling
+       $(JYTHON) rst2any.py --loop --html -d navidoc -d docutils -d pegboard 
-d pegboard.fail -d mp.fail $(DBG) $(RST)
 
-html-loop:
-       $(JYTHON) rst2any.py --loop --html --imagemap -d navidoc -d docutils -d 
pegboard -d pegboard.fail -d mp.fail $(DBG) $(RST)
+navilink: # Bi-directional linking using imagemaps
+       $(JYTHON) rst2any.py --imagemap -d navidoc -d mp.fail $(DBG) $(RST)
 
-latex:
+latex: # converts ReST to LaTeX, directories are processed recursively
        $(JYTHON) rst2any.py --latex -d navidoc -d docutils $(DBG) $(RST)
 
-latex-loop:
-       $(JYTHON) rst2any.py --loop --latex -d navidoc -d docutils $(DBG) $(RST)
-
-docs:
-       make html RST="doc/"
-
-pegs:
-       make html RST="doc/pegboard/"
+latex-loop: # Loop version for quick recompiling
+       $(JYTHON) rst2any.py --loop --latex -d navidoc -d docutils $(DBG) $(RST)
\ No newline at end of file
Index: navidoc/TODO-navidoc
diff -u navidoc/TODO-navidoc:1.6 navidoc/TODO-navidoc:1.7
--- navidoc/TODO-navidoc:1.6    Thu Apr 24 03:48:04 2003
+++ navidoc/TODO-navidoc        Fri Apr 25 04:25:33 2003
@@ -1,88 +1,86 @@
+=================
 Tasks for navidoc
+=================
 
 0.1alpha1: First separate release    
-    humppake:
-       - move old UML-stuff to navidoc
-    anybody:
-       - util to create new peg
-          - creates directory
-          - add formal header
-          - probaly also template with recommended sectinos
-         - creates a proper .cvsignore
-        - make pegboard run with cpython, could be tested
-          with i.e. "./rst2any --html doc/"
-        - ".gen." midfix to be optional:
-           + replacing ".gen" with global attribute
-           + replacing some foo[a:b] with foo[a:len(midfix)+c]
+=================================
+
+humppake:
+  - documenting, tests
+  - ".gen." midfix to be optional:
+    + replacing ".gen" with global attribute
+    + replacing some foo[a:b] with foo[a:len(midfix)+c]
+
+anybody:
+  - make pegboard run with cpython, could be tested
+    with i.e. "./rst2any --html doc/"
           
-0.2alpha1: Rewriting
-    anybody:
-       Design issues
-       -------------
-           
-        - plugin issues
-         - make sure that umltool works also with pure doccxx
-         - nested classes in javadoc: grep for MipzipLoader.Level 
-         - Currently diagrams are embedded into html-documents after
-            the first header-tag. This could be enough for javadoc and
-            other, but in reST this should be possible to overdrive by
-            own directive.
-         - unit test plugin
-        - directive issues
-         - diagram names should be unique, currently this can't be
-            easily tested, make something for it
-          + Highlighting should be optional. This should be in UML source,
-            but it could also be added there from an optin of UML directive.
-            Anyway, implementing is not trivial, since even the same png
-            diagram could be used in all documents, the imagemap should 
-            always be regenerated. So, two points:
-            - all refers to the same diagram should use the same png
-            - still every document needs own imagemap
-            - there should be no highlighting
-
-        UML language
-       ------------
-
-       - fix umltool graphics to be closer to the UML 3amigos books
-       - Fix UML sequence diagram: now you have to put
-         seqobjects *after* the sequence...
-       - fix dep directive to be 
-           dep BuoyViewNode "calls" BuoyLinkListener
-         instead of
-           dep "calls" BuoyViewNode BuoyLinkListener
-         currently.
-          Involves fixing many diagrams!
-          Reason: then can use in class:
-           class BuoyViewNode
-               dep "calls" BuoyLinkListener
-         because inside class, the class is given as the 1st argument.
-
-       - rationalize doc directory structure:
-          !! Depends on pegboard upgrade for simply compiling of 
-             deep tree structure !!
-         Gzz_Frontend_View.rst -> doc/frontend/View.rst
-         (i.e. no Gzz_ prefixes, tree structure explicit)
-
-        docutils latex writer
-       ---------------------
-       - cleanup
-       - strip all unnecessaries, if there's any
-          - latex output should be as clean and readable as possible
-          - should not have dependecy for unnecessary latex packages
-       - collect comments and experiences of using when
-          writing the article
-       - summarize, what have been changed to the original latex writer
+0.2alpha1:
+==========
+
+Design Issues
+-------------
+
+  - plugin issues
+    + make sure that umltool works also with pure doccxx
+    + nested classes in javadoc: grep for MipzipLoader.Level 
+    + Currently diagrams are embedded into html-documents after
+      the first header-tag. This could be enough for javadoc and
+      other, but in reST this should be possible to overdrive by
+      own directive.
+    + unit test plugin
+
+  - directive issues
+    + diagram names should be unique, currently this can't be
+      easily tested, make something for it
+
+UML language
+------------
+
+  - fix umltool graphics to be closer to the UML 3amigos books
+  - Fix UML sequence diagram: now you have to put
+    seqobjects *after* the sequence...
+  - fix dep directive to be::
+
+       dep BuoyViewNode "calls" BuoyLinkListener
+
+       instead of 
+
+       dep "calls" BuoyViewNode BuoyLinkListener
+     
+       currently.
+     
+       Involves fixing many diagrams!
+       Reason: then can use in class:
+
+       class BuoyViewNode
+         dep "calls" BuoyLinkListener
+
+       because inside class, the class is given as the 1st argument.
+
+Docutils latex writer
+---------------------
+
+  - cleanup
+  - strip all unnecessaries, if there's any
+    + latex output should be as clean and readable as possible
+    + should not have dependecy for unnecessary latex packages
+    + collect comments and experiences of using when
+      writing the article
+    + summarize, what have been changed to the original latex writer
 
 1.0: Feature-complete
-    anybody:
-       - all UML diagrams in UML reference manual
-         and user's guide should be easy to do
-       - reimplement uml.py completely, or standardize on another
-         UML tool; required features:
-           - supports qualifiers, n-ary associations,
-             class and sequence diagrams
-           - supports arbitrary drawing on the diagrams
-           - fast and easy to use and libre
-       - figure out metapost tfm files; we need to have Helvetica.tfm
-         since we want to use the postscript font names to get standalone
-         files. But it would be nice not to have it in every directory ;)
+=====================
+
+anybody:
+  - all UML diagrams in UML reference manual
+    and user's guide should be easy to do
+  - reimplement uml.py completely, or standardize on another
+    UML tool; required features:
+    + supports qualifiers, n-ary associations,
+      class and sequence diagrams
+    + supports arbitrary drawing on the diagrams
+    + fast and easy to use and libre
+  - figure out metapost tfm files; we need to have Helvetica.tfm
+    since we want to use the postscript font names to get standalone
+    files. But it would be nice not to have it in every directory ;)