Added build target doc and doc-install to generate and install user documentation
authorJan Vrany <jan.vrany@fit.cvut.cz>
Thu, 18 Jun 2015 07:27:26 +0100
changeset 3455 bb9941d9d7be
parent 3454 960d44abd6de
child 3456 8a317143d5a9
Added build target doc and doc-install to generate and install user documentation These targets are not run by default. They are intended being run before a distribution archive is created. THey require Docbook and XSLT processor being installed in standard places.
Make.proto
Make.spec
abbrev.stc
bc.mak
bmake.bat
docs/user/Makefile
docs/user/bc.mak
stx_libjava.st
--- a/Make.proto	Wed Jun 17 07:52:01 2015 +0100
+++ b/Make.proto	Thu Jun 18 07:27:26 2015 +0100
@@ -66,6 +66,15 @@
 pre_objs::  zlib support/fdlibm/libfdm.a antIfPossible 
 
 
+doc:
+	$(MAKE) -C docs/user html
+
+doc-install:
+	$(MAKE) -C docs/user html-install
+
+clean::
+	$(MAKE) -C docs/user clean    
+
 java: ant
 
 ant:
@@ -148,7 +157,7 @@
 
 
 # build all packages containing referenced classes for this package
-# they are nor needed to compile the package
+# they are not needed to compile the package (but later, to load it)
 references:
 
 
@@ -205,7 +214,6 @@
 $(OUTDIR)JavaNioSupport.$(O) JavaNioSupport.$(H): JavaNioSupport.st $(INCLUDE_TOP)/stx/libbasic/Object.$(H) $(STCHDR)
 $(OUTDIR)JavaObject.$(O) JavaObject.$(H): JavaObject.st $(INCLUDE_TOP)/stx/libbasic/Object.$(H) $(STCHDR)
 $(OUTDIR)JavaObjectDictionary.$(O) JavaObjectDictionary.$(H): JavaObjectDictionary.st $(INCLUDE_TOP)/stx/libbasic/Object.$(H) $(STCHDR)
-$(OUTDIR)JavaPackage.$(O) JavaPackage.$(H): JavaPackage.st $(INCLUDE_TOP)/stx/libbasic/NameSpace.$(H) $(INCLUDE_TOP)/stx/libbasic/Object.$(H) $(STCHDR)
 $(OUTDIR)JavaPopUpView.$(O) JavaPopUpView.$(H): JavaPopUpView.st $(INCLUDE_TOP)/stx/libbasic/Object.$(H) $(INCLUDE_TOP)/stx/libview/DisplaySurface.$(H) $(INCLUDE_TOP)/stx/libview/GraphicsMedium.$(H) $(INCLUDE_TOP)/stx/libview/PopUpView.$(H) $(INCLUDE_TOP)/stx/libview/SimpleView.$(H) $(INCLUDE_TOP)/stx/libview/TopView.$(H) $(INCLUDE_TOP)/stx/libview/View.$(H) $(STCHDR)
 $(OUTDIR)JavaProcess.$(O) JavaProcess.$(H): JavaProcess.st $(INCLUDE_TOP)/stx/libbasic/Link.$(H) $(INCLUDE_TOP)/stx/libbasic/Object.$(H) $(INCLUDE_TOP)/stx/libbasic/Process.$(H) $(STCHDR)
 $(OUTDIR)JavaRef2.$(O) JavaRef2.$(H): JavaRef2.st $(INCLUDE_TOP)/stx/libbasic/Object.$(H) $(STCHDR)
--- a/Make.spec	Wed Jun 17 07:52:01 2015 +0100
+++ b/Make.spec	Thu Jun 18 07:27:26 2015 +0100
@@ -42,6 +42,7 @@
 #  -warnNonStandard : no warnings about ST/X extensions
 #  -warnEOLComments : no warnings about EOL comment extension
 #  -warnPrivacy     : no warnings about privateClass extension
+#  -warnUnused      : no warnings about unused variables
 #
 # ********** OPTIONAL: MODIFY the next line(s) ***
 # STCWARNINGS=-warn
--- a/abbrev.stc	Wed Jun 17 07:52:01 2015 +0100
+++ b/abbrev.stc	Thu Jun 18 07:27:26 2015 +0100
@@ -44,7 +44,6 @@
 JavaNioSupport JavaNioSupport stx:libjava 'Languages-Java-Support-Native' 0
 JavaObject JavaObject stx:libjava 'Languages-Java-Classes' 0
 JavaObjectDictionary JavaObjectDictionary stx:libjava 'Languages-Java-Support' 0
-JavaPackage JavaPackage stx:libjava 'Languages-Java-Support' 0
 JavaPopUpView JavaPopUpView stx:libjava 'Languages-Java-Views-Support' 2
 JavaProcess JavaProcess stx:libjava 'Languages-Java-Classes' 0
 JavaRef2 JavaRef2 stx:libjava 'Languages-Java-Reader-Support-new' 0
--- a/bc.mak	Wed Jun 17 07:52:01 2015 +0100
+++ b/bc.mak	Thu Jun 18 07:27:26 2015 +0100
@@ -30,6 +30,7 @@
 !INCLUDE Make.spec
 
 LIBNAME=libstx_libjava
