The initial goal was to make sure we don't have overall FORCE rules causing
unnecessary rebuilds -- annoying while writing documentation. As I looked
through possible dependencies, I finally understood what's going on here.
Remove code dup and nicely sort which belongs where in build/Makefile.*.inc. In
each, describe in a top comment how to use it, and also unify how they are
used:
- Rename Makefile.inc to Makefile.docbook.inc and refactor
- Add Makefile.vty-reference.inc
- Add Makefile.common.inc
Make sure that we accurately pick up all dependencies.
Drop use of the macro called 'command', that silenced the actual command lines
invoked and replaced them with short strings: it obscures what is actually
going on and makes the Makefiles hard to read and understand.
Each manual's makefile is greatly reduced to few definitions and a Makefile
include, e.g. one for asciidoc, one for VTY reference.
Move common/bsc_vty_additions.xml to OsmoBSC/vty/libbsc_vty_additions.xml, link
from OsmoNITB. It applies only to OsmoBSC and OsmoNITB.
Add a script that combines a VTY reference file with *all* additions files
found in a manual's vty/ dir. Call this from Makefile.vty-reference.inc.
Change-Id: I9758e04162a480e28c7dc83475b514cf7fd25ec0
Otherwise long doc titles (top left) run on top of release and date
making it impossible to read any of them correctly.
Change-Id: I685a981a5cfd82214d1d654aa1553a844c2af157
Unconditionally show a 'DRAFT' watermark only on the first page of each
document.
I would have liked to make this conditional based on the BUILD_RELEASE=*
variable, but could not figure out how to switch off a .sty code segment based
on command line parameters.
Since we only seem to render all manuals in DRAFT mode all the time, it seems
reasonable to include the DRAFT watermark always, requiring manual .sty editing
if anyone wanted to build a non-DRAFT version.
In the makefile, add an echo to say so in case of non-draft builds.
Change-Id: Ia71795481c2467aab11ab344517df74775b2a852
The 'DRAFT' watermark in the page background is a hindrance when trying to
copy-paste text from the rendered PDFs. It segments the texts so that many code
lines cannot be marked in whole to copy.
So drop the watermark and instead just show 'DRAFT' in the page header.
Change-Id: Ie22cdddf46bf7640e7f027940a6db904bf639142
This is only used to output warnings in case the a2x build failed.
Use ASCIIDOC_OPTS instead of repeating the same options (with one missing)
and add verbose output by asciidoc.
Change-Id: I6135ba1a3e46610eea6089e2218f1024c49054be
Generate *.check files from asciidoc output and grep for WARNINGs.
Add *.check files to gitignore and to 'make clean'.
Change-Id: Ibccc83a3415930a528f2e8e4e4dda3b81c6d0b64
On FreeBSD, the 'date' command's -d option has a completely different meaning.
Instead, use a small python script to do the date format conversion, which
should be more portable.
As a side effect, we now also use UTC instead of the build server's timezone,
which may be considered a more international choice.
Add build/unix-time-to-fmt.py, call in build/Makefile.asciidoc.inc.
Change-Id: I91a40656184f553ee375216d8ba5c7788fe9990d
By using the same name for the config it overwrite the one used
by the mscgen plugin. Let's avoid this and switch from svg to png
as well as the docbook classification doesn't seem to work.
The CI does not generate(?) or include the svg files in the PDF. It
is not clear why that is done if something is missing from mscgen or
from asciidoc or something else is wrong. Let's try once with the PNG
output.
This is a bit awkward, as the 'revnumber' asciidoc variable so far
doesn't seem to end up in the docbook-xml. We now put it into
'releaseinfo' which gets then put into \DBKreleeaseinfo by dblatex.
makefile watermark fixup
The manuals existed in different form for several years in an internal
sysmocom repository. However, since they had just recently been
converted from docboox-xml to asciidoc and all files have been
re-shuffled for enabling the public release, there's not much point in
keeping the history with git-filter-branch.
Neels Hofmeyr
Pau Espin
Neels Hofmeyr
Harald Welte