[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#914383: marked as done (debian-policy: re-encode virtual package list in YAML)



Your message dated Sun, 23 Dec 2018 10:49:07 +0000
with message-id <E1gb1Jj-000BRQ-JY@fasolo.debian.org>
and subject line Bug#914383: fixed in debian-policy 4.3.0.0
has caused the Debian Bug report #914383,
regarding debian-policy: re-encode virtual package list in YAML
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@bugs.debian.org
immediately.)


-- 
914383: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=914383
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message ---
Source: debian-policy
Severity: wishlist
Tags: patch

Implemented here:
<https://salsa.debian.org/jmtd/policy/commits/structured-vpackage-list>
<https://salsa.debian.org/jmtd/policy/commit/8948b734754f73022852c3839569e9416cb76ed1>

I repeat the commit log message here. It's worded in terms of absolutes, i.e.
"do this, do that", since that's what the commit does, however, please consider
this a proposal (which I am advocating for), i.e. "I propose converting...",
"I suggest deleting..." etc.

I've been thinking of this for a long time and another situation came up this
week where I thought it would be helpful so I sat down and did it.

----

Convert the plain-text virtual-package-names-list to a structured,
machine-readable document, encoded in YAML.

Delete the suffixed ChangeLog. From this point forward, changes to the file
should be recorded in the version control system in which Policy is maintained.

With the exception of the ChangeLog, preserve all the information in the text
version of the document, namely the virtual package name, the description, and
whether or not the virtual-package-provider normally provides an alternative.
The preamble and the section headings are preserved in the form of YAML
comments. The structured document should be just as legible for humans as the
prior version.

We expand the encoding of the alternative to include the binary path(s) that is
expected to be provided.

Rationale:

The current list cannot easily be machine-parsed. It's also likely out of date,
containing virtual package names that are not in use, and missing package names
that are in use. The pre-amble seems out-of-place and might better fit in the
policy document text.

By re-encoding in a machine-readable format, it shall be much easier to:

 • automate checking the status of the virtual package names herein against the
   names in use within the archive (e.g. from a UDD query).
 • check that a package which provides a virtual package name also registers
   paths in the alternatives system, if this document suggests it should (in
   e.g. lintian or some other QA tool)

I envisage many future possibilities, too, such as encoding more properties
about the "interface" of a program name registered as an alternative, such
as command-line arguments that should (or must) be accepted, etc.

The YAML schema is as follows (here in "Kwalify" syntax):

seq:
  - map:
      name: {type: str, required: True}
      description: {type: str, required: True}
      alternatives:
        seq:
         - {type: str, required: True}
        required: True

Future work:

 • simple tooling in the policy source tree to validate this file against
   the schema
 • house-keeping the list based on the names in use in-archive
 • lintian check for virtual package/alternatives correspondence
 • move the preamble out of this document and into a policy section
 • explore extensions to e.g. encode more properties about the nature of
   program names registered as alternatives


-- 
Jonathan Dowland

--- End Message ---
--- Begin Message ---
Source: debian-policy
Source-Version: 4.3.0.0

We believe that the bug you reported is fixed in the latest version of
debian-policy, which is due to be installed in the Debian FTP archive.

A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 914383@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Sean Whitton <spwhitton@spwhitton.name> (supplier of updated debian-policy package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@ftp-master.debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Format: 1.8
Date: Sun, 23 Dec 2018 10:17:55 +0000
Source: debian-policy
Binary: debian-policy debian-policy-ja
Architecture: source
Version: 4.3.0.0
Distribution: unstable
Urgency: medium
Maintainer: Debian Policy Editors <debian-policy@lists.debian.org>
Changed-By: Sean Whitton <spwhitton@spwhitton.name>
Description:
 debian-policy - Debian Policy Manual and related documents
 debian-policy-ja - Debian Policy Manual and related documents (Japanese)
Closes: 188731 833401 845715 850156 912581 914383
Changes:
 debian-policy (4.3.0.0) unstable; urgency=medium
 .
   * Policy: Update recommendations for stripping binaries and shlibs
     Wording: Sean Whitton <spwhitton@spwhitton.name>
     Seconded: Russ Allbery <rra@debian.org>
     Seconded: Niels Thykier <niels@thykier.net>
     Closes: #188731
   * Policy: Slightly relax when copyright information need be included verbatim
     Wording: Sean Whitton <spwhitton@spwhitton.name>
     Seconded: Holger Levsen <holger@layer-acht.org>
     Seconded: Russ Allbery <rra@debian.org>
     Closes: #912581
   * Policy: Required targets must not write outside of the source package tree
     Wording: Johannes Schauer <josch@debian.org>
     Wording: Bill Allombert <ballombe@debian.org>
     Seconded: Niels Thykier <niels@thykier.net>
     Seconded: Holger Levsen <holger@layer-acht.org>
     Closes: #845715
   * Policy: Packages should not contain a non-default series file
     Wording: Sean Whitton <spwhitton@spwhitton.name>
     Seconded: Russ Allbery <rra@debian.org>
     Seconded: gregor herrmann <gregoa@debian.org>
     Closes: #850156
   * virtual-package-names-list: Add dbus-session-bus, default-dbus-session-bus
     Wording: Sean Whitton <spwhitton@spwhitton.name>
     Seconded: Simon McVittie <smcv@debian.org>
     Seconded: gregor herrmann <gregoa@debian.org>
     Closes: #833401
   * In a preexisting footnote, recommend passing -D to strip(1) when
     stripping static libraries.
     Thanks to Niels Thykier for the suggestion.
   * Add references to 'next' branch in README.md.
   * Convert virtual-package-names-list to YAML (Closes: #914383).
     Thanks to Jonathan Dowland for the patch.
   * Append missing '.git' to Vcs-Git.
Checksums-Sha1:
 32d96d73dca550d5cf0babc5b77308764de35d9a 2023 debian-policy_4.3.0.0.dsc
 836885a7a30c7e61859bb4aae6aaca1fa7572ddc 531404 debian-policy_4.3.0.0.tar.xz
Checksums-Sha256:
 eb8b979248d8d29e4aec266e3e7abd0241c4a952126b1ea8a8cfb33f60435523 2023 debian-policy_4.3.0.0.dsc
 48d9001a15656fa5a16489c3103e24f77e7a57af7aa4cfdd0f413ee3a16597c7 531404 debian-policy_4.3.0.0.tar.xz
Files:
 97e6a98aa4092a1c1550ef0bf6bcc0ca 2023 doc optional debian-policy_4.3.0.0.dsc
 f78e87cf7eb7b1def1f42004a8279030 531404 doc optional debian-policy_4.3.0.0.tar.xz

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEm5FwB64DDjbk/CSLaVt65L8GYkAFAlwfYU0ACgkQaVt65L8G
YkD/qhAAtgMj7BOZOSB+jYjTcNgssuk4w3LH+8L2ATAPNlY/y6BH/YPIqIcio8MV
IXSn7ldU4rs7Ltz/g16aRCK7zBfA9fBDr/H/OsIaDmTNMtXKlJM0N9uczHVH4atk
bt88IcG/p6mGrf02IY4VRxgFMhRZtT5MlBY29rTit1e9vJizZCsd5bwyxZVKfnrb
BPuNuRkfzBR2PYQBrOf1R+9XvatqfZg1BveiRf1vaDpXxCpTOKWntKoxtwvhoN7N
OoNySzwTDeqvLJfO6CpkoNXqt0sFGjVs3DZxko0s206OqdV2szUXJXZxrEzYFQUO
yLzQ4jocG1qsGZHnkfLwOTQEPlXS0dVyGPZDX2FOYojpkwytsaVOyY5CduWBUyu2
yLUAxx1+Fkz4PHwtPzUfG+7/32Jq7ufJzgTmCdEmAkfYpN4sEhKMk9xrYfBfgkVS
YXDbCDDH4ENOZSgRG5RaHngxZ0/fM9yzPX+EZRsoWVGrlzeBck9EXzi2ERO1ncsx
MmIN5QUplsk5QXM7KkHj58v0BkrFSExsmJ7D9XMeqGDUOomiyBmGohwtahBjKtcq
QLOHlaccT/2n9KtwdUvqMTza/AKUszx9c6rFXMztffvnHfsLMgKWfU8RmpkwdvEv
I5PkxQzttUBCE0Xbvso4h4CXP+IdajASb+k+igMgqoO0Y/a90rI=
=fZNl
-----END PGP SIGNATURE-----

--- End Message ---

Reply to: