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
This commit is contained in:
Oliver Smith 2018-11-14 10:47:01 +01:00
parent e1fdd1ac20
commit dec39cdea9
20 changed files with 88 additions and 88 deletions

View File

@ -1,11 +1,11 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmobsc-usermanual.adoc osmux-reference.adoc aoip-mgw-options.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
osmobsc-usermanual.pdf: chapters/*.adoc chapters/*.dot
aoip-mgw-options.pdf: aoip-mgw-options.adoc mgw/*.msc
VTY_REFERENCE = osmobsc-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,12 +1,12 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmobts-usermanual.adoc osmobts-abis.adoc rtp-amr.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
osmobts-usermanual.pdf: chapters/*.adoc
osmobts-abis.pdf: abis/*.adoc abis/*.msc
rtp-amr.pdf: dtx.dot
VTY_REFERENCE = osmobts-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,10 +1,10 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmoggsn-usermanual.adoc
ASCIIDOC_DEPS = chapters/*.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
VTY_REFERENCE = osmoggsn-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,7 +1,7 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmo-gsm-tester-manual.adoc
ASCIIDOC_DEPS = chapters/*.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,13 +1,13 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmohlr-usermanual.adoc
ASCIIDOC_DEPS = chapters/*.adoc *.vty *.ctrl
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
VTY_REFERENCE = osmohlr-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc
OSMO_HLR_PATH ?= ../../osmo-hlr
TMP_DB = generated/hlr.db

View File

@ -1,6 +1,6 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
VTY_REFERENCE = osmomgcp-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,10 +1,10 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmomgw-usermanual.adoc
ASCIIDOC_DEPS = chapters/*.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
VTY_REFERENCE = osmomgw-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,10 +1,10 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmomsc-usermanual.adoc
ASCIIDOC_DEPS = chapters/*.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
VTY_REFERENCE = osmomsc-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,6 +1,6 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
VTY_REFERENCE = osmonat-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,10 +1,10 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmonitb-usermanual.adoc
ASCIIDOC_DEPS = chapters/*.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
VTY_REFERENCE = osmonitb-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,11 +1,11 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmopcu-usermanual.adoc osmopcu-gb.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
osmopcu-gb.pdf: gb/*.adoc gb/*.msc
osmopcu-usermanual.pdf: chapters/*.adoc
VTY_REFERENCE = osmopcu-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,10 +1,10 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmosgsn-usermanual.adoc
ASCIIDOC_DEPS = chapters/*.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
VTY_REFERENCE = osmosgsn-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,10 +1,10 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmosipconnector-usermanual.adoc
ASCIIDOC_DEPS = chapters/*.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
VTY_REFERENCE = osmosipconnector-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,11 +1,11 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmostp-usermanual.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
osmostp-usermanual.pdf: chapters/*.adoc
aoip-mgw-options.pdf: aoip-mgw-options.adoc mgw/*.msc
VTY_REFERENCE = osmostp-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,10 +1,10 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmotrx-usermanual.adoc
ASCIIDOC_DEPS = chapters/*.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
VTY_REFERENCE = osmotrx-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,7 +1,7 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
ASCIIDOC = osmocombb-usermanual.adoc
ASCIIDOC_DEPS = chapters/*.adoc
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc

View File

@ -1,6 +1,6 @@
# USAGE:
#
# - define 'TOPDIR' to point at the git root,
# - define 'OSMO_GSM_MANUALS_DIR' to point at the git root,
# - define in 'ASCIIDOC' all root .adoc files,
# - optionally define in 'ASCIIDOC_DEPS' all dependencies common to all .adocs,
# - include this file,
@ -8,16 +8,16 @@
#
# e.g.
#
# TOPDIR = ..
# OSMO_GSM_MANUALS_DIR = ..
# ASCIIDOC = osmo_yada.adoc osmo_moo.adoc
# ASCIIDOC_DEPS = for_all/*.adoc
# include $(TOPDIR)/build/Makefile.asciidoc.inc
# include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
# osmo_yada.pdf: yada/*.adoc yada/*.msc
BUILDDIR = $(TOPDIR)/build
BUILDDIR = $(OSMO_GSM_MANUALS_DIR)/build
GIT_VERSION := $(shell git describe --abbrev=4 --dirty --always --tags)
GIT_DATE := $(shell $(TOPDIR)/build/unix-time-to-fmt.py `git log -n 1 "--pretty=%at" ../.`)
GIT_DATE := $(shell $(OSMO_GSM_MANUALS_DIR)/build/unix-time-to-fmt.py `git log -n 1 "--pretty=%at" ../.`)
# prepend the document name with the version numbe suffix
#DOCS_VER = $(foreach P, $(ASCIIDOC_NAME), $(P)-v$(shell xmllint --recover --xpath "//revnumber[position()=last()]/text()" $(P)-docinfo.xml 2>/dev/null))
@ -51,8 +51,8 @@ all: $(ASCIIDOC_PDF)
$(ASCIIDOC_PDF): %.pdf: %.adoc %-docinfo.xml \
$(ASCIIDOC_DEPS) \
$(ASCIIDOCSTYLE) \
$(TOPDIR)/common/*/*.adoc \
$(TOPDIR)/common/images/*
$(OSMO_GSM_MANUALS_DIR)/common/*/*.adoc \
$(OSMO_GSM_MANUALS_DIR)/common/images/*
@test -n "$(BUILD_RELEASE)" && echo -e "\n\n\
NOTE: TO REMOVE DRAFT MODE, YOU NEED TO EDIT build/custom-dblatex.sty\n\
and remove three lines starting with '% \"DRAFT\" on first page'\n" \
@ -62,7 +62,7 @@ $(ASCIIDOC_PDF): %.pdf: %.adoc %-docinfo.xml \
check: $(ASCIIDOC_CHECKS)
$(ASCIIDOC_CHECKS): %.check: %.adoc %-docinfo.xml $(ASCIIDOCSTYLE) $(TOPDIR)/common/chapters/*.adoc $(ASCIIDOC_DEPS)
$(ASCIIDOC_CHECKS): %.check: %.adoc %-docinfo.xml $(ASCIIDOCSTYLE) $(OSMO_GSM_MANUALS_DIR)/common/chapters/*.adoc $(ASCIIDOC_DEPS)
asciidoc -v $(ASCIIDOC_OPTS) $< > $@ 2>&1
# Make absolutely sure that the %.check target is updated.
touch $@

View File

@ -1,6 +1,6 @@
# USAGE:
#
# - define 'TOPDIR' to point at the git root,
# - define 'OSMO_GSM_MANUALS_DIR' to point at the git root,
# - define in 'DOCBOOKS' all root .xml files,
# - optionally define in 'DOCBOOKS_DEPS' all dependencies common to all .xmls,
# - include this file,
@ -8,10 +8,10 @@
#
# e.g.
#
# TOPDIR = ..
# OSMO_GSM_MANUALS_DIR = ..
# DOCBOOKS = osmo_yada.xml osmo_moo.xml
# ASCIIDOC_DEPS = for_all/*.xml
# include $(TOPDIR)/build/Makefile.docbook.inc
# include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.docbook.inc
# osmo_yada.pdf: yada/*.xml
#
# XSL stylesheets downloaded from http://docbook.sourceforge.net/release/xsl/current/html/

View File

@ -8,34 +8,34 @@
# Export from VTY 'show online-help', exactly one file.
#
# In your Makefile,
# - define 'TOPDIR' to point at the git root,
# - define 'OSMO_GSM_MANUALS_DIR' to point at the git root,
# - define the (single) name of the vty-reference source in VTY_REFERENCE,
# - include this file.
#
# e.g.
#
# TOPDIR = ..
# OSMO_GSM_MANUALS_DIR = ..
# VTY_REFERENCE = osmofoo-vty-reference
# include $(TOPDIR)/build/Makefile.vty-reference.inc
# include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
#
# This uses the Makefile.docbook.inc, you should not mix uses of
# Makefile.vty-reference.inc and Makefile.docbook.inc.
DOCBOOKS = $(VTY_REFERENCE)
DOCBOOKS_DEPS = generated/docbook_vty.xml
include $(TOPDIR)/build/Makefile.docbook.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.docbook.inc
MERGE_DOC = $(shell realpath $(TOPDIR)/merge_doc.xsl)
MERGE_DOC = $(shell realpath $(OSMO_GSM_MANUALS_DIR)/merge_doc.xsl)
CLEAN_FILES += generated
generated/docbook_vty.xml: \
vty/*xml \
$(TOPDIR)/common/vty_additions.xml \
$(TOPDIR)/common/chapters/vty.xml \
$(TOPDIR)/vty_reference.xsl
$(TOPDIR)/build/vty_reference_combine.sh "$(MERGE_DOC)" \
$(TOPDIR)/common/vty_additions.xml \
$(OSMO_GSM_MANUALS_DIR)/common/vty_additions.xml \
$(OSMO_GSM_MANUALS_DIR)/common/chapters/vty.xml \
$(OSMO_GSM_MANUALS_DIR)/vty_reference.xsl
$(OSMO_GSM_MANUALS_DIR)/build/vty_reference_combine.sh "$(MERGE_DOC)" \
$(OSMO_GSM_MANUALS_DIR)/common/vty_additions.xml \
vty/*additions*.xml
xsltproc $(TOPDIR)/vty_reference.xsl generated/combined.xml \
xsltproc $(OSMO_GSM_MANUALS_DIR)/vty_reference.xsl generated/combined.xml \
> generated/docbook_vty.xml

View File

@ -1,9 +1,9 @@
TOPDIR = ..
OSMO_GSM_MANUALS_DIR = ..
# Generate adoc file that includes all chapters
ASCIIDOC = test-usermanual.adoc
ASCIIDOC_DEPS =
$(ASCIIDOC): $(TOPDIR)/common/chapters/*.adoc
$(ASCIIDOC): $(OSMO_GSM_MANUALS_DIR)/common/chapters/*.adoc
echo ":gfdl-enabled:" > $@
echo ":program-name: Test" >> $@
echo "" >> $@
@ -11,16 +11,16 @@ $(ASCIIDOC): $(TOPDIR)/common/chapters/*.adoc
echo "====================================" >> $@
echo "Oliver Smith <osmith@sysmocom.de>" >> $@
echo "" >> $@
for chapter in $(TOPDIR)/common/chapters/*.adoc; do \
for chapter in $(OSMO_GSM_MANUALS_DIR)/common/chapters/*.adoc; do \
echo "include::$${chapter}[]" >> $@; \
done;
CLEAN_FILES = $(ASCIIDOC)
include $(TOPDIR)/build/Makefile.asciidoc.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
VTY_REFERENCE = test-vty-reference.xml
include $(TOPDIR)/build/Makefile.vty-reference.inc
include $(TOPDIR)/build/Makefile.common.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc
default: all check