Project

General

Profile

Bug #3899

user manuals are not part of debian "-doc" packages

Added by laforge about 2 years ago. Updated almost 2 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Target version:
-
Start date:
04/03/2019
Due date:
% Done:

100%

Spec Reference:

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
  • all osmo repos: create "debian: create -doc subpackage with pdf manuals"
  • 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: merge "debian: create -doc subpackage with pdf manuals"
  • OBS: verify that osmo-gsm-manuals-dev builds in latest
  • 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

Associated revisions

Revision ad7b8bee (diff)
Added by osmith almost 2 years ago

debian: create -doc subpackage with pdf manuals

Related: OS#3899
Depends: I7edb5093e5b58eb3b0f7af2376476db4026db735 (osmo-gsm-manuals.git)
Depends: Ideeae4f7846fa5626fe2c1f5a77e07a3c6e626fe (osmo-ci.git)
Change-Id: I4c184c62804c0b805a0a2425a5bd0312e94e49ab

Revision 1ae52d1a (diff)
Added by osmith almost 2 years ago

debian: create -doc subpackage with pdf manuals

I have verified, that the resulting debian packages build in my own OBS
namespace (see the -doc packages):
https://download.opensuse.org/repositories/home:/osmith42/Debian_9.0/all/
https://build.opensuse.org/project/show/home:osmith42

Depends: Ib7251cca9116151e473798879375cd5eb48ff3ad (osmo-ci)
Related: OS#3899
Change-Id: I1f412953e60c10e6146327a90edbd18d738e1365

Revision 3f1f8573 (diff)
Added by osmith almost 2 years ago

debian: create -doc subpackage with pdf manuals

I have verified, that the resulting debian packages build in my own OBS
namespace (see the -doc packages):
https://download.opensuse.org/repositories/home:/osmith42/Debian_9.0/all/
https://build.opensuse.org/project/show/home:osmith42

Depends: Ib7251cca9116151e473798879375cd5eb48ff3ad (osmo-ci)
Related: OS#3899
Change-Id: I8dfb5658e567978aa8fe82f45d8287dbd1df969c

Revision dde4050c (diff)
Added by osmith almost 2 years ago

debian: create -doc subpackage with pdf manuals

I have verified, that the resulting debian packages build in my own OBS
namespace (see the -doc packages):
https://download.opensuse.org/repositories/home:/osmith42/Debian_9.0/all/
https://build.opensuse.org/project/show/home:osmith42

Depends: Ib7251cca9116151e473798879375cd5eb48ff3ad (osmo-ci)
Related: OS#3899
Change-Id: I9c09a0cb5c65fa2e2cd9817edb4656b2a1a35bb9

Revision 76a5013c (diff)
Added by osmith almost 2 years ago

debian: create -doc subpackage with pdf manuals

I have verified, that the resulting debian packages build in my own OBS
namespace (see the -doc packages):
https://download.opensuse.org/repositories/home:/osmith42/Debian_9.0/all/
https://build.opensuse.org/project/show/home:osmith42

Depends: Ib7251cca9116151e473798879375cd5eb48ff3ad (osmo-ci)
Related: OS#3899
Change-Id: I34858a18a34fc467f274ac164697a242f4cf0df8

Revision e05279a2 (diff)
Added by osmith almost 2 years ago

debian: create -doc subpackage with pdf manuals

I have verified, that the resulting debian packages build in my own OBS
namespace (see the -doc packages):
https://download.opensuse.org/repositories/home:/osmith42/Debian_9.0/all/
https://build.opensuse.org/project/show/home:osmith42

Depends: Ib7251cca9116151e473798879375cd5eb48ff3ad (osmo-ci)
Related: OS#3899
Change-Id: I6d7a182d0a668693a5014aca0edc50ada9ac0d0f

History

#1 Updated by osmith about 2 years ago

  • Status changed from New to In Progress

#2 Updated by osmith about 2 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
Patches created for:
  • 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
Local testing done:
  • osmo-gsm-manuals-dev builds (dpkg-buildpackage -tc -uc -us and with pbuilder 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.)

#3 Updated by osmith almost 2 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

#4 Updated by osmith almost 2 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/

#5 Updated by osmith almost 2 years ago

  • Checklist item osmo-gsm-manuals: tag version set to Done

#6 Updated by osmith almost 2 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.

#7 Updated by osmith almost 2 years ago

There were two dependency issues:

#8 Updated by laforge almost 2 years ago

just pushed those patches without waiting for +3 due to long delay without review :/

#9 Updated by osmith almost 2 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

#10 Updated by osmith almost 2 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.

#11 Updated by osmith almost 2 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.

#12 Updated by osmith almost 2 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
Everything tested in my own OBS namespace:

Remaining patches submitted:
https://gerrit.osmocom.org/#/q/topic:debian-doc-subpkg+status:open

Almost done, waiting for patch review :)

#13 Updated by osmith almost 2 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

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)