Commit Graph

579 Commits

Author SHA1 Message Date
Oliver Smith 2d22f33f60 remove OsmoMGCP, OsmoNAT files (now avail in openbsc.git)
Files were added in openbsc.git Change-Id
Ibace91bc518079765e12529596a1763b6c5a04b5

Depends: openbsc.git Change-Id Ibace91bc518079765e12529596a1763b6c5a04b5
Related: OS#3385
Change-Id: Icdbdc4518b049135f18ac4a569ff5ffe4f3d5a86
2018-11-29 16:30:48 +01:00
Oliver Smith 633e6d92a8 INSTALL.txt: "make check" needs libxml2-utils
Change-Id: I6fba644cff833c912f6d83651a1ee27c1c4884d2
2018-11-29 14:23:18 +00:00
Oliver Smith ceb12eaa69 remove OsmocomBB files (now avail in osmocom-bb.git)
Files were added in osmocom-bb.git Change-Id
I7d1226d3865da9595b730b716a8d4ba07be1e0d5

Depends: osmocom-bb.git Change-Id I7d1226d3865da9595b730b716a8d4ba07be1e0d5
Related: OS#3385
Change-Id: I5a4839be7a3122ab566023a3e7b3bc955db98ba4
2018-11-29 10:52:42 +01:00
Oliver Smith b7f198f087 remove OsmoNITB files (now avail in openbsc.git)
Files were added in openbsc.git Change-Id
I4466d820cb3a5609a4a8534b1581684f891a04cd

Depends: openbsc.git Change-Id I4466d820cb3a5609a4a8534b1581684f891a04cd
Related: OS#3385
Change-Id: I2d4f4d6dc5a70e27de464921f4fe0aab4ca8ec72
2018-11-29 10:50:16 +01:00
Oliver Smith f8bddfae15 remove OsmoGSMTester files (now avail in osmo-gsm-tester.git)
Files were added in osmo-gsm-tester.git Change-Id
I8a34871948425ea40f40dbb11a59806905e4bed1

Depends: osmo-gsm-tester.git Change-Id I8a34871948425ea40f40dbb11a59806905e4bed1
Related: OS#3385
Change-Id: I89429a306d37e267fdb335d1c177c9ede3b64444
2018-11-29 10:48:13 +01:00
Oliver Smith aecc41b749 remove OsmoTRX files (now avail in osmo-trx.git)
Files were added in osmo-trx.git Change-Id
I2762171af0bf719a34ba12a0c2e4dcc206098beb

Depends: osmo-trx.git Change-Id I2762171af0bf719a34ba12a0c2e4dcc206098beb
Related: OS#3385
Change-Id: If7cd43eec5f9d20f7f4200340e96ed0e0908e253
2018-11-28 11:23:48 +01:00
Oliver Smith af87a34845 remove OsmoSTP files (now avail in libosmo-sccp.git)
Files were added in libosmo-sccp.git Change-Id
Ib5a22c2ea81fdde036bf9efb47d785a830b88c93

Depends: libosmo-sccp.git Change-Id Ib5a22c2ea81fdde036bf9efb47d785a830b88c93
Related: OS#3385
Change-Id: I971ef93a675412ea27d8bf193db6b9b35428f0bc
2018-11-28 11:23:48 +01:00
Oliver Smith e4b6db024c remove OsmoSIPConnector files (now avail in osmo-sip-connector.git)
Files were added in osmo-sip-connector.git Change-Id
I1317131ed6765fec996344fc6ed08350187b615b

Depends: osmo-sip-connector.git Change-Id I1317131ed6765fec996344fc6ed08350187b615b
Related: OS#3385
Change-Id: Id77812586eb21932b563b57e75cd85b721b7d6ab
2018-11-28 11:23:48 +01:00
Oliver Smith 05883a1011 remove OsmoSGSN files (now avail in osmo-sgsn.git)
Files were added in osmo-sgsn.git Change-Id
I0477d7c871413bd90b365d3064bac3cba23a0883

Depends: osmo-sgsn.git Change-Id I0477d7c871413bd90b365d3064bac3cba23a0883
Related: OS#3385
Change-Id: Ia6fae983bbcabceb3f470af750c724e12c96423e
2018-11-28 11:23:48 +01:00
Oliver Smith dc066c112d remove OsmoPCU files (now avail in osmo-pcu.git)
Files were added in osmo-pcu.git Change-Id
I7270652de393a98748c0cdc51e626c17ab8f44c2

Depends: osmo-pcu.git Change-Id I7270652de393a98748c0cdc51e626c17ab8f44c2
Related: OS#3385
Change-Id: I2a1de294883491487aa270b1e30160d559ef063a
2018-11-28 11:23:48 +01:00
Oliver Smith a7bd01b248 remove OsmoMGW files (now avail in osmo-mgw.git)
Files were added in osmo-mgw.git Change-Id
I504f05a49721f2dfe105b6c5fd1995c4e7a0be9c

Depends: osmo-mgw.git Change-Id I504f05a49721f2dfe105b6c5fd1995c4e7a0be9c
Related: OS#3385
Change-Id: I793a7150b676837cfa8591f7504872b04d4b1f7f
2018-11-28 11:23:48 +01:00
Oliver Smith 7898364664 remove OsmoHLR files (now avail in osmo-hlr.git)
Files were added in osmo-hlr.git Change-Id
I52b7b06fddd77c6dc272004f434e9e7651f6b349

Depends: osmo-hlr.git Change-Id I52b7b06fddd77c6dc272004f434e9e7651f6b349
Related: OS#3385
Change-Id: Ice3f24888deed8affec40d5d91d71d5e1f3827c8
2018-11-28 11:23:48 +01:00
Oliver Smith 13ba41c8f3 remove OsmoGGSN files (now avail in osmo-ggsn.git)
Files were added in osmo-ggsn.git Change-Id
I14533676d5774ee0d0ee5054ba77d7dac32cff43

Depends: osmo-ggsn.git Change-Id I14533676d5774ee0d0ee5054ba77d7dac32cff43
Related: OS#3385
Change-Id: I4b9e2836a74b84bfc73ea7048a137ab5253d9045
2018-11-28 11:23:48 +01:00
Oliver Smith 31971e2f40 remove OsmoBTS files (now avail in osmo-bts.git)
Files were added in osmo-bts.git Change-Id
I728ebb56ade6dda079a0744c4e592284e1bea4f6

Depends: osmo-bts.git Change-Id I728ebb56ade6dda079a0744c4e592284e1bea4f6
Related: OS#3385
Change-Id: I34426309cb009229069e1472fac86efab38a2f6e
2018-11-28 11:23:48 +01:00
Oliver Smith d707ffd51e remove OsmoBSC files (now avail in osmo-bsc.git)
Files were added in osmo-bsc.git Change-Id
I92c0f771d4ffc2b0401d26e25cb0b3817e6f95ea

Depends: osmo-bsc.git Change-Id I92c0f771d4ffc2b0401d26e25cb0b3817e6f95ea
Related: OS#3385
Change-Id: Ib7e60990b59eeb1c5904fdcbd0c01d4a1f46fec6
2018-11-28 11:23:48 +01:00
Oliver Smith 3c92b5884d OsmoNITB: bsc_vty_additions.xml: replace symlink with copy
Replace the symlink that points to OsmoBSC/vty/bsc_vty_additions.xml
with a copy of that file, so we can delete the OsmoBSC dir.

Change-Id: Ifbffc90d56f0fa90d2da77dd7807cd0bb197c0d7
2018-11-28 11:21:32 +01:00
Oliver Smith ce1362ec7f remove OsmoMSC files (now avail in osmo-msc.git)
Files were added in osmo-msc.git Change-Id
Ic3c5add3c87f0aadb1ffab668ce16be6d0805d33.

The other project specific files will be moved in future commits. One
commit per dir.

Depends: osmo-msc.git Change-Id Ic3c5add3c87f0aadb1ffab668ce16be6d0805d33
Related: OS#3385
Change-Id: Ib234fe4f4ac36c27a4ad8a8d0050c1d6874232bc
2018-11-28 10:36:20 +01:00
Max b9bf09ec19 ctrl: clarify use of id = 0
Change-Id: Ic00de5023e7a1ec6426a0178778d35b13c337271
2018-11-26 10:50:42 +01:00
Oliver Smith e7446e8810 publish from project repos, not this repo anymore
Do not publish PDFs for all projects anymore with jenkins.sh --publish
or "make publish". Extract known_hosts from jenkins.sh, and install it
along with the other shared files in OSMO_GSM_MANUALS_DIR. Add a
"publish" target to Makefile.common.inc, so we can use it from the
project repositories. Document its usage in INSTALL.txt.

No automatism for building and publishing the documentation of all
projects will be implemented in this patch series, as discussed here:
https://osmocom.org/issues/3385#note-7

