Commit Graph

9 Commits

Author SHA1 Message Date
Oliver Smith 41e54a4d7f gitignore: add "make distcheck" generated files
(moving manuals to project repositories 16/19)

Related: OS#3385
Change-Id: I876b0fa08d2987d285b6d77ef13069228c8b8d37
2018-11-21 14:37:49 +01:00
Oliver Smith 06d1805c5b *filter.conf/*.sty: use symlinks to build, common
$(OSMO_GSM_MANUALS_DIR) is used in most places to reference to the top
dir, which contains "build" and "common". But not in the asciidoc
mscgen filter configurations, and in the custom LaTeX style. They have
../common or ../build hardcoded, which won't work anymore when the
project specific files will be in another repository.

Update the Makefiles to create symlinks to "build" and "common" in the
dir where the build was started. Use ./common in the files that had
../common hardcoded, and do the same for ./build.

Update the comment to refer to common targets in
general, so we don't need to list each single one there (like the new
'common' and 'build' targets).

I've also thought about using variables there, but this would only work
for the asciidoc files, not for the .sty file. We would need to
generate the latter from another file and replace the variable
dynamically. Having the symlinks instead seemed to be slightly easier.

(moving manuals to project repositories 7/19)

Related: OS#3385
Change-Id: I4cfd1a9ef482d382f10cdf060e8e2cba81852864
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. 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 fc9426e02e prepare for autotools: add git-version-gen
Add the same version of git-version-gen, which most other Osmocom
repositories (libasn1c, libosmocore, libosmo-netif, libosmo-sccp, ...)
are using, so they behave the same.

git-version-gen generates a version string derived from the git
repository, or from a .tarball-version file when running outside of a
git directory. Unfortunatelly it seems to be impossible to use
git-version-gen from autoconf without adding it to the source tree.

Autotools will be used to install the shared manual files into the
system in a way that is consistent with the other Osmocom repositories:

$ autoreconf -fi
$ ./configure --prefix=/usr/local
$ make
$ make install

Project repositories will check with pkg-config if osmo-gsm-manuals is
installed (like any other shared Osmocom component), when a new
configure flag for building the manuals is passed. This will also work
with distribution's package managers, for instance we could have a
osmo-gsm-manuals-dev package in Debian on which the other packages
would have a build-time dependency to build the UNIX man pages

(moving manuals to project repositories 4/19)

Related: OS#3385
Change-Id: I34b0d20046417179250a5065574e2bc303889cf6
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
Max 98bb147bbd Describe gsmtap log destination
Change-Id: If34e1640d1033daacc955f4285013b8c1be644d2
Fixes: OS#2608
2018-01-05 12:46:38 +00:00
Neels Hofmeyr b156e76469 add 'make check' target
Generate *.check files from asciidoc output and grep for WARNINGs.
Add *.check files to gitignore and to 'make clean'.

Change-Id: Ibccc83a3415930a528f2e8e4e4dda3b81c6d0b64
2016-10-18 17:11:21 +02:00
Neels Hofmeyr 00e490c7aa gitignore png, svg, html 2016-03-22 08:44:43 +01:00
Harald Welte 37ba7a9825 initial checkin of manuals to public repo
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.
2016-02-20 15:01:50 +01:00