+MODULE_PATH=libjava
 RESFILES=libjava.$(RES)
 
 
@@ -58,6 +59,16 @@
 
 
 
+doc:
+	pushd docs\user & $(MAKE_BAT) html
+
+doc-install:
+	pushd docs\user & $(MAKE_BAT) html-install
+
+
+clean::
+	pushd docs\user & $(MAKE_BAT) clean
+
 java: ant
 
 ant:
@@ -138,7 +149,6 @@
 $(OUTDIR)JavaNioSupport.$(O) JavaNioSupport.$(H): JavaNioSupport.st $(INCLUDE_TOP)\stx\libbasic\Object.$(H) $(STCHDR)
 $(OUTDIR)JavaObject.$(O) JavaObject.$(H): JavaObject.st $(INCLUDE_TOP)\stx\libbasic\Object.$(H) $(STCHDR)
 $(OUTDIR)JavaObjectDictionary.$(O) JavaObjectDictionary.$(H): JavaObjectDictionary.st $(INCLUDE_TOP)\stx\libbasic\Object.$(H) $(STCHDR)
-$(OUTDIR)JavaPackage.$(O) JavaPackage.$(H): JavaPackage.st $(INCLUDE_TOP)\stx\libbasic\NameSpace.$(H) $(INCLUDE_TOP)\stx\libbasic\Object.$(H) $(STCHDR)
 $(OUTDIR)JavaPopUpView.$(O) JavaPopUpView.$(H): JavaPopUpView.st $(INCLUDE_TOP)\stx\libbasic\Object.$(H) $(INCLUDE_TOP)\stx\libview\DisplaySurface.$(H) $(INCLUDE_TOP)\stx\libview\GraphicsMedium.$(H) $(INCLUDE_TOP)\stx\libview\PopUpView.$(H) $(INCLUDE_TOP)\stx\libview\SimpleView.$(H) $(INCLUDE_TOP)\stx\libview\TopView.$(H) $(INCLUDE_TOP)\stx\libview\View.$(H) $(STCHDR)
 $(OUTDIR)JavaProcess.$(O) JavaProcess.$(H): JavaProcess.st $(INCLUDE_TOP)\stx\libbasic\Link.$(H) $(INCLUDE_TOP)\stx\libbasic\Object.$(H) $(INCLUDE_TOP)\stx\libbasic\Process.$(H) $(STCHDR)
 $(OUTDIR)JavaRef2.$(O) JavaRef2.$(H): JavaRef2.st $(INCLUDE_TOP)\stx\libbasic\Object.$(H) $(STCHDR)
--- a/bmake.bat	Wed Jun 17 07:52:01 2015 +0100
+++ b/bmake.bat	Thu Jun 18 07:27:26 2015 +0100
@@ -12,15 +12,15 @@
 @echo "***********************************"
 @echo "Buildung stx/libjava/experiments
 @echo "***********************************"
-@cd experiments
-@call bmake %1 %2
-@cd ..
+@pushd experiments
+@call bmake %1 %2 || exit /b "%errorlevel%"
+@popd
 
 @echo "***********************************"
 @echo "Buildung stx/libjava/tools
 @echo "***********************************"
-@cd tools
-@call bmake %1 %2
-@cd ..
+@pushd tools
+@call bmake %1 %2 || exit /b "%errorlevel%"
+@popd
 
 
--- a/docs/user/Makefile	Wed Jun 17 07:52:01 2015 +0100
+++ b/docs/user/Makefile	Thu Jun 18 07:27:26 2015 +0100
@@ -25,7 +25,7 @@
 PDF_STYLE=styles/latex.xsl
 
 # A directory where to install HTML help
-HELP_DIR=../../../doc/online/english/help/HG
+HELP_DIR=../../../doc/online/english/programming
 
 default: html
 
--- a/docs/user/bc.mak	Wed Jun 17 07:52:01 2015 +0100
+++ b/docs/user/bc.mak	Thu Jun 18 07:27:26 2015 +0100
@@ -26,7 +26,7 @@
 PDF_STYLE=styles/latex.xsl
 
 # A directory where to install HTML help
-HELP_DIR=..\..\..\doc\online\english\help\HG
+HELP_DIR=..\..\..\doc\online\english\programming
 
 default: html
 
--- a/stx_libjava.st	Wed Jun 17 07:52:01 2015 +0100
+++ b/stx_libjava.st	Thu Jun 18 07:27:26 2015 +0100
@@ -221,14 +221,14 @@
 additionalRules_bc_dot_mak
     ^ '
 doc:
-        pushd docs & $(MAKE_BAT) html
+        pushd docs\user & $(MAKE_BAT) html
 
 doc-install:
-        pushd docs & $(MAKE_BAT) html-install
+        pushd docs\user & $(MAKE_BAT) html-install
 
 
 clean::
-        pushd docs & $(MAKE_BAT) clean
+        pushd docs\user & $(MAKE_BAT) clean
 
 
 java: ant
@@ -263,6 +263,16 @@
 
 additionalRules_make_dot_proto
     ^ '
+doc:
+        $(MAKE) -C docs/user html
+
+doc-install:
+        $(MAKE) -C docs/user html-install
+
+clean::
+        $(MAKE) -C docs/user clean    
+                                   
+                                       
 java: ant
 
 ant: