[Bug 1812696] Re: APT doc and manpage uses wrong ubuntu-codename

[Eric Desrochers]

** Changed in: apt (Ubuntu Disco)
       Status: New => In Progress

-- 
You received this bug notification because you are a member of Ubuntu
Foundations Bugs, which is subscribed to apt in Ubuntu.
https://bugs.launchpad.net/bugs/1812696

Title:
  APT doc and manpage uses wrong ubuntu-codename

Status in apt package in Ubuntu:
  In Progress
Status in apt source package in Trusty:
  Invalid
Status in apt source package in Xenial:
  New
Status in apt source package in Bionic:
  New
Status in apt source package in Cosmic:
  New
Status in apt source package in Disco:
  In Progress

Bug description:
  [Impact]

  APT documentation/example/manpages isn't referencing the current release
  which could be misleading for certain users.

  ---
  APT src code:
  ---
  [GOOD ubuntu-codename]

  * trusty:
  apt-1.0.1ubuntu2.18/doc/apt-verbatim.ent:<!ENTITY ubuntu-codename "trusty">

  [WRONG ubuntu-codename]

  * xenial:
  apt-1.2.29/doc/apt-verbatim.ent:<!ENTITY ubuntu-codename "trusty">

  * bionic:
  apt-1.6.7/doc/apt-verbatim.ent:<!ENTITY ubuntu-codename "xenial">

  * disco:
  apt-1.8.0~alpha3/doc/apt-verbatim.ent:<!ENTITY ubuntu-codename "xenial">
  ---

  * vendor/ubuntu/sources.list.in
  ---
  # See sources.list(5) manpage for more information
  # Remember that CD-ROMs, DVDs and such are managed through the apt-cdrom tool.
  deb http://us.archive.ubuntu.com/ubuntu &ubuntu-codename; main restricted
  deb-src http://us.archive.ubuntu.com/ubuntu &ubuntu-codename; main restricted

  deb http://security.ubuntu.com/ubuntu &ubuntu-codename;-security main restricted
  deb-src http://security.ubuntu.com/ubuntu &ubuntu-codename;-security main restricted

  deb http://us.archive.ubuntu.com/ubuntu &ubuntu-codename;-updates main restricted
  deb-src http://us.archive.ubuntu.com/ubuntu &ubuntu-codename;-updates main restricted
  ---

  The ubuntu-codename variable for Xenial and late in APT points to
  'trusty or 'xenial' which generate the doc example & manpage with the
  wrong release instead of the actual ubuntu-codename.

  APT in Xenial point to 'trusty'.
  APT in Bionic and late to 'xenial'

  It also affect the man page:

  Example took from Bionic:
  http://manpages.ubuntu.com/manpages/bionic/man5/sources.list.5.html
  http://manpages.ubuntu.com/manpages/bionic/man5/apt_preferences.5.html

  [Test Case]

  With Xenial and late:

   * Look sources.list(5) manpage
  Ex:
  http://manpages.ubuntu.com/manpages/bionic/man5/sources.list.5.html

   * Look apt_preferences(5) manpage
  Ex: http://manpages.ubuntu.com/manpages/bionic/man5/apt_preferences.5.html

   * Look /usr/share/doc/apt/examples/sources.list

  $ lsb_release -cs
  bionic

  $ cat /usr/share/doc/apt/examples/sources.list
  ----------------
  # See sources.list(5) manpage for more information
  # Remember that CD-ROMs, DVDs and such are managed through the apt-cdrom tool.
  deb http://us.archive.ubuntu.com/ubuntu xenial main restricted
  deb-src http://us.archive.ubuntu.com/ubuntu xenial main restricted

  deb http://security.ubuntu.com/ubuntu xenial-security main restricted
  deb-src http://security.ubuntu.com/ubuntu xenial-security main restricted

  deb http://us.archive.ubuntu.com/ubuntu xenial-updates main restricted
  deb-src http://us.archive.ubuntu.com/ubuntu xenial-updates main restricted
  ----------------------

  You'll notice they all point to the wrong release.

  While we understand it's not a "bug' and only a reference/example... 
  I think it's for the best interest of all if the examples/manpage reference the current release.

  [Regression Potential]

   * None, it only affect documentation/examples and manpages. No
  behavior change in the APT code.

  [Other Info]

  [Original Description]
  From APT src code :

  ---
  [GOOD ubuntu-codename]
  * trusty:
  apt-1.0.1ubuntu2.18/doc/apt-verbatim.ent:<!ENTITY ubuntu-codename "trusty">

  [WRONG ubuntu-codename]
  * xenial:
  apt-1.2.29/doc/apt-verbatim.ent:<!ENTITY ubuntu-codename "trusty">

  * bionic:
  apt-1.6.7/doc/apt-verbatim.ent:<!ENTITY ubuntu-codename "xenial">

  * disco:
  apt-1.8.0~alpha3/doc/apt-verbatim.ent:<!ENTITY ubuntu-codename "xenial">
  ---

  * vendor/ubuntu/sources.list.in
  ---
  # See sources.list(5) manpage for more information
  # Remember that CD-ROMs, DVDs and such are managed through the apt-cdrom tool.
  deb http://us.archive.ubuntu.com/ubuntu &ubuntu-codename; main restricted
  deb-src http://us.archive.ubuntu.com/ubuntu &ubuntu-codename; main restricted

  deb http://security.ubuntu.com/ubuntu &ubuntu-codename;-security main restricted
  deb-src http://security.ubuntu.com/ubuntu &ubuntu-codename;-security main restricted

  deb http://us.archive.ubuntu.com/ubuntu &ubuntu-codename;-updates main restricted
  deb-src http://us.archive.ubuntu.com/ubuntu &ubuntu-codename;-updates main restricted
  ---

  The ubuntu-codename variable for Bionic and late in APT points to
  Xenial which generate the doc example with Xenial instead of the
  actual codename.

  * ./doc/sources.list.5.xml | grep -i verbatim
  ---
  <!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
  ---

  It also seems to affect the man page by mentionning 'xenial'.
  Example took from Bionic:
  http://manpages.ubuntu.com/manpages/bionic/man5/sources.list.5.html
  http://manpages.ubuntu.com/manpages/bionic/man5/apt_preferences.5.html

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/apt/+bug/1812696/+subscriptions