Commit Graph

13 Commits

Author SHA1 Message Date
Oliver Smith 59d031823d build/Makefile.common.inc: unset OSMO_REPOSITORY
Don't have a default value for OSMO_REPOSITORY, as this leads to manuals
getting uploaded to the wrong directory (publish) target and installed
to the wrong directory (install, uninstall).

Add checks to ensure the variable is set before using it in install and
uninstall.

Related: OS#5902
Change-Id: Ie21d58dd57a893a83f566eea464ab3eec82b67a4
2023-03-07 15:54:40 +01:00
Harald Welte 2ee1a2f34d Add new common chapter about QoS, IP DSCP and IEEE 802.1q PCP
Related: SYS#5427
Change-Id: Id344c29eda2a9b3e36376302b425e9db1f6c0f28
2021-04-28 12:11:53 +02:00
Vadim Yanitskiy a137f4a47c fix tests/Makefile.am: exclude file 'mgcp_extension_osmux.adoc'
This file is included by 'osmux.adoc', so we end up including it
twice in 'test-usermanual.adoc'.  This makes xsltproc complain:

  /build/tests/test-usermanual.xml:643: element section:
    validity error : ID mgcp-extension-osmux already defined

and sometimes causes sporadic build failures.  Exclude it.

Change-Id: I00efafc822f46126b59d20e86bb07ec991768c28
Related: OS#5112
2021-04-10 04:55:24 +02:00
Oliver Smith 33d3786e1c tests: add second VTY reference
Related: OS#4292
Change-Id: I2f0170e14febc68c0122062358f362003a2e3e5e
2019-12-03 11:45:03 +01:00
Oliver Smith 7e1ab03302 tests/Makefile.am: always put glossary at the end
Make sure that glossary.adoc is the last file, when building the test
pdf with all common chapters included. Otherwise, newer asciidoc
versions will complain that we cannot have subchapters after the
glossary began:

asciidoc: ERROR: mgcp_extension_osmux.adoc: line 2: glossary section cannot contain sub-sections

Related: OS#4183
Change-Id: I91e857255b1b6d5b8708cc7f7b303a58403120d3
2019-08-30 14:15:39 +02:00
Oliver Smith c19708bf1a tests: pick up subdirs inside common/chapters
The Osmux documentation that will be introduced in [1] creates a
common/chapters/osmux/ subdir. Update tests/Makefile.am to pick up the
files in that directory too, so they get built by jenkins during gerrit
verification.

[1] I182d94c63f7d74ef882b77be59a95b1b7d8a4e5e
Change-Id: I4d1f440b7bfef159c98f918a2d23069594c4bc95
2019-07-22 19:49:16 +00:00
Oliver Smith 5501ba607b Makefile.common.inc: add {,un}install targets
Allow installing generated pdfs with 'make install' in all Osmocom
projects using osmo-gsm-manuals. This makes proper debian packaging of
the manuals easier.

Autotools will automatically run this file's install target, when
running 'make install' in the top source dir. Do not install anything,
when OSMO_GSM_MANUALS_NO_INSTALL is set, and set this variable for the
tests dir, so we don't install the test pdfs.

Related: OS#3899
Change-Id: I66f33172fa410681acbaef4592e9405627948705
2019-04-12 14:32:20 +02:00
Oliver Smith 39bbafbfd7 */Makefile.am: add EXTRA_DIST
Necessary for 'make distcheck': the files will otherwise not end up in
the dist archives.

(moving manuals to project repositories 17/19)

Related: OS#3385
Change-Id: I5a2d6e572d346addc8770d1331c9223a56635869
2018-11-21 14:37:49 +01:00
Oliver Smith e388d006f3 Osmo*/Makefile.am: use $(srcdir), $(top_srcdir)
Use $(srcdir) infront of all relative paths, which reference other
files in the repository. Use $(top_srcdir) as OSMO_GSM_MANUALS_DIR.
This is needed for out-of-tree building.

(moving manuals to project repositories 11/19)

Related: OS#3385
Change-Id: I2454d7507fae4e1c47458a1adf36f68e637f4bbc
2018-11-21 14:29:11 +01:00
Oliver Smith a3f9a1e909 *-vty-reference.xml: use ./common, not ../common
Change hardcoded ../common paths, which will break when moving the
project specific manuals in other repositories, to ./common so they
use the dynamically created symlink that always points to the right
path.

(moving manuals to project repositories 9/19)

Change-Id: I5368bcff34586c515af23e5a868417e561fd539d
2018-11-21 14:29:11 +01:00
Oliver Smith 2947683c3a use autotools to add "make install" target
For reasoning why a transition to autotools is desired, see the commit
message of the previous patch in this series.

"make install" copies the "build", "common" dirs, as well as the "*.xsl"
files to $(prefix)/share/osmo-gsm-manuals. Prefix is typically
/usr/local. Also a pkg-config file gets installed, so the path of the
shared files can be looked up by autoconf scripts of the project
repositories. The check-depends script is installed to
$(prefix)/bin/osmo-gsm-manuals-check-depends and will be used by
project specific autoconf scripts, too.

All existing make targets ("make", "make check", "make upload") are
still working, users only need to run "autoreconf -fi" and
"./configure" beforehand.

Makefile.am uses custom install-data-hook and uninstall-local targets,
so we don't need to specify each file of the relevant subdirs in a
_DATA variable (no extra maintenance effort).

(moving manuals to project repositories 5/19)

Related: OS#3385
Change-Id: I8e7036fae062ee783cb132b14608827a82c5e7c7
2018-11-21 14:29:05 +01:00
Oliver Smith dec39cdea9 s/TOPDIR/OSMO_GSM_MANUALS_DIR/g
Replace TOPDIR with OSMO_GSM_MANUALS_DIR. When the project specific
manuals will be built out of this repository, we still need to refer to
the top directory of the shared content. But it will be in another
repository, so we need to rename the variable to avoid confusion.

(moving manuals to project repositories 3/19)

Related: OS#3385
Change-Id: I2af797546de048a6ab19a5cbc755e5e15575d7ab
2018-11-20 17:13:25 +01:00
Oliver Smith e1fdd1ac20 tests: add shared content pdf build tests
Build project independent "test-usermanual.pdf" (with all common
chapters automatically included) and "test-vty-reference.pdf" files.

This allows testing if changed common chapters and the build scripts
are still working, even when the project specific manuals will be moved
away from this repository.

(moving manuals to project repositories 2/19)

Related: OS#3386
Change-Id: Ia74e32678c95e22ba493e80d0a4a8f783c5a5ddf
2018-11-20 17:13:25 +01:00