cellular-infrastructure
/
osmo-gsm-manuals
mirror of https://gerrit.osmocom.org/osmo-gsm-manuals
9
0
Fork 0
Code Releases Activity
osmo-gsm-manuals/build/Makefile.common.inc

28 lines
701 B
PHP
Raw Normal View History

refactor Makefile build rules, don't use the FORCE 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
2017-10-19 03:11:57 +00:00
# Usage:
#
# Other makefiles like Makefile.asciidoc.inc and Makefile.vty-reference.inc add
# entries to UPLOAD_FILES and CLEAN_FILES.
#
*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-13 15:33:44 +00:00
# Include this file at the end to have the common targets (upload, clean etc.).
refactor Makefile build rules, don't use the FORCE 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
2017-10-19 03:11:57 +00:00
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-14 10:09:31 +00:00
SSH_COMMAND = ssh -o 'UserKnownHostsFile=$(OSMO_GSM_MANUALS_DIR)/build/known_hosts' -p 48
refactor Makefile build rules, don't use the FORCE 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
2017-10-19 03:11:57 +00:00
UPLOAD_PATH ?= generic@sysmocom-downloads:documents
*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-13 15:33:44 +00:00
SYMLINKS = common build
CLEAN_FILES += $(SYMLINKS)
$(SYMLINKS):
ln -s $(OSMO_GSM_MANUALS_DIR)/$@ $@
refactor Makefile build rules, don't use the FORCE 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
2017-10-19 03:11:57 +00:00
upload: $(UPLOAD_FILES)
rsync -avz $(UPLOAD_FILES) $(UPLOAD_PATH)/
clean:
-rm -rf $(CLEAN_FILES)
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-14 13:25:18 +00:00
distclean: clean
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-14 10:09:31 +00:00
Makefile.common.inc: publish: don't depend on check The 'check' target is only available when including Makefile.asciidoc.inc, which is not always the case. Some projects only build the VTY reference. Do not depend on check, so publishing the VTY reference for these projects is working as expected. Related: OS#3385 Change-Id: I64aae0016095d81ca9e9ebda9a2e3336ac126639
2018-12-07 15:01:58 +00:00
publish: all
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-14 10:09:31 +00:00
mkdir -p out
cp *.pdf out
rsync -avz -e "$(SSH_COMMAND)" ./out/ docs@rita.osmocom.org:web-files/latest/