some documentation-related changes

add a command-line pdf option to Makefile for use in CI.
fix .tex file errors.

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
index bced5bba9a9eb2f0b06b9b30571c9e3a1aa7faa1..eaa5205006c41e91eb17b1f40a7114abde60549f 100644 (file)
--- a/azure-pipelines.yml
+++ b/azure-pipelines.yml
@@ -24,12 +24,6 @@ strategy:
       imageName: 'ubuntu-18.04'
       toolchainName: gcc7
       buildTargetName: all
-# build is currently broken
-#    mac_catalina_gcc8_all:
-#      imageName: 'macOS-10.15'
-#      ccName: gcc-8
-#      cxxName: g++-8
-#      buildSetting: 'all'
     macOS_catalina_clang_all:
       imageName: 'macOS-10.15'
       toolchainName: clang
@@ -43,7 +37,7 @@ strategy:
       toolchainName: clang
       buildTargetName: all
     windows-visualstudio:
-      imageName: 'windows-2019'
+      imageName: 'windows-latest'
       toolchainName: vs
       buildTargetName: all
     windows-mingw:
@@ -54,6 +48,10 @@ strategy:
       imageName: 'ubuntu-20.04'
       toolchainName: cross
       buildTargetName: msdos
+    linux_jammy_docs:
+      imageName: 'ubuntu-22.04'
+      toolchainName: docs
+      buildTargetName: all
 
 pool:
   vmImage: $(imageName)
@@ -249,3 +247,12 @@ steps:
   condition: and(eq( variables['Agent.OS'], 'Linux' ), eq( variables.toolchain, 'cross'))
   workingDirectory: $(Agent.BuildDirectory)/$(netHackPath)
   displayName: 'Building MSDOS build'
+- bash: |
+    sudo apt-get install texlive
+    make Guidebook
+    make Guidebook.txt
+    pdflatex -interaction=nonstopmode -jobname=Guidebook Guidebook.dated.tex
+    pdflatex -interaction=nonstopmode -jobname=Guidebook Guidebook.dated.tex
+  condition: and(eq( variables['Agent.OS'], 'Linux' ), eq( variables.toolchain, 'docs'))
+  workingDirectory: $(Agent.BuildDirectory)/$(netHackPath)
+  displayName: 'Building NetHack documentation'

diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex
index 9c09495d352b914d85c92ceb028965e8e46ddbdd..c745853c2c874f7eca9eb0eb93a945b697994d17 100644 (file)
--- a/doc/Guidebook.tex
+++ b/doc/Guidebook.tex
@@ -577,7 +577,7 @@ A boulder or statue.
 \item[\tb{0}]
 An iron ball.
 %.lp