(moving manuals to project repositories 19/19)

Related: OS#3385
Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
2018-11-21 14:37:49 +01:00
Oliver Smith aec8d2b3d8 jenkins.sh: run 'make distcheck'
Everything is in place for 'make distcheck' now.

(moving manuals to project repositories 18/19)

Related: OS#3385
Change-Id: Ie31fba3d1afd31c25489ce08169101d9ed9de536
2018-11-21 14:37:49 +01: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 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 896c7a8c49 vty_reference_combine.sh: chmod xsltproc output
Force the xsltproc output file to be writable, if it exists already.
This is needed for 'make distcheck': xsltproc gives output files the
same permissions as input files. We need to change the output file in
multiple iterations in vty_reference_combine.sh, hence it must be
writable.

(moving manuals to project repositories 15/19)

Related: OS#3385
Change-Id: I693e12ee15665d01cbc50187e6cb3ca74ad0356a
2018-11-21 14:37:49 +01:00
Oliver Smith 54e6529a6a copy NITB's osmobsc-usermanual.adoc to OsmoBSC
Includes from other projects don't work anymore when moving project
specific manuals into other repositories.

(moving manuals to project repositories 14/19)

Related: OS#3385
Change-Id: I96933dd4dd6cac159847647f1c642215051a9aad
2018-11-21 14:37:49 +01:00
Oliver Smith 99b7cd1775 *.adoc: use {srcdir} for out-of-tree builds
Define a new {srcdir} variable in Makefile.asciidoc.inc, that can be
used in all adoc files. The value is the same as the Makefile variable
$(srcdir). Use {srcdir} in the "include::" lines of all adoc files.

(moving manuals to project repositories 13/19)

Related: OS#3385
Change-Id: I823e3d534cbc9ffceb68d3ab14c9f6710ff2eb2a
2018-11-21 14:37:49 +01:00
Oliver Smith 2682f14611 Makefile.*.inc: adjust to out-of-tree building
Makefile.asciidoc.inc: create a symlink for the root adoc file, from
which a PDF gets generated, from the srcdir to the builddir. This file
may include other adoc files, which do not get symlinked. We need to do
this, because a2x (the program generating the PDF file) does not have a
parameter for the output file, and will otherwise generate the PDF in
the srcdir instead of the builddir. Do the same in the check target, so
the relative include paths work the same.

Makefile.asciidoc.inc, Makefile.docbook.inc: set the include paths for
the xstl parser, as well as the LaTeX compiler, so they can find the
files they need from both OSMO_GSM_MANUALS_DIR and builddir.

Makefile.asciidoc.inc, Makefile.docbook.inc: refer to the output file
$@ with $(notdir $@). This removes the path from the file, like
basename from coreutils. The output file will then be placed in the
builddir instead of the srcdir.

