From: Friedrich Beckmann <friedrich.beckmann@gmx.de>
Date: Fri, 12 Jun 2020 15:07:27 +0000 (+0200)
Subject: doc: added prepdoc.sh script for simple working on documentation
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ed546e6d8073f2b5e0c9acfd935cf7c6921d0c0a;p=pspp

doc: added prepdoc.sh script for simple working on documentation

I added the prepdoc.sh script to allow to work on the documentation
without having the full build environment. You can just checkout
from git and then run

  cd pspp/doc
  ./prepdoc.sh
  makeinfo --html pspp.texi
  open ./pspp/index.html

Maybe it is then easier for contributors to work on the documentation
without having to run Smake and configure with all the required
packages. prepdoc.sh will generate some dummy required texi files
which are normally generated during the build process.
---

diff --git a/doc/automake.mk b/doc/automake.mk
index 3daa2cc0be..e02f1f4c68 100644
--- a/doc/automake.mk
+++ b/doc/automake.mk
@@ -65,7 +65,9 @@ doc_pspp_dev_TEXINFOS = doc/version-dev.texi \
 dist_man_MANS += doc/pspp.1 \
                  doc/psppire.1
 
-EXTRA_DIST += doc/get-commands.pl doc/help-pages-list
+EXTRA_DIST += doc/get-commands.pl \
+              doc/help-pages-list \
+              doc/prepdoc.sh
 
 $(srcdir)/doc/ni.texi: $(top_srcdir)/src/language/command.def doc/get-commands.pl
 	@$(MKDIR_P)  doc
diff --git a/doc/prepdoc.sh b/doc/prepdoc.sh
new file mode 100755
index 0000000000..447c6a264c
--- /dev/null
+++ b/doc/prepdoc.sh
@@ -0,0 +1,40 @@
+#! /bin/bash -x
+
+# This is a short preparation script to create dummy
+# files for running makeinfo if you want to work on
+# the documentation without having a full build environment
+# for pspp.
+# You need to have makeinfo available on the shell which
+# is provided by the texinfo package.
+# Then you can create the html version of the documentation
+# with:
+#
+# makeinfo --html pspp.texi
+#
+# This will create all hmtl files in the new directory pspp.
+#
+# Then you can view the documentation with:
+#
+# open pspp/index.html
+#
+# That will open your webbrowser and you can see the documentation
+
+## Here are the three texi files which are normally generated during
+## the build process.
+
+# Create version.texi
+echo "@set UPDATED 13 April 2020" > version.texi
+echo "@set UPDATED-MONTH April 2020" >> version.texi
+echo "@set EDITION 1.3.0-g90731b37a" >> version.texi
+echo "@set VERSION 1.3.0-g90731b37a" >> version.texi
+
+#Create tut.texi
+echo "@set example-dir ../../examples" > tut.texi
+
+#Create ni.texi
+echo "@table @asis" > ni.texi
+echo "@item @cmd{2SLS}" >> ni.texi
+echo "This is just an example for missing items." >> ni.texi
+echo "@end table" >> ni.texi
+
+