-\item[\tb{_}]
+\item[\tb{\verb+_+}]
 An altar, or an iron chain.
 %.lp
 \item[\tb{\{}]
@@ -776,7 +776,7 @@ down like <Shift> while typing and releasing <key>, then releasing <Control>.
 Control characters are case-insensitive so {\tt \^{}x} and {\tt \^{}X}
 are the same.
 %.lp
-\item[\tb(M<direction>}]
+\item[\tb{M<direction>}]
 Old versions supported `{\tt M}' as a movement prefix which
 combined the effect of `{\tt m}' with {\tt <Control>}+<direction>.
 That is no longer supported as a prefix but similar effect can be achieved
@@ -784,7 +784,7 @@ by using {\tt m} and {\tt G}+<direction> in combination.
 {\tt m} can also be used in combination with {\tt g}+<direction>,
 {\tt <Control>}+<direction>, or {\tt <Shift>}+<direction>.
 %.lp
-\item[\tb{_}]
+\item[\tb{\tt \verb+_+}]
 Travel to a map location via a shortest-path algorithm.\\
 %.lp ""
 The shortest path
@@ -1230,7 +1230,7 @@ May be preceded by `{\tt m}' to select preferred display order.
 %.lp
 \item[\tb{|}]
 If persistent inventory display is supported and enabled (with the
-{\it perm_invent\/}
+{\it perm\verb+_+invent\/}
 option), interact with it instead of with the map.
 \\
 %.lp ""
@@ -1238,7 +1238,7 @@ Allows scrolling with the
 menu\verb+_+first\verb+_+page, menu\verb+_+previous\verb+_+page,
 menu\verb+_+next\verb+_+page, and menu\verb+_+last\verb+_+page
 keys (`{\tt \^{}}', `{\tt <}', `{\tt >}', `{\tt \verb+|+}' by default).
-Some interfaces also support menu_shift_left and menu_shift_right
+Some interfaces also support menu\verb+_+shift\verb+_+left and menu\verb+_+shift\verb+_+right
 keys (`{\tt \verb+{+}' and `{\tt \verb+}+}' by default).
 Use the {\it Return\/} (aka {\it Enter\/}) or {\it Escape\/} key to
 resume play.
@@ -1597,7 +1597,7 @@ Default key is `{\tt m}'.
 %.lp
 \item[\tb{\#retravel}]
 Travel to a previously selected travel destination.
-Default key is `{\tt C-_}'.
+Default key is `{\tt C-\verb+_+}'.
 See also {\tt \#travel}.
 %.lp
 \item[\tb{\#ride}]
@@ -2905,7 +2905,7 @@ weapons or having one of them be stolen or destroyed will also make you
 revert to single-weapon combat.
 
 %.hn 2
-\subsection*{Armor (`{\tt [}')}
+\subsection*{Armor (`{\tt \verb+[+}')}
 
 %.pg
 Lots of unfriendly things lurk about; you need armor to protect
@@ -3667,8 +3667,8 @@ Any line in the configuration file starting with `{\tt \#}' is treated
 as a comment and ignored.
 Empty lines are ignored.
 
-Any line beginning with `{\tt [}' and ending in `{\tt ]}'
-is a section marker (the closing `{\tt ]}' can be followed
+Any line beginning with `{\tt \verb+[+}' and ending in `{\tt \verb+]+}'
+is a section marker (the closing `{\tt \verb+]+}' can be followed
 by whitespace and then an arbitrary comment beginning with `{\tt \#}').
 The text between the square brackets is the section name.
 Section markers are only valid after a CHOOSE directive and their names
@@ -6137,7 +6137,7 @@ character sequences and explicit 24-bit red-green-blue colors in order for the g
 representation to be visible as specified.
 
 For example, the following line in your configuration file will cause
-the glyph representation for glyphid G_pool to use Unicode codepoint U+224B
+the glyph representation for glyphid G\verb+_+pool to use Unicode codepoint U+224B
 and the color represented by R-G-B value 0-0-160:\\
 \begin{verbatim}
 OPTIONS=glyph:G_pool/U+224B/0-0-160

diff --git a/sys/unix/Makefile.doc b/sys/unix/Makefile.doc
index aa1006d41d6a43823026a8a4d48636ab21bf944f..a2f09094f4eafd932233c4ed00872f0a6f2b7bb5 100644 (file)
--- a/sys/unix/Makefile.doc
+++ b/sys/unix/Makefile.doc
@@ -128,7 +128,8 @@ clean:
        -rm -f Guidebook.aux Guidebook.log $(DOC_EXTRAS)
 
 spotless: clean
-       -rm -f Guidebook Guidebook.dat Guidebook.ps Guidebook.dvi
+       -rm -f Guidebook Guidebook.dat Guidebook.ps \
+               Guidebook.dvi $(DOC_SPOTLESS_EXTRAS)
 
 maintainer-clean: spotless
        -rm -f $(DISTRIB)

diff --git a/sys/unix/Makefile.top b/sys/unix/Makefile.top
index e64b8718f6dcad32edea1e286ad6bce2876b8aa6..7831606431e0bfe0fbc42c504e7c70e6ca066a33 100644 (file)
--- a/sys/unix/Makefile.top
+++ b/sys/unix/Makefile.top
@@ -157,6 +157,9 @@ Guidebook:
 Guidebook.txt:
        ( cd doc ; $(MAKE) Guidebook.txt )
 
+Guidebook.pdf:
+       ( cd doc ; $(MAKE) Guidebook.pdf )
+
 manpages:
        ( cd doc ; $(MAKE) manpages )
 

diff --git a/sys/unix/hints/include/gbdates-post.370 b/sys/unix/hints/include/gbdates-post.370
index c606076f3abc6eb8447dff1ed8faf230cfc53035..a736e30f9a7cfed52437f190439997369b049e59 100755 (executable)
--- a/sys/unix/hints/include/gbdates-post.370
+++ b/sys/unix/hints/include/gbdates-post.370
@@ -6,5 +6,9 @@ Guidebook.dated.mn: $(GUIDEBOOK_MN_SRC)
 Guidebook.dated.tex: $(GUIDEBOOK_TEX_SRC)
        @awk 'f{$$0="\\date{$(GB_DATESTAMP)}";f=0}/NH_DATESUB/{f=1} 1' < $(GUIDEBOOK_TEX_SRC) > $@
 endif   # GB_DATESTAMP
+
+Guidebook.pdf: Guidebook.dated.tex
+       pdflatex -interaction=nonstopmode -jobname=Guidebook Guidebook.dated.tex
+       pdflatex -interaction=nonstopmode -jobname=Guidebook Guidebook.dated.tex
 endif   # MAKEFILE_DOC
 #

diff --git a/sys/unix/hints/include/gbdates-pre.370 b/sys/unix/hints/include/gbdates-pre.370
index 4bfbfb894abfd972c8828c2928b7f79c93638d1c..a9420cd6bd515465a0cd204b561949ce47e8d03b 100755 (executable)
--- a/sys/unix/hints/include/gbdates-pre.370
+++ b/sys/unix/hints/include/gbdates-pre.370
@@ -11,6 +11,7 @@ ifneq "$(GB_DATESTAMP)" ""
 DOC_EXTRAS += Guidebook.dated.mn Guidebook.dated.tex
 override GUIDEBOOK_MN = Guidebook.dated.mn
 override GUIDEBOOK_TEX = Guidebook.dated.tex
+DOC_SPOTLESS_EXTRAS += Guidebook.pdf
 endif   # GB_DATESTAMP
 endif   # GIT=0 explicitly
 endif   # MAKEFILE_DOC