https://osmocom.org/https://osmocom.org/favicon.ico?16647414092018-07-06T10:24:35ZOpen Source Mobile CommunicationsCellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=102562018-07-06T10:24:35Zpespin
<ul><li><strong>Precedes</strong> <i><a class="issue tracker-2 status-1 priority-1 priority-lowest" href="/issues/3386">Feature #3386</a>: Generate man pages at build time from adoc files</i> added</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=115312018-09-20T20:08:12Zneelsnhofmeyr@sysmocom.de
<ul><li><strong>Related to</strong> <i><a class="issue tracker-2 status-3 priority-2 priority-default closed" href="/issues/3583">Feature #3583</a>: OsmoBSC manual: copy/move bts-examples chapter from OsmoNITB</i> added</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=124282018-10-29T14:03:37Zosmith
<ul><li><strong>Status</strong> changed from <i>New</i> to <i>In Progress</i></li><li><strong>Assignee</strong> changed from <i>4368</i> to <i>osmith</i></li></ul><p>Assigning this to myself, because another issue that is assigned to me (<a class="issue tracker-2 status-1 priority-1 priority-lowest" title="Feature: Generate man pages at build time from adoc files (New)" href="https://osmocom.org/issues/3386">#3386</a>) depends on this one.</p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=124352018-10-29T15:39:04Zosmith
<ul></ul><blockquote>
<p>The idea is to keep the common parts and build related scripts (makefile, etc) in osmo-gsm-manuals.git, and then conditionally enable building them by using a configure flag (eg. --enable-man --with-man-path=/path/to/osmo-gsm-manuals.git/).</p>
</blockquote>
<p><a class="user active" href="https://osmocom.org/users/30187">pespin</a>: I wonder if that works properly with packaging the man pages for Debian later on. We could also extend osmo-gsm-manuals.git with a "make install" target and write a .pc file, that points to the shared code (pkg-config allows <a href="https://people.freedesktop.org/~dbn/pkg-config-guide.html#concepts" class="external">custom variables</a>). Then we could create a "osmo-gsm-manuals-dev" package as build time dependency for the other osmo packages. What do you think?</p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=124362018-10-29T16:15:26Zpespin
<ul></ul><p>Fine for me. Keep in mind that it may be interesting to have some Makefile installed by "make install" in osmo-gsm-manuals.git and reachable through pkg-config custom variable which can then be included as described in initial post. This way we avoid copy&paste same stuff on how to build adoc stuff into each project. Up to you to find best solution.</p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=124592018-10-30T15:39:46Zosmith
<ul></ul><p>I have researched how this issue relates to the Jenkins jobs.</p>
Right now we have:
<ul>
<li>push to master:
<ul>
<li>osmo-gsm-manuals.git - jenkins job "master-osmo-gsm-manuals" (from master-builds.yml)
<ul>
<li>calls ./contrib/jenkins.sh --publish</li>
<li>builds the manuals for all projects</li>
<li>runs rsync to publish the "./out" folder</li>
</ul>
</li>
</ul>
</li>
<li>push to gerrit:
<ul>
<li>osmo-gsm-manuals.git - jenkins job "gerrit-osmo-gsm-manuals" (from gerrit-verifications.yml)
<ul>
<li>calls ./contrib/jenkins.sh</li>
<li>builds the manuals for all projects</li>
</ul></li>
</ul></li>
</ul>
After moving the manuals to the project folders, I think we need:
<ul>
<li>push to master:
<ul>
<li>osmo-gsm-manuals.git
<ul>
<li>build and publish the documentation of all projects</li>
</ul>
</li>
<li>osmo-*.git
<ul>
<li>build and publish the documentation of that project</li>
</ul>
</li>
</ul>
</li>
<li>push to gerrit:
<ul>
<li>osmo-gsm-manuals.git
<ul>
<li>build the documentation of all projects</li>
</ul>
</li>
<li>osmo-*.git
<ul>
<li>build the repo with its documentation</li>
</ul></li>
</ul></li>
</ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=124602018-10-30T16:10:07Zlaforge
<ul></ul><p>On Tue, Oct 30, 2018 at 03:39:46PM +0000, osmith [REDMINE] wrote:</p>
<blockquote>
After moving the manuals to the project folders, I think we need:
<ul>
<li>push to master:
<ul>
<li>osmo-gsm-manuals.git
<ul>
<li>build and publish the documentation of all projects</li>
</ul></li>
</ul></li>
</ul>
</blockquote>
<p>that would be rather nice, but I would guess we could live without any<br />automatism here.</p>
<blockquote>
<ul>
<li>osmo-*.git
<ul>
<li>build and publish the documentation of that project</li>
</ul></li>
</ul>
</blockquote>
<p>this part is mandatory.</p>
<p>I guess with the lines below you're referring to the gerrit build verification?</p>
<blockquote>
<ul>
<li>push to gerrit:
<ul>
<li>osmo-gsm-manuals.git
<ul>
<li>build the documentation of all projects</li>
</ul>
</li>
<li>osmo-*.git
<ul>
<li>build the repo with its documentation</li>
</ul></li>
</ul></li>
</ul>
</blockquote>
<p>I guess in this case it would be sufficient to just verify for osmo-*.git when a commit happens<br />to that specific repo. I don't think it's strictly required to built-test osmo-*.git after any<br />change to osmo-gsm-manuals.git. I cannot really think of anything being committed to the 'common'<br />part that would break the builds right now (short of removing a file that others need), so we can<br />probably ignore that as a rather esoteric case.</p>
<p>In terms of the generated/published manuals, this new scheme woould also allow us<br />to build + publish manuals for specific versions, particularly the tagged versions.</p>
<p>So basically once we tag a given version of osmo-msc (e.g. 1.2.3) , it<br />should be possible to build the manuals for exactly that version of the<br />osmo-msc user manual. Ideally that would run automatically, but of<br />course it is also possible to trigger this manually.</p>
<p>One interesting questions is what kind of "common" part to use in that<br />case. Some pinned commit hash of osmo-gsm-manuals.git that's stored in osmo-msc.git<br />repository at the 1.2.3 tag? Or simply the masteer of<br />osmo-gsm-manuals.git?</p>
<p>Regards,<br /> Harald</p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=125222018-11-06T13:30:52Zosmith
<ul><li><strong>% Done</strong> changed from <i>0</i> to <i>30</i></li></ul><p>Thanks for the feedback!</p>
<p>Time for a status update. I've pushed my WIP code to osmith/move-manuals-to-project-repos branches in both osmo-msc.git and osmo-gsm-manuals.git. My plan is to make it work with MSC first (as proof of concept), then with all other projects.</p>
<ul>
<li>moved osmo-gsm-manuals.git/OsmoMSC to osmo-msc.git/doc/man</li>
<li>osmo-gsm-manuals.git installs the common files to $prefix/share/osmo-gsm-manuals (e.g. /usr/local/share/osmo-gsm-manuals):<br /><pre>
$ autoreconf -fi
$ ./configure
$ make
$ make install
</pre></li>
<li>a pkg-config file gets generated, with a custom "topdir" variable that points to $prefix/share/osmo-gsm-manuals</li>
<li>the new topdir variable is queried from pkg-config and used by the project's manual build Makefile.am instead of the old "TOPDIR := .." </li>
<li>"../build", "../common" was hardcoded in a lot of places, this was changed to use that variable where possible (asciidoc), or adjusted to use a symlink to $topdir/common (doxygen)</li>
<li>osmo-msc.git's pdf is building now (needs more polishing though, images are probably missing etc.)</li>
<li>osmo-msc.git builds the pdf only when --enable-man is specified at the configure line</li>
<li>the check for installed dependencies was moved from osmo-gsm-manuals.git's global Makefile to "osmo-gsm-manuals-check-depends" installed to $prefix/bin. It gets called inside osmo-msc.git's configure when --enable-man is set.</li>
<li>I have moved libosmocore.git/doc/vty/merge_doc.xsl to osmo-gsm-manuals.git/merge_doc.xsl. It was not used anywhere in libosmocore, but it is needed for building the manuals.</li>
</ul>
<p>Also I've noticed that GIT_VERSION and GIT_DATE are problematic here:<br /><a class="external" href="https://git.osmocom.org/osmo-gsm-manuals/tree/build/Makefile.asciidoc.inc">https://git.osmocom.org/osmo-gsm-manuals/tree/build/Makefile.asciidoc.inc</a></p>
<pre>
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" ../.`)
</pre>
<p>This won't work if ./configure is running in a source folder extracted from a release tarball.</p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=125332018-11-08T15:46:54Zosmith
<ul><li><strong>% Done</strong> changed from <i>30</i> to <i>50</i></li></ul>update:
<ul>
<li>all common pages from osmo-gsm-manuals.git can be built as standalone test now (to see if there are any syntax errors etc. in the common pages, and to see if the common build scripts are working)</li>
<li>made --enable-man work with out-of-tree builds</li>
<li>unix-time-to-fmt.py: use "unknown" if we're not in a git directory</li>
<li>both pdfs for msc get generated now, though there's content missing in the vty reference</li>
</ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=125522018-11-09T16:41:16Zosmith
<ul><li><strong>% Done</strong> changed from <i>50</i> to <i>60</i></li></ul>update:
<ul>
<li>fixed missing pages in the vty-reference pdfs</li>
<li>make checks from asciidoc Makefile work again</li>
<li>update Makefile.*.inc text comments</li>
<li>remove --publish from contrib/jenkins.sh, add a "publish" target to the common Makefile that gets included in each project</li>
</ul>
<p>And I've thought about creating a "osmo-gsm-manuals-dev" Debian package as part of this issue. But there doesn't seem to be any benefit to that until we can build the manuals as man pages (<a class="issue tracker-2 status-1 priority-1 priority-lowest" title="Feature: Generate man pages at build time from adoc files (New)" href="https://osmocom.org/issues/3386">#3386</a>). So instead of blowing up the patchset further with a new "debian"-folder, let's do that as part of the man pages issue.</p>
<p>I'll clean up the code, then submit the patches for review on Monday :)</p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=125562018-11-12T10:27:24Zosmith
<ul><li><strong>% Done</strong> changed from <i>60</i> to <i>70</i></li></ul>Patches submitted:
<ul>
<li><a class="external" href="https://gerrit.osmocom.org/#/q/topic:move-manuals+(status:open+OR+status:merged)">https://gerrit.osmocom.org/#/q/topic:move-manuals+(status:open+OR+status:merged)</a></li>
</ul>
<p>The manuals are only added to MSC so far. When this is reviewed, I can add them to the other project repositories as well.</p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=125852018-11-14T16:46:01Zneelsnhofmeyr@sysmocom.de
<ul><li><strong>Precedes</strong> <i><a class="issue tracker-2 status-6 priority-2 priority-default closed" href="/issues/3695">Feature #3695</a>: generate VTY reference manuals from 'make' directly</i> added</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=125942018-11-15T16:48:30Zosmith
<ul><li><strong>% Done</strong> changed from <i>70</i> to <i>80</i></li></ul><p>One patch in the patchset ("build manuals from the project repositories") did too many things at once:<br /><a class="external" href="https://gerrit.osmocom.org/#/c/osmo-gsm-manuals/+/11725/">https://gerrit.osmocom.org/#/c/osmo-gsm-manuals/+/11725/</a></p>
<p>I have split it up in multiple commits, and refactored the code so all the existing, project specific manuals build with autotools with the current folder structure before we finally move them. That will make the moving a lot easier, because we already know that all of them build. And it makes it easier to see that the changes don't break anything.</p>
<p>New patchset coming in tomorrow, my current code (that still needs clean up before pushing to gerrit) is in the "osmith/move-manuals-to-project-repos" branches in osmo-msc.git and osmo-gsm-manuals.git.</p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=126422018-11-21T15:35:42Zosmith
<ul></ul><p>The ~20 patches that change the buildsystem to autoconf/automake to get "make install" working have been merged (also with "make distcheck" support for consistency with the other Osmocom projects, so "make distcheck" will still work with ./configure --enable-manuals).</p>
<p>Jenkins tried to run ./jenkins.sh --publish and failed, I've patched the job so it doesn't do that anymore:<br /><a class="external" href="https://gerrit.osmocom.org/#/c/osmo-ci/+/11863/">https://gerrit.osmocom.org/#/c/osmo-ci/+/11863/</a></p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=126742018-11-23T15:43:09Zosmith
<ul><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>add manuals with commit history to the project repos (run the attached script)</i> added</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>repos using autotools: integrate with configure.ac, toplevel Makefile.am etc.</i> added</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>repos not using autotools: rename Makefile.am to Makefile and adjust it slightly</i> added</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>configure jenkins to build all manuals in the gerrit build verification</i> added</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>configure jenkins to build and publish manuals when a commit is merged to master</i> added</li><li><strong>File</strong> <a href="/attachments/3450">move-manuals.tar.gz</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/3450/move-manuals.tar.gz">move-manuals.tar.gz</a> added</li></ul><p><a class="user active" href="https://osmocom.org/users/91">neels</a>: you proposed in <a href="https://gerrit.osmocom.org/#/c/osmo-msc/+/11726/" class="external">here</a> that we keep the git history when moving the files, bypassing gerrit. I've attached a script that does this. Please read it once, edit the commit message if you like, and if you think it is fine, would you like to run it and push the changes to master of each repository? On my laptop, this takes a bit more than four minutes to move all manuals with the history.</p>
<p>The checklist items added are the last missing pieces to finally finishing this up.</p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=126762018-11-23T15:45:03Zosmith
<ul><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>delete project manuals from osmo-gsm-manuals.git</i> added</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=127532018-11-27T11:19:21Zosmith
<ul></ul><p>In argreement with Neels, I have executed the script and pushed the commits to an extra branch called <code>osmith/move-manuals-with-history</code>:</p>
<p>Left: dir name in osmo-gsm-manuals.git<br />Right: project git repo name<br /><pre>
OsmoBSC => osmo-bsc
OsmoBTS => osmo-bts
OsmoGGSN => osmo-ggsn
OsmoGSMTester => osmo-gsm-tester
OsmoHLR => osmo-hlr
OsmoMGW => osmo-mgw
OsmoMSC => osmo-msc
OsmoNITB => openbsc
OsmoPCU => osmo-pcu
OsmoSGSN => osmo-sgsn
OsmoSIPConnector => osmo-sip-connector
OsmoSTP => libosmo-sccp
OsmoTRX => osmo-trx
OsmocomBB => osmocom-bb
</pre></p>
<p>These dirs have not been moved, as they are obsolete. They only contained the vty reference, which could be easily restored anyway.<br /><pre>
OsmoMGCP: NOT MOVING
OsmoNAT: NOT MOVING
</pre></p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=127562018-11-27T15:25:05Zosmith
<ul><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>add manuals with commit history to the project repos (run the attached script)</i> set to Done</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>repos using autotools: integrate with configure.ac, toplevel Makefile.am etc.</i> set to Done</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>repos not using autotools: rename Makefile.am to Makefile and adjust it slightly</i> set to Done</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=127732018-11-28T09:31:53Zosmith
<ul></ul><p><a class="user active" href="https://osmocom.org/users/91">neels</a>: thanks for applying the patch to these repositories:<br /><pre>
OsmoBSC => osmo-bsc
OsmoBTS => osmo-bts
OsmoGGSN => osmo-ggsn
OsmoHLR => osmo-hlr
OsmoMGW => osmo-mgw
OsmoMSC => osmo-msc
OsmoPCU => osmo-pcu
OsmoSGSN => osmo-sgsn
OsmoSIPConnector => osmo-sip-connector
OsmoSTP => libosmo-sccp
OsmoTRX => osmo-trx
</pre></p>
<p>These following are still missing. They don't have a configure.ac in the top level, but the manuals can be built with <code>cd doc/manuals; make</code> as the commit message in their <code>osmith/move-manuals-with-history</code> branches says. Can you also merge those?<br /><pre>
OsmoNITB => openbsc
OsmocomBB => osmocom-bb
OsmoGSMTester => osmo-gsm-tester
</pre></p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=127742018-11-28T10:43:12Zosmith
<ul><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>install osmo-gsm-manuals dependencies on all relevant buildbots</i> added</li></ul><p>Patches for deletion of the moved manual dirs have been submitted:<br /><a class="external" href="https://gerrit.osmocom.org/#/q/topic:move-manuals+status:open">https://gerrit.osmocom.org/#/q/topic:move-manuals+status:open</a></p>
<p>Regarding build of manuals in CI, it seems that the buildbots, on which the project related builds run, do not have all dependencies installed:</p>
<p><a class="external" href="https://jenkins.osmocom.org/jenkins/job/gerrit-osmo-bsc/a1=default,a2=default,a3=default,a4=default,label=osmocom-gerrit-debian9/1877/console">https://jenkins.osmocom.org/jenkins/job/gerrit-osmo-bsc/a1=default,a2=default,a3=default,a4=default,label=osmocom-gerrit-debian9/1877/console</a></p>
<pre>
Binary 'xsltproc' not found in path, please install libxslt.
configure: error: "missing dependencies!"
</pre>
<p>EDIT: the buildbots have all dependencies, but some jobs are running in Docker containers, and these don't have the dependencies. I can patch this though. Here's some documentation of how it all fits together: <a class="external" href="https://osmocom.org/projects/osmocom-servers/wiki/Jenkins_build_verification_jobs">https://osmocom.org/projects/osmocom-servers/wiki/Jenkins_build_verification_jobs</a></p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=127762018-11-28T13:42:16Zosmith
<ul><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>delete project manuals from osmo-gsm-manuals.git</i> set to Done</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=127772018-11-28T16:17:38Zneelsnhofmeyr@sysmocom.de
<ul></ul><p>osmith wrote:</p>
<blockquote>
<p>These following are still missing.</p>
</blockquote>
<p>ah thanks, completed now</p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=127922018-11-29T13:01:57Zosmith
<ul><li><b>Checklist item</b> deleted (<strike><i>install osmo-gsm-manuals dependencies on all relevant buildbots</i></strike>)</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>Osmocom Docker image: add dependencies for osmo-gsm-manuals</i> added</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>integrate manuals to osmocom-bb.git, openbsc.git, osmo-gsm-tester.git</i> added</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>contrib/jenkins.sh: build manuals and add --publish option</i> added</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>remove remaining project related files from osmo-gsm-manuals.git</i> added</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>jenkins job: master-builds.yml: run all project's contrib/jenkins.sh with --publish</i> added</li><li><strong>% Done</strong> changed from <i>80</i> to <i>90</i></li></ul><p>Getting closer to the finish line, new patches up for review.</p>
<p><a class="external" href="https://gerrit.osmocom.org/#/q/topic:move-manuals+status:open">https://gerrit.osmocom.org/#/q/topic:move-manuals+status:open</a></p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=127932018-11-29T15:46:48Zosmith
<ul><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>Osmocom Docker image: add dependencies for osmo-gsm-manuals</i> set to Done</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>remove remaining project related files from osmo-gsm-manuals.git</i> set to Done</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=128392018-12-05T14:49:29Zosmith
<ul><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>build and publish manuals for repos without configure.ac in the root directory (osmocom-bb, openbsc, osmo-gsm-tester)</i> added</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>whitelist the jenkins bots SSH keys for uploading to the docs server</i> added</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>enable PUBLISH=1 again (temporarily disabled due to missing upload permissions)</i> added</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>configure jenkins to build all manuals in the gerrit build verification</i> set to Done</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>configure jenkins to build and publish manuals when a commit is merged to master</i> set to Done</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>integrate manuals to osmocom-bb.git, openbsc.git, osmo-gsm-tester.git</i> set to Done</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>contrib/jenkins.sh: build manuals and add --publish option</i> set to Done</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>jenkins job: master-builds.yml: run all project's contrib/jenkins.sh with --publish</i> set to Done</li></ul>Update: I've noticed several other things and fixed them along the way:
<ul>
<li>osmo-mgw was built twice, with and without transcoding support, although it doesn't support that (leftover from old code)</li>
<li>docker arguments were formatted differently in gerrit-verifications.yml and master-builds.yml, which made it harder to check both files side-by-side</li>
<li>redundant environment variable specifications were confusing</li>
<li>openbsc.git's manuals had wrong names (e.g. osmo-nat instead of osmo-bsc-nat)</li>
<li>wrong distcheck variable was used in Makefile.am, so it could not be overruled in contrib/jenkins.sh</li>
</ul>
<p>The patches for extending the contrib/jenkins.sh files went through several iterations (in which some of the points above came up), and are finally in master of the respective Osmocom git repositories. The Jenkins jobs are adjusted to pass environment variables for building and publishing manuals. I've updated the TODO list.</p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=128532018-12-06T13:00:08Zlaforge
<ul><li><strong>Blocked by</strong> <i><a class="issue tracker-1 status-3 priority-3 priority-high3 closed" href="/issues/3720">Bug #3720</a>: Jenkins can't upload to rita.osmocom.org</i> added</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=129122018-12-12T13:10:18Zosmith
<ul><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>whitelist the jenkins bots SSH keys for uploading to the docs server</i> set to Done</li><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>enable PUBLISH=1 again (temporarily disabled due to missing upload permissions)</i> set to Done</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=129132018-12-12T13:10:58Zosmith
<ul></ul><p>These should be the final three patches:<br /><a class="external" href="https://gerrit.osmocom.org/#/q/topic:move-manuals+status:open">https://gerrit.osmocom.org/#/q/topic:move-manuals+status:open</a></p> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=129202018-12-12T14:01:27Zosmith
<ul><li><strong>Related to</strong> <i><a class="issue tracker-1 status-3 priority-2 priority-default closed" href="/issues/3725">Bug #3725</a>: Jenkins isn't using the credentials store for uploading to rita.osmocom.org</i> added</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=129252018-12-12T14:12:08Zosmith
<ul><li><strong>Related to</strong> <i><a class="issue tracker-1 status-3 priority-2 priority-default closed" href="/issues/3726">Bug #3726</a>: Jenkins: build all Osmocom projects in docker, not only some</i> added</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=129272018-12-12T16:32:51Zosmith
<ul><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' checked disabled> <i>build and publish manuals for repos without configure.ac in the root directory (osmocom-bb, openbsc, osmo-gsm-tester)</i> set to Done</li></ul> Cellular Network Infrastructure - Feature #3385: Move project specific manuals from osmo-gsm-manuals to each respective git repositoryhttps://osmocom.org/issues/3385?journal_id=129282018-12-12T16:33:43Zosmith
<ul><li><strong>Status</strong> changed from <i>In Progress</i> to <i>Resolved</i></li><li><strong>% Done</strong> changed from <i>90</i> to <i>100</i></li></ul><p>Finished \o/</p>