libpam-doc: doc-base reports missing files

[Dan Bungert]

[ Impact ]

 * In the pam 1.5.3-1 merge, documents formerly found in libpam-doc
   were omitted. Just a few documents remain in a package that
   formerly had many in /usr/share/doc/libpam-doc/{html,txt}.
 * A debdiff of the dropped files can be found in attachment
   1.5.2-9.1ubuntu3_to_1.5.3-5ubuntu5_libpam-doc.debdiff
 * The fix takes the form of correcting a build dependency, which
   results in the docs being again available.

[ Test Plan ]

 * debdiff
   * Obtain a copy of the current pam binary packages, perhaps with
     `pull-lp-debs libpam-doc 1.5.3-5ubuntu5`
   * Obtain a copy of the proposed pam binary packages, perhaps with
     `pull-lp-debs libpam-doc 1.5.3-5ubuntu5.1`
   * `debdiff libpam-doc_1.5.3-5ubuntu5{,.1}_all.deb`
     and verify that the documents are present
 * upgrade
   * Obtain a mantic test system - I personally used a mantic chroot
   * `apt install libpam-doc doc-base`
   * Adjust apt sources to change mantic to noble and ensure
     noble-proposed is present
   * `apt update; apt install libpam-doc/noble-proposed`
   * Verify that the "Error in /usr/share/doc-base" messages are no
     longer present

[ Where problems could occur ]

 * As usual, no SRU has zero risk
 * Any change to pam risks problems in user logins failing, so that is
   reflected in the regression test plan on LP: #2064350

[ Development release status ]

Issue fixed in merge from Debian and subsequent 1.5.3-7ubuntu1 upload.

[ Other Info ]

 * None at this time

original description follows:
---

Imported from Debian bug http://bugs.debian.org/1065064:

Package: libpam-doc
Version: 1.5.3-4
Severity: normal

An upgrade reported:

  Error in `/usr/share/doc-base/libpam-doc.pam-admin-guide', line 14: all `Format' sections are invalid.
  Error in `/usr/share/doc-base/libpam-doc.pam-applications-guide', line 17: all `Format' sections are invalid.
  Error in `/usr/share/doc-base/libpam-doc.pam-modules-guide', line 14: all `Format' sections are invalid.

This is true; all of /usr/share/doc/libpam-doc/html/Linux-PAM_SAG.html,
/usr/share/doc/libpam-doc/html/sag-*.html,
/usr/share/doc/libpam-doc/txt/Linux-PAM_SAG.txt.gz,
/usr/share/doc/libpam-doc/html/Linux-PAM_ADG.html,
/usr/share/doc/libpam-doc/html/adg*.html,
/usr/share/doc/libpam-doc/txt/Linux-PAM_ADG.txt.gz,
/usr/share/doc/libpam-doc/html/Linux-PAM_MWG.html,
/usr/share/doc/libpam-doc/html/mwg*.html, and
/usr/share/doc/libpam-doc/txt/Linux-PAM_MWG.txt.gz are listed in those
doc-base files but are in fact missing. I don't know whether this is
intentional (in which case the doc-base registrations should be removed
to match), or an accidental build issue that should be fixed.

-- System Information:
Debian Release: trixie/sid
  APT prefers unstable
  APT policy: (500, 'unstable'), (1, 'experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 6.6.0-14-generic (SMP w/4 CPU threads; PREEMPT)
Kernel taint flags: TAINT_PROPRIETARY_MODULE, TAINT_FIRMWARE_WORKAROUND, TAINT_OOT_MODULE
Locale: LANG=en_GB.UTF-8, LC_CTYPE=en_GB.UTF-8 (charmap=UTF-8), LANGUAGE=en_GB:en
Shell: /bin/sh linked to /usr/bin/dash
Init: unable to detect

-- no debconf information

--
Colin Watson (he/him) [<email address hidden>]

[Andreas Hasenack (ahasenack)]

For some reason which I cannot explain at the moment, a local build of 1.5.3-5ubuntu5.1 in noble does not produce the expected extra documentation files, so it doesn't look like the change in build-deps is enough to fix it.

[Dan Bungert (dbungert)]

I incorrectly ported this fix for 5ubuntu5.1. Will reupload.

[Dan Bungert (dbungert)]

Fixed version uploaded.

[Timo Aaltonen (tjaalton)]

Hello Dan, or anyone else affected,

Accepted pam into noble-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/pam/1.5.3-5ubuntu5.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-noble to verification-done-noble. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-noble. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[Dan Bungert (dbungert)]

I have self-verified the fix and it looks good. mantic schroot for the upgrade test.

[Ubuntu SRU Bot (ubuntu-sru-bot)]

All autopkgtests for the newly accepted pam (1.5.3-5ubuntu5.1) for noble have finished running.
The following regressions have been reported in tests triggered by the package:

cron/3.0pl1-184ubuntu2 (s390x)
dovecot/1:2.3.21+dfsg1-2ubuntu5 (s390x)
inetutils/2:2.5-3ubuntu4 (s390x)
libreswan/4.14-1ubuntu2 (s390x)
lxc/1:5.0.3-2ubuntu7 (s390x)
openssh/unknown (armhf, s390x)
samba/2:4.19.5+dfsg-4ubuntu9 (s390x)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/noble/update_excuses.html#pam

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

[Dan Bungert (dbungert)]

Marking fix released for Oracular, this was fixed but it wasn't noted in the changelog.

[Launchpad Janitor (janitor)]

This bug was fixed in the package pam - 1.5.3-5ubuntu5.1

---------------
pam (1.5.3-5ubuntu5.1) noble; urgency=medium

  [ Sam Hartman ]
  * Correct Build depends for docbook5 (LP: #2064360)
  * Depend on libdb-dev again, bringing back pam_userdb (LP: #2064350)

 -- Dan Bungert <email address hidden> Thu, 02 May 2024 16:20:13 -0600

[Brian Murray (brian-murray)]

The verification of the Stable Release Update for pam has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.