Project

General

Profile

Bug #3899

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

Added by laforge about 2 months ago. Updated 12 days ago.

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

60%

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.

History

#1 Updated by osmith about 2 months ago

  • Status changed from New to In Progress

#2 Updated by osmith about 1 month 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 about 1 month 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 about 1 month 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 about 1 month ago

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

#6 Updated by osmith about 1 month 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 about 1 month ago

There were two dependency issues:

#8 Updated by laforge 12 days ago

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

#9 Updated by osmith about 1 hour 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

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)