<p>osmith <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/11740">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Neels Hofmeyr: Looks good to me, approved
Jenkins Builder: Verified
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">publish from project repos, not this repo anymore<br><br>Do not publish PDFs for all projects anymore with jenkins.sh --publish<br>or "make publish". Extract known_hosts from jenkins.sh, and install it<br>along with the other shared files in OSMO_GSM_MANUALS_DIR. Add a<br>"publish" target to Makefile.common.inc, so we can use it from the<br>project repositories. Document its usage in INSTALL.txt.<br><br>No automatism for building and publishing the documentation of all<br>projects will be implemented in this patch series, as discussed here:<br>https://osmocom.org/issues/3385#note-7<br><br>(moving manuals to project repositories 19/19)<br><br>Related: OS#3385<br>Change-Id: Ibe0424ceace151115985896b6d43035c69067c50<br>---<br>M INSTALL.txt<br>M build/Makefile.common.inc<br>A build/known_hosts<br>M contrib/jenkins.sh<br>4 files changed, 32 insertions(+), 18 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/INSTALL.txt b/INSTALL.txt</span><br><span>index 6efe8d1..c3caefe 100644</span><br><span>--- a/INSTALL.txt</span><br><span>+++ b/INSTALL.txt</span><br><span>@@ -14,13 +14,26 @@</span><br><span> </span><br><span> (Note that asciidoc-dblatex is required from debian 9 on and did not exist before.)</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-Build PDFs, run:</span><br><span style="color: hsl(120, 100%, 40%);">+Prepare your build dir:</span><br><span> autoreconf -fi</span><br><span> ./configure</span><br><span style="color: hsl(0, 100%, 40%);">- make</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-or for a parallel build using more CPU cores, replace make with:</span><br><span style="color: hsl(0, 100%, 40%);">- make -j 5</span><br><span style="color: hsl(120, 100%, 40%);">+Optionally test building all shared content (use -j for parallel building):</span><br><span style="color: hsl(120, 100%, 40%);">+ make # generate test PDFs</span><br><span style="color: hsl(120, 100%, 40%);">+ make check # test for asciidoc errors</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Install osmo-gsm-manuals:</span><br><span style="color: hsl(120, 100%, 40%);">+ make install</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Build the manuals of a specific Osmocom project:</span><br><span style="color: hsl(120, 100%, 40%);">+ cd ../osmo-msc # enter the project dir, clone first if needed</span><br><span style="color: hsl(120, 100%, 40%);">+ ./configure --enable-manuals</span><br><span style="color: hsl(120, 100%, 40%);">+ make</span><br><span style="color: hsl(120, 100%, 40%);">+ ls doc/manuals/*.pdf # find the PDFs here</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Publish PDFs to the Osmocom server:</span><br><span style="color: hsl(120, 100%, 40%);">+ cd ../osmo-msc # enter the project dir</span><br><span style="color: hsl(120, 100%, 40%);">+ make -C doc/manuals publish</span><br><span> </span><br><span> To update the VTY reference for a given program, use 'osmo_interact_vty.py -X',</span><br><span> available from git.osmocom.org/python/osmo-python-tests:</span><br><span>diff --git a/build/Makefile.common.inc b/build/Makefile.common.inc</span><br><span>index efd56f6..0ee648a 100644</span><br><span>--- a/build/Makefile.common.inc</span><br><span>+++ b/build/Makefile.common.inc</span><br><span>@@ -5,6 +5,7 @@</span><br><span> #</span><br><span> # Include this file at the end to have the common targets (upload, clean etc.).</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+SSH_COMMAND = ssh -o 'UserKnownHostsFile=$(OSMO_GSM_MANUALS_DIR)/build/known_hosts' -p 48</span><br><span> UPLOAD_PATH ?= generic@sysmocom-downloads:documents</span><br><span> SYMLINKS = common build</span><br><span> CLEAN_FILES += $(SYMLINKS)</span><br><span>@@ -19,3 +20,8 @@</span><br><span> -rm -rf $(CLEAN_FILES)</span><br><span> </span><br><span> distclean: clean</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+publish: all check</span><br><span style="color: hsl(120, 100%, 40%);">+ mkdir -p out</span><br><span style="color: hsl(120, 100%, 40%);">+ cp *.pdf out</span><br><span style="color: hsl(120, 100%, 40%);">+ rsync -avz -e "$(SSH_COMMAND)" ./out/ docs@rita.osmocom.org:web-files/latest/</span><br><span>diff --git a/build/known_hosts b/build/known_hosts</span><br><span>new file mode 100644</span><br><span>index 0000000..c78b03d</span><br><span>--- /dev/null</span><br><span>+++ b/build/known_hosts</span><br><span>@@ -0,0 +1,3 @@</span><br><span style="color: hsl(120, 100%, 40%);">+[rita.osmocom.org]:48 ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDDgQ9HntlpWNmh953a2Gc8NysKE4orOatVT1wQkyzhARnfYUerRuwyNr1GqMyBKdSI9amYVBXJIOUFcpV81niA7zQRUs66bpIMkE9/rHxBd81SkorEPOIS84W4vm3SZtuNqa+fADcqe88Hcb0ZdTzjKILuwi19gzrQyME2knHY71EOETe9Yow5RD2hTIpB5ecNxI0LUKDq+Ii8HfBvndPBIr0BWYDugckQ3Bocf+yn/tn2/GZieFEyFpBGF/MnLbAAfUKIdeyFRX7ufaiWWz5yKAfEhtziqdAGZaXNaLG6gkpy3EixOAy6ZXuTAk3b3Y0FUmDjhOHllbPmTOcKMry9</span><br><span style="color: hsl(120, 100%, 40%);">+[rita.osmocom.org]:48 ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBPdWn1kEousXuKsZ+qJEZTt/NSeASxCrUfNDW3LWtH+d8Ust7ZuKp/vuyG+5pe5pwpPOgFu7TjN+0lVjYJVXH54=</span><br><span style="color: hsl(120, 100%, 40%);">+[rita.osmocom.org]:48 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIK8iivY70EiR5NiGChV39gRLjNpC8lvu1ZdHtdMw2zuX</span><br><span>diff --git a/contrib/jenkins.sh b/contrib/jenkins.sh</span><br><span>index 626160e..7d4d8df 100755</span><br><span>--- a/contrib/jenkins.sh</span><br><span>+++ b/contrib/jenkins.sh</span><br><span>@@ -2,7 +2,12 @@</span><br><span> </span><br><span> set -ex</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-publish="$1"</span><br><span style="color: hsl(120, 100%, 40%);">+if [ -n "$1" ]; then</span><br><span style="color: hsl(120, 100%, 40%);">+ echo "ERROR: --publish has been deprecated!"</span><br><span style="color: hsl(120, 100%, 40%);">+ echo "Manuals have been moved to the projects, and need to be published from there."</span><br><span style="color: hsl(120, 100%, 40%);">+ echo "See INSTALL.txt for more information."</span><br><span style="color: hsl(120, 100%, 40%);">+ exit 1</span><br><span style="color: hsl(120, 100%, 40%);">+fi</span><br><span> </span><br><span> osmo-clean-workspace.sh</span><br><span> </span><br><span>@@ -12,17 +17,4 @@</span><br><span> $MAKE $PARALLEL_MAKE check</span><br><span> $MAKE $PARALLEL_MAKE distcheck</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-if [ "x$publish" = "x--publish" ]; then</span><br><span style="color: hsl(0, 100%, 40%);">- mkdir out/</span><br><span style="color: hsl(0, 100%, 40%);">- cp */*.pdf out/</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- cat > "$WORKSPACE/known_hosts" <<EOF</span><br><span style="color: hsl(0, 100%, 40%);">-[rita.osmocom.org]:48 ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDDgQ9HntlpWNmh953a2Gc8NysKE4orOatVT1wQkyzhARnfYUerRuwyNr1GqMyBKdSI9amYVBXJIOUFcpV81niA7zQRUs66bpIMkE9/rHxBd81SkorEPOIS84W4vm3SZtuNqa+fADcqe88Hcb0ZdTzjKILuwi19gzrQyME2knHY71EOETe9Yow5RD2hTIpB5ecNxI0LUKDq+Ii8HfBvndPBIr0BWYDugckQ3Bocf+yn/tn2/GZieFEyFpBGF/MnLbAAfUKIdeyFRX7ufaiWWz5yKAfEhtziqdAGZaXNaLG6gkpy3EixOAy6ZXuTAk3b3Y0FUmDjhOHllbPmTOcKMry9</span><br><span style="color: hsl(0, 100%, 40%);">-[rita.osmocom.org]:48 ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBPdWn1kEousXuKsZ+qJEZTt/NSeASxCrUfNDW3LWtH+d8Ust7ZuKp/vuyG+5pe5pwpPOgFu7TjN+0lVjYJVXH54=</span><br><span style="color: hsl(0, 100%, 40%);">-[rita.osmocom.org]:48 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIK8iivY70EiR5NiGChV39gRLjNpC8lvu1ZdHtdMw2zuX</span><br><span style="color: hsl(0, 100%, 40%);">-EOF</span><br><span style="color: hsl(0, 100%, 40%);">- SSH_COMMAND="ssh -o 'UserKnownHostsFile=$WORKSPACE/known_hosts' -p 48"</span><br><span style="color: hsl(0, 100%, 40%);">- rsync -avz --delete -e "$SSH_COMMAND" ./out/ docs@rita.osmocom.org:web-files/latest/</span><br><span style="color: hsl(0, 100%, 40%);">-fi</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> osmo-clean-workspace.sh</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/11740">change 11740</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/11740"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-gsm-manuals </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: Ibe0424ceace151115985896b6d43035c69067c50 </div>
<div style="display:none"> Gerrit-Change-Number: 11740 </div>
<div style="display:none"> Gerrit-PatchSet: 5 </div>
<div style="display:none"> Gerrit-Owner: osmith <osmith@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder (1000002) </div>
<div style="display:none"> Gerrit-Reviewer: Neels Hofmeyr <nhofmeyr@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Pau Espin Pedrol <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: osmith <osmith@sysmocom.de> </div>