Makefile.vty-reference.inc: use $(srcdir) in references to vty/*.xml
files.

(moving manuals to project repositories 12/19)

Related: OS#3385
Change-Id: Ie6b212a6518f0fc29fae610a37ae6c533189278d
2018-11-21 14:35:03 +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 673e2dc481 vty_reference_combine.sh: add *reference.xml arg
Pass the path to $(srcdir)/vty/*reference.xml as parameter to
vty_reference_combine.sh instead of assuming that it will be in
./vty/*reference.xml.

This is necessary to make the build scripts work for out-of-tree
builds. Because when building out-of-tree, the source dir and build dir
(the one where the Makefile gets generated, and in which "make" runs),
are not the same anymore. The relative vty/reference.xml path is only
valid in the source dir, not in the build dir. The next commits in this
series have more changes for out-of-tree builds.

Out-of-tree building is necessary for consistency with the other
Osmocom code, which can be built out-of-tree as well. It would be
strange if this did not work anymore as soon as the users enabled
building the manuals.

(moving manuals to project repositories 10/19)

Related: OS#3385
Change-Id: I3dcb49d7705f882bd117088d4e5eab91dd1c7d8c
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 dc7c08ea08 *.adoc: include from ./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 8/19)

Related: OS#3385
Change-Id: Id984f5e85481f7877567ee6d21f7ca455d773ef1
2018-11-21 14:29:11 +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 Makefile.common.inc 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 8d282762d9 cosmetic: update usage of OSMO_GSM_MANUALS_DIR
OSMO_GSM_MANUALS_DIR should use pkg-config to figure out the location
of the shared osmo-gsm-manuals files.

(moving manuals to project repositories 6/19)

Related: OS#3385
Change-Id: I64cfffb5104edcf7a20f41aeb5bf8ee6988b57c4
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 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
(OS#3386).

(moving manuals to project repositories 4/19)

Related: OS#3385
Change-Id: I34b0d20046417179250a5065574e2bc303889cf6
2018-11-20 17:13:25 +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
Oliver Smith 712e2a2e3f make check: properly reference dependencies
Use $(ASCIIDOC_DEPS) instead of assuming that the value would be
"chapters/*.adoc". The variable exists already, but it was not used
yet in 'make check' of  Makefile.asciidoc.inc.

This allows creating a tests dir without its own chapters subdir
(follow-up commit), which is part of a larger effort to move manuals to
project repositories.

The reason for moving manuals to project repositories is that we can
have documentation changes together with code changes in the same
patches. Not part of this patchset, but possible in the future, is
optionally building UNIX man pages in the project repositories
(OS#3386) as well as generating the VTY documentation on the fly from
running the project binaries (OS#3695).

(moving manuals to project repositories 1/19)

Related: OS#3386
Change-Id: Id8b26759607a3490d6cbd93c68ba1f89aa8ef1f2
2018-11-20 17:13:25 +01:00
Neels Hofmeyr 84629eee1e stp: update vty reference with added SCCP commands
After I66e97706de0c546db3c6ff77fb5e6ac6e32bff55 which adds the missing
sccp_vty_init(), update VTY reference with the new SCCP show / config commands.

Depends: I66e97706de0c546db3c6ff77fb5e6ac6e32bff55
Change-Id: Id941b8e31d3b4cfdb3f912beedc1e7af321a0113
2018-11-18 20:41:28 +00:00
Neels Hofmeyr 83d15e9833 stp: update vty reference
Change-Id: Id5f1067760db7a11ec380a541bfe7357a21a3bb3
2018-11-18 20:41:28 +00:00
Neels Hofmeyr 31b2fbe75a sip-connector: update vty reference
Change-Id: I79b91847337b6022f8f750533301b3bf0eb086df
2018-11-18 20:41:28 +00:00
Neels Hofmeyr b954330c1d sgsn: update vty reference
Change-Id: I64d775efa6791aca025d116905e951e10ffa5d04
2018-11-18 20:41:28 +00:00
Neels Hofmeyr 242585a212 msc: update vty reference
Change-Id: I31f1d388b5323af8ece8a71a82c1b91f80d404e1
2018-11-18 20:41:28 +00:00
Neels Hofmeyr d6dffb5401 mgw: update vty reference
Change-Id: Ib30ea8b02f8a950648b85e7ebc96a40ba5a36b34
2018-11-18 20:41:28 +00:00
Neels Hofmeyr 87325793ba hlr: update vty reference
Change-Id: I5a2322c0488cb36b089303bbfec5d4db18c41099
2018-11-18 20:41:28 +00:00
Neels Hofmeyr 020641da2e ggsn: update vty reference
Change-Id: I8a5c37505c0180d5c04c7792d6d0afdb0dffb282
2018-11-18 20:41:28 +00:00
Neels Hofmeyr b33f6973d0 OsmoBSC: update VTY reference
Re-generate bsc_vty_reference.xml from osmo-bsc, including updates to:
- handover and neighbor config
- SCCP timers
- logging

Change-Id: Ia9ba8d5eba531b1156de57573ab42517e0c1ca15
2018-11-18 20:41:28 +00:00
Daniel Willmann 6e5b7d3cdc Logging: Describe all log options, including set-all and force-all
Change-Id: Ica03c3ea08289314819448a22ae7ed38a7bd4f83
2018-11-18 20:06:00 +00:00
Daniel Willmann 987aa54d56 common/chapters/bts: Remove duplicate spaces in text
Change-Id: I38f3e94342461f494ef547bcdccd2594c30e679d
2018-11-18 20:06:00 +00:00
Daniel Willmann b7b5ce0a28 Change OpenBSC mentions to OsmoBSC where applicable
Change-Id: I4cc6874302b6089a54d44b09f08660a25e46d4dc
2018-11-18 20:06:00 +00:00
Daniel Willmann 1d56daeaeb OsmoBSC/HLR/MSC: Fix default config file name
Mention that the default is not openbsc.cfg, but osmo-*.cfg

Change-Id: I139e6004e28d6f918f31792e634214a6153edd0e
2018-11-18 20:05:12 +00:00