Bug #3899
closeduser manuals are not part of debian "-doc" packages
100%
Description
Now that the user manuals are built alongside the source code, it would be very useful if the user manuals + VTY reference manuals were also packaged in a "-doc" debian sub-package, i.e. that osmo-bts-doc would contain the osmo-bts usermanual + vty reference manual.
Checklist
- osmo-gsm-manuals: merge all patches
- osmo-ci: merge "OBS: build osmo-gsm-manuals-dev in nightly"
- OBS: verify that osmo-gsm-manuals-dev builds in nightly
- osmo-bts: merge "debian: create -doc subpackage with pdf manuals"
- osmo-gsm-manuals: tag version
- osmo-ci: create "OBS: build osmo-gsm-manuals-dev in latest"
- osmo-ci: merge "OBS: build osmo-gsm-manuals-dev in latest"
- all osmo repos: create "debian: create -doc subpackage with pdf manuals"
- OBS: verify that osmo-gsm-manuals-dev builds in latest
- all osmo repos: merge "debian: create -doc subpackage with pdf manuals"
- OBS (osmith42): get all packages for all distros and all arches building with the "osmith/pdfs-in-doc-subpackage" branch
- Tag a release of osmo-gsm-manuals
- all osmo repos: submit "debian: create -doc subpackage with pdf manuals"
- OBS: verify that all packages are building after the merge
Updated by osmith about 5 years ago
- Checklist item osmo-gsm-manuals: merge all patches added
- Checklist item osmo-ci: merge "OBS: build osmo-gsm-manuals-dev in nightly" added
- Checklist item OBS: verify that osmo-gsm-manuals-dev builds in nightly added
- Checklist item osmo-bts: merge "debian: create -doc subpackage with pdf manuals" added
- Checklist item OBS: verify that osmo-bts-doc builds in nightly added
- Checklist item osmo-gsm-manuals: tag version added
- Checklist item osmo-ci: create "OBS: build osmo-gsm-manuals-dev in latest" added
- Checklist item osmo-ci: merge "OBS: build osmo-gsm-manuals-dev in latest" added
- Checklist item OBS: verify that osmo-gsm-manuals-dev builds in latest added
- Checklist item all osmo repos: create "debian: create -doc subpackage with pdf manuals" added
- Checklist item all osmo repos: merge "debian: create -doc subpackage with pdf manuals" added
- % Done changed from 0 to 50
- create osmo-gsm-manuals-dev debian package
- create osmo-bts-doc package (as example, other repos will follow)
- adjust osmo-ci to build osmo-gsm-manuals-dev
- osmo-gsm-manuals-dev builds (
dpkg-buildpackage -tc -uc -us
and withpbuilder
to make sure that dependencies are right) - osmo-bts builds with the new osmo-gsm-manuals-dev package and installs the manuals to
/usr/share/doc/osmocom/
pespin, since you have been doing the packaging for the most part, can you review the patches?
https://gerrit.osmocom.org/#/q/topic:debian-doc-subpkg
(The patches depending on others are set to WIP. As usually, on what they depend is listed in the commit message.)
Updated by osmith about 5 years ago
- Checklist item osmo-gsm-manuals: merge all patches set to Done
- Checklist item osmo-ci: merge "OBS: build osmo-gsm-manuals-dev in nightly" set to Done
Updated by osmith about 5 years ago
The OBS nightly job fails to build osmo-gsm-manuals-dev right now. It seems that a proper version is required, even for the nightly job: https://jenkins.osmocom.org/jenkins/job/Osmocom_OBS_nightly/54/console
Therefore I have prepared a 0.1.0 release here:
https://gerrit.osmocom.org/#/c/osmo-gsm-manuals/+/13635/
Updated by osmith about 5 years ago
- Checklist item osmo-gsm-manuals: tag version set to Done
Updated by osmith about 5 years ago
- % Done changed from 50 to 60
Release is tagged, the nightly jenkins job runs again. It uploads the source packages successfully.
However, OBS only builds the Ubuntu 18.04 and 18.10 packages so far. Packages for other distros have dependency issues:
https://build.opensuse.org/package/show/network:osmocom:nightly/osmo-gsm-manuals
I'm looking into it.
Updated by osmith about 5 years ago
There were two dependency issues:
- "have choice for jadetex needed by docbook-utils: jadetex texlive-formats-extra"
- Resolved by adjusting the project config
- asciidoc-dblatex does not exist in debian 8, but is necessary in debian 9
- Will be resolved by these two patches:
Updated by laforge almost 5 years ago
just pushed those patches without waiting for +3 due to long delay without review :/
Updated by osmith almost 5 years ago
- Checklist item OBS: verify that osmo-gsm-manuals-dev builds in nightly set to Done
- Checklist item osmo-bts: merge "debian: create -doc subpackage with pdf manuals" set to Done
Updated by osmith almost 5 years ago
For some reason, the osmo-gsm-manuals-dev deb is empty when built in OBS (although it has all data locally). Therefore osmo-bts failed to build with the osmo-gsm-manuals package from OBS. I've reverted the patch that makes use of osmo-gsm-manuals-dev in osmo-bts for now. Next up for me is looking into why that package is empty on OBS, creating a fix, and testing everything in my own OBS namespace before merging to master.
Updated by osmith almost 5 years ago
- Checklist item deleted (
OBS: verify that osmo-bts-doc builds in nightly) - Checklist item OBS (osmith42): get all packages for all distros and all arches building with the "osmith/pdfs-in-doc-subpackage" branch added
- Checklist item Tag a release of osmo-gsm-manuals added
- Checklist item all osmo repos: submit "debian: create -doc subpackage with pdf manuals" added
- Checklist item OBS: verify that all packages are building after the merge added
- Checklist item all osmo repos: create "debian: create -doc subpackage with pdf manuals" set to Done
- % Done changed from 60 to 70
Time to write an update.
- Empty package issue was fixed here (merged): https://gerrit.osmocom.org/#/c/osmo-gsm-manuals/+/14114/
- osmo-gsm-manuals needs more explicit dependencies to build on debian 8, fixed here (merged): https://gerrit.osmocom.org/#/c/osmo-gsm-manuals/+/14115/
- Repositories in my home:osmith42 namespace updated to current osmocom:nightly (since new repositories have been added there)
- I went through all Osmocom repositories and added the manuals subpackage patch
- Now I'm waiting for OBS to build the packages: https://build.opensuse.org/project/show/home:osmith42
Updated by osmith almost 5 years ago
- Checklist item osmo-ci: create "OBS: build osmo-gsm-manuals-dev in latest" set to Done
- Checklist item OBS: verify that osmo-gsm-manuals-dev builds in latest set to Done
- Checklist item OBS (osmith42): get all packages for all distros and all arches building with the "osmith/pdfs-in-doc-subpackage" branch set to Done
- Checklist item Tag a release of osmo-gsm-manuals set to Done
- Checklist item all osmo repos: submit "debian: create -doc subpackage with pdf manuals" set to Done
- % Done changed from 70 to 90
- https://build.opensuse.org/project/show/home:osmith42 (all packages built with osmocom-nightly-packages.sh)
- https://download.opensuse.org/repositories/home:/osmith42/Debian_9.0/all/ (resulting nightly -doc packages can be downloaded here)
- https://build.opensuse.org/project/show/home:osmith42:latest (osmo-gsm-manuals built with osmocom-latest.packages.sh)
Remaining patches submitted:
https://gerrit.osmocom.org/#/q/topic:debian-doc-subpkg+status:open
Almost done, waiting for patch review :)
Updated by osmith almost 5 years ago
- Checklist item osmo-ci: merge "OBS: build osmo-gsm-manuals-dev in latest" set to Done
- Checklist item all osmo repos: merge "debian: create -doc subpackage with pdf manuals" set to Done
- Checklist item OBS: verify that all packages are building after the merge set to Done
- Status changed from In Progress to Resolved
- % Done changed from 90 to 100