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

Bug#1020248: marked as done (debian-policy: Clarifying nomenclature for control file names)

Your message dated Sat, 24 Feb 2024 13:19:24 +0000
with message-id <E1rdrw4-002qqV-AV@fasolo.debian.org>
and subject line Bug#1020248: fixed in debian-policy 4.6.2.1
has caused the Debian Bug report #1020248,
regarding debian-policy: Clarifying nomenclature for control file names
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.)


-- 
1020248: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1020248
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message --- 
Package: debian-policy
Version: 4.6.1.1
Severity: wishlist

Hi!

This is a followup from my comment at:
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=998165#43

To summarize, we have IMO confusing naming and nomenclature for the
various control files and paragraphs/stanzas, and this is even
confusing me when having to deal with dpkg code, so I'd like to give
these more clear and unambiguous new names, and I'd very strongly
prefer to agree on the same naming for Debian policy and dpkg, to
avoid further and worse confusion (even though they currently do not
match exactly anyway, but I'd prefer to not make it worse…).

Just for reference and to give some context, I've got the following
WIP branches, trying to clarify the names in documentation and in the
API on, which I'll probably rework (split/merge) and reword as needed,
so do not take them as anything set in stone:

  https://git.hadrons.org/git/debian/dpkg/dpkg.git/log/?h=next/clarify-control-filenames
  https://git.hadrons.org/git/debian/dpkg/dpkg.git/log/?h=next/deb822-field-types


File descriptions
-----------------

For example we have:

  * debian/control:
    policy → «Source package control file»
    dpkg   → «Debian source packages' master control file»

  * .dsc:
    policy → «Debian source control file»
    dpkg   → «Debian source packages' control file»

  * DEBIAN/control
    policy → «Binary package control files»
    dpkg   → «Debian binary packages' master control file»

These are quite confusingly close.

I've been considering naming debian/control something like
«Debian template source package control file», as that is used to
generate both the source and binary control files. And always
prefixing with Debian, so that would end up as:

  * debian/control: «Debian source package template control file»
  * .dsc:           «Debian source package control file»
  * DEBIAN/control: «Debian binary package control file»

This also removes the «master» usage in dpkg, for me for the same
reasons as I covered at
<https://lists.debian.org/debian-dpkg/2021/03/msg00002.html>.


File contents
-------------

We have references to the various parts being called as «paragraphs»,
«stanza», «blocks», but this seems to be more of an issue with dpkg, as
the usage in the Debian policy is quite clear and uniform now, so I'll
at least try to remove the «block» usage there, stanza has the nice
property of being shorter and policy already mentions that this is
currently a common alias, so I might keep paragraph and stanza for now
in dpkg.

The other thing affecting dpkg and debian-policy is how the parts
within the control files are referred to. We have for example:

  dpkg   → «general section of control info file»
           «source stanza»
  policy → «general paragraph»

  dpkg   → «package's section of control info file»
  policy → «binary package paragraphs»


So, how does «source package paragraph» and «binary package paragraph»
(of the «template control file») sound instead?


If I've missed any other problematic nomenclature, I'm happy to
discuss and update those on the dpkg side.

Thanks,
Guillem

--- End Message ---
--- Begin Message --- 
Source: debian-policy
Source-Version: 4.6.2.1
Done: Sean Whitton <spwhitton@spwhitton.name>

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 1020248@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: Sat, 24 Feb 2024 20:39:43 +0800
Source: debian-policy
Architecture: source
Version: 4.6.2.1
Distribution: unstable
Urgency: medium
Maintainer: Debian Policy Editors <debian-policy@lists.debian.org>
Changed-By: Sean Whitton <spwhitton@spwhitton.name>
Closes: 793499 915583 1020248 1031403
Changes:
 debian-policy (4.6.2.1) unstable; urgency=medium
 .
   [ Guillem Jover ]
   * Standardize terminology with dpkg.  (Closes: #1020248)
     - Use 'stanza' for each section of a multi-section control file, such as
       the source package template control file (debian/control).
     - Use standardized naming for binary package control files, source
       package control files (.dsc), source package template control files
       (debian/control), and upload changes control files (.changes).
     - Refer to members of the control member of the .deb archive as
       'package metadata'.
   * Update Installed-Size algorithm used by dpkg (Closes: #793499).
 .
   [ Stéphane Blondon ]
   * New Debian-specific Sphinx style (Closes: #915583).
 .
   [ Max-Julian Pogner ]
   * Fix missing quotes in dpkg-divert examples. (Closes: #1031403)
Checksums-Sha1:
 1ca66544071b0942fdbd0f2fc155ff98e0794349 2136 debian-policy_4.6.2.1.dsc
 0194a75ba91649127927fc24df894f4c2e8740c6 554296 debian-policy_4.6.2.1.tar.xz
Checksums-Sha256:
 fc4f8728464f039ab2ff9063d28a9538e92cb68605d980ac608689306bfc80b6 2136 debian-policy_4.6.2.1.dsc
 0a69d1e25d821e6eb1e1773f4a8626ecdf2abf23ce50d0ba4e90208fd67052a3 554296 debian-policy_4.6.2.1.tar.xz
Files:
 9907e689604584693d5494d3133e71e0 2136 doc optional debian-policy_4.6.2.1.dsc
 d40f37ab7ab1b736b65844669a5baf01 554296 doc optional debian-policy_4.6.2.1.tar.xz

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

iQIzBAEBCgAdFiEEm5FwB64DDjbk/CSLaVt65L8GYkAFAmXZ48MACgkQaVt65L8G
YkCORQ/8D0vQa4AKBnKAmJd8QFrjbKMqSTphLlcq2kCaXnNEtTz0mtZ4YMQd+4lh
ce8J6/qOYarhkBSCvz//cb1WMDUXt4M9l0NoOMcw6rZHxzkUf315O8NLjktM0D52
/+HhdgMmE9IhzOqohNvmB/DiCogqfLQvKRswKdbr0FNIbeqv8CJAYZdatgoBIZVJ
zkpub9K3EM1tY3V5aRWi6rPj5QQIE0yMF1v+MP5aQc8cyTeE3YwPH1iAOJwgSUgE
CSBQqzYU1MgLVYipvVCp6at44Mpj32spUAOjXBxUGVfstR0lYzk6Q6y7nQwEb+rl
eFWkmSuY5ynkNAV1H4xvS4PVPFSHQU336cuUecc3c0TSynQ9fAi8tRfPgEW1UT87
mUmj8yjy8aSslv/Yhsb6/yULIJS0np01RXI4pBaTpu6CU2oVbtHJVW+Hcc4VKC7P
l5iN4CAV0wn8UqEXJPTd3TibtBlN0CbnfUIA6/ZxQq3CwI5OHp00PLPTHSoOEQe7
ZiurbnAAyI9Dlrn+lkUFMPF3ukeq6EaVelze/QMEB6BWP0ZAni7qWZKACaasuUkm
f/t+pWpVyZQx7CegSi2DGRnjsLD+wi2ylYu3GDvogrNR92I+kMgYOtX/PvSgJ904
FF3zt3K0ZNcsEkso456N/3Zcbp9/iwtxC6Pwtt2aLO5CdKj4QKU=
=9HMh
-----END PGP SIGNATURE-----

Attachment: pgpQfnhB8R6oW.pgp
Description: PGP signature


--- End Message ---
Reply to: