Skip to contentSkip to conversation

dpkg/Debian related terminology improvements/fixes

PATCH In review Guillem Jover 2 participants 7 messages May 9 – May 10 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

cover dpkg/Debian related terminology improvements/fixes

From: Guillem Jover <[email protected]>

Hi!

This series includes some fixes/improvements to dpkg/Debian adjacent information and terminology.

Thanks,
Guillem

Guillem Jover (3):
*/: Say OpenPGP instead of PGP man/man7/suffixes.7: Add xz suffixes man/man7/suffixes.7: Clarify Debian artifacts description

 CONTRIBUTING.d/mail             |  8 ++++----
 CONTRIBUTING.d/patches/sendmail |  2 +-
 man/man7/suffixes.7             | 10 ++++++----
 3 files changed, 11 insertions(+), 9 deletions(-)
Signature · 1 line
2.53.0
#1 lore raw

PATCH 1/3 */: Say OpenPGP instead of PGP

From: Guillem Jover <[email protected]>

The IETF draft is called OpenPGP, where PGP is the original implementation from where the specification was based on. For file artifacts «.pgp» is the correct short term to use though, which can be considered the more implementation neutral name to use.

---
 CONTRIBUTING.d/mail             | 8 ++++----
 CONTRIBUTING.d/patches/sendmail | 2 +-
 man/man7/suffixes.7             | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)
CONTRIBUTING.d/mail +4 -4
index f900c0a1b..84c8fbcfb 100644
@@ -41,18 +41,18 @@ Description
              it, go to
              <https://subspace.kernel.org/vger.kernel.org.html>.
 
-   Sign your emails with PGP
+   Sign your emails with OpenPGP
         We encourage that you sign all of your emails sent to the
         mailing list, (especially) including the ones containing
-        patches, with your PGP key.  This helps establish trust between
+        patches, with your OpenPGP key.  This helps establish trust between
         you and other contributors of this project, and prevent others
         impersonating you.  If you don't have a key, it's not mandatory
         to sign your email, but you're encouraged to create and start
-        using a PGP key.  See also:
+        using a OpenPGP key.  See also:
         <https://www.gnupg.org/faq/gnupg-faq.html#use_pgpmime>
 
         If you use mutt(1), we recommend the following configuration for
-        PGP:
+        OpenPGP:
 
             set crypt_autosign = yes
             set crypt_protected_headers_write = yes
CONTRIBUTING.d/patches/sendmail +1 -1
index f0a91f993..9f2c8f554 100644
@@ -32,7 +32,7 @@ Description
 		  ├─> [PATCH v3 02] ...
 		  └─> [PATCH v3 03] ...
 
-    Sign the email containing patches with PGP
+    Sign the email containing patches with OpenPGP
 	See <CONTRIBUTING.d/mail> for more details on signing your mail
 	to the list.  See also <CONTRIBUTING.d/git> for instructions for
 	configuring git-send-email(1) to use neomutt(1) as a driver.
man/man7/suffixes.7 +2 -2
index 3e17afc77..4c8b3f27a 100644
@@ -46,7 +46,7 @@ Suffix	File type
 \&.am	\f[B]automake\f[](1) input file
 \&.arc	\f[B]arc\f[](1) archive
 \&.arj	\f[B]arj\f[](1) archive
-\&.asc	PGP ASCII-armored data
+\&.asc	OpenPGP ASCII-armored data
 \&.asm	(GNU) assembler source file
 \&.au	Audio sound file
 \&.aux	LaTeX auxiliary file
@@ -177,7 +177,7 @@ T}
 \&.pfa	PostScript font definition files, ASCII format
 \&.pfb	PostScript font definition files, binary format
 \&.pgm	portable greymap format
-\&.pgp	PGP binary data
+\&.pgp	OpenPGP binary data
 \&.ph	Perl header file
 \&.php	PHP program file
 \&.php3	PHP3 program file
Signature · 1 line
2.53.0
#2 lore raw

Re: [PATCH 1/3] */: Say OpenPGP instead of PGP

Hi Guillem,

Quoted 4 lines · Guillem Jover

From: Guillem Jover <[email protected]>

The IETF draft is called OpenPGP, where PGP is the original implementation from where the specification was based on. For file

I've changed the inter-sentence space to 2.
<https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING.d/patches/description#n44>

Quoted 1 line

artifacts «.pgp» is the correct short term to use though, which can

And I've changed the quotes to ASCII ones ("), to avoid making the commit messages unnecessarily unreadable for those still using for example the C locale.

Quoted 3 lines

be considered the more implementation neutral name to use.

Thanks! I've applied the patch.

Cheers,
Alex

Quoted 72 lines
---
 CONTRIBUTING.d/mail             | 8 ++++----
 CONTRIBUTING.d/patches/sendmail | 2 +-
 man/man7/suffixes.7             | 4 ++--
 3 files changed, 7 insertions(+), 7 deletions(-)
CONTRIBUTING.d/mail +4 -4
index f900c0a1b..84c8fbcfb 100644
@@ -41,18 +41,18 @@ Description
              it, go to
              <https://subspace.kernel.org/vger.kernel.org.html>.
 
-   Sign your emails with PGP
+   Sign your emails with OpenPGP
         We encourage that you sign all of your emails sent to the
         mailing list, (especially) including the ones containing
-        patches, with your PGP key.  This helps establish trust between
+        patches, with your OpenPGP key.  This helps establish trust between
         you and other contributors of this project, and prevent others
         impersonating you.  If you don't have a key, it's not mandatory
         to sign your email, but you're encouraged to create and start
-        using a PGP key.  See also:
+        using a OpenPGP key.  See also:
         <https://www.gnupg.org/faq/gnupg-faq.html#use_pgpmime>
 
         If you use mutt(1), we recommend the following configuration for
-        PGP:
+        OpenPGP:
 
             set crypt_autosign = yes
             set crypt_protected_headers_write = yes
CONTRIBUTING.d/patches/sendmail +1 -1
index f0a91f993..9f2c8f554 100644
@@ -32,7 +32,7 @@ Description
 		  ├─> [PATCH v3 02] ...
 		  └─> [PATCH v3 03] ...
 
-    Sign the email containing patches with PGP
+    Sign the email containing patches with OpenPGP
 	See <CONTRIBUTING.d/mail> for more details on signing your mail
 	to the list.  See also <CONTRIBUTING.d/git> for instructions for
 	configuring git-send-email(1) to use neomutt(1) as a driver.
man/man7/suffixes.7 +2 -2
index 3e17afc77..4c8b3f27a 100644
@@ -46,7 +46,7 @@ Suffix	File type
 \&.am	\f[B]automake\f[](1) input file
 \&.arc	\f[B]arc\f[](1) archive
 \&.arj	\f[B]arj\f[](1) archive
-\&.asc	PGP ASCII-armored data
+\&.asc	OpenPGP ASCII-armored data
 \&.asm	(GNU) assembler source file
 \&.au	Audio sound file
 \&.aux	LaTeX auxiliary file
@@ -177,7 +177,7 @@ T}
 \&.pfa	PostScript font definition files, ASCII format
 \&.pfb	PostScript font definition files, binary format
 \&.pgm	portable greymap format
-\&.pgp	PGP binary data
+\&.pgp	OpenPGP binary data
 \&.ph	Perl header file
 \&.php	PHP program file
 \&.php3	PHP3 program file
Signature · 1 line
2.53.0
Signature · 1 line
<https://www.alejandro-colomar.es>
#3 lore raw

PATCH 2/3 man/man7/suffixes.7: Add xz suffixes

In reply to Guillem Jover

From: Guillem Jover <[email protected]>

These are very common nowadays, for example by default Debian source packages use this compression method.

---
 man/man7/suffixes.7 | 2 ++
 1 file changed, 2 insertions(+)
man/man7/suffixes.7 +2 -0
index 4c8b3f27a..8487bb5a1 100644
@@ -216,6 +216,7 @@ T}
 \&.tar.Z	\f[B]tar\f[](1) archive compressed with \f[B]compress\f[](1)
 \&.tar.bz2	\f[B]tar\f[](1) archive compressed with \f[B]bzip2\f[](1)
 \&.tar.gz	\f[B]tar\f[](1) archive compressed with \f[B]gzip\f[](1)
+\&.tar.xz	\f[B]tar\f[](1) archive compressed with \f[B]xz\f[](1)
 \&.taz	\f[B]tar\f[](1) archive compressed with \f[B]compress\f[](1)
 \&.tcl	tcl source code
 \&.tex	TeX or LaTeX source
@@ -246,6 +247,7 @@ T}
 \&.xpm	X11 pixmap source
 \&.xs	Perl xsub file produced by h2xs
 \&.xsl	XSL stylesheet
+\&.xz	file compressed with \f[B]xz\f[](1)
 \&.y	\f[B]yacc\f[](1) or \f[B]bison\f[](1) (parser generator) files
 \&.z	T{
 File compressed using
Signature · 1 line
2.53.0
#4 lore raw

Re: [PATCH 2/3] man/man7/suffixes.7: Add xz suffixes

Quoted 6 lines · Guillem Jover

From: Guillem Jover <[email protected]>

These are very common nowadays, for example by default Debian source packages use this compression method.

Patch applied; thanks!

Cheers,
Alex

Quoted 28 lines
---
 man/man7/suffixes.7 | 2 ++
 1 file changed, 2 insertions(+)
man/man7/suffixes.7 +2 -0
index 4c8b3f27a..8487bb5a1 100644
@@ -216,6 +216,7 @@ T}
 \&.tar.Z	\f[B]tar\f[](1) archive compressed with \f[B]compress\f[](1)
 \&.tar.bz2	\f[B]tar\f[](1) archive compressed with \f[B]bzip2\f[](1)
 \&.tar.gz	\f[B]tar\f[](1) archive compressed with \f[B]gzip\f[](1)
+\&.tar.xz	\f[B]tar\f[](1) archive compressed with \f[B]xz\f[](1)
 \&.taz	\f[B]tar\f[](1) archive compressed with \f[B]compress\f[](1)
 \&.tcl	tcl source code
 \&.tex	TeX or LaTeX source
@@ -246,6 +247,7 @@ T}
 \&.xpm	X11 pixmap source
 \&.xs	Perl xsub file produced by h2xs
 \&.xsl	XSL stylesheet
+\&.xz	file compressed with \f[B]xz\f[](1)
 \&.y	\f[B]yacc\f[](1) or \f[B]bison\f[](1) (parser generator) files
 \&.z	T{
 File compressed using
Signature · 1 line
2.53.0
Signature · 1 line
<https://www.alejandro-colomar.es>
#5 lore raw

PATCH 3/3 man/man7/suffixes.7: Clarify Debian artifacts description

In reply to Guillem Jover

From: Guillem Jover <[email protected]>

The terminology for these artifacts was "recently" updated to make them consistent and more clear, where both dpkg and the Debian Policy now have matching terminology. Refer to the dpkg man pages for further information and format description.

---
 man/man7/suffixes.7 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
man/man7/suffixes.7 +2 -2
index 8487bb5a1..8408aaadd 100644
@@ -79,7 +79,7 @@ Suffix	File type
 \&.csh	\f[B]csh\f[](1) shell script
 \&.cxx	equivalent to \f[I].cc\f[]
 \&.dat	data file
-\&.deb	Debian software package
+\&.deb	Debian binary package (\f[B]deb\f[](5))
 \&.def	Modula-2 source for definition modules
 \&.def	other definition files
 \&.desc	initial part of mail message unpacked with
@@ -91,7 +91,7 @@ command output)
 T}
 \&.dir	dbm data base directory file
 \&.doc	documentation file
-\&.dsc	Debian Source Control (source package)
+\&.dsc	Debian source package control file (\f[B]dsc\f[](5))
 \&.dtx	LaTeX package source file
 \&.dvi	TeX's device independent output
 \&.el	Emacs-Lisp source
Signature · 1 line
2.53.0
#6 lore raw

Re: [PATCH 3/3] man/man7/suffixes.7: Clarify Debian artifacts description

Hi Guillem,

Quoted 5 lines · Guillem Jover

From: Guillem Jover <[email protected]>

The terminology for these artifacts was "recently" updated to make them consistent and more clear, where both dpkg and the Debian Policy now have matching terminology. Refer to the dpkg man pages for further

I've changed inter-sentence space to 2.

Quoted 3 lines

information and format description.

Thanks! I've applied the patch.

Cheers,
Alex

Quoted 30 lines
---
 man/man7/suffixes.7 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
man/man7/suffixes.7 +2 -2
index 8487bb5a1..8408aaadd 100644
@@ -79,7 +79,7 @@ Suffix	File type
 \&.csh	\f[B]csh\f[](1) shell script
 \&.cxx	equivalent to \f[I].cc\f[]
 \&.dat	data file
-\&.deb	Debian software package
+\&.deb	Debian binary package (\f[B]deb\f[](5))
 \&.def	Modula-2 source for definition modules
 \&.def	other definition files
 \&.desc	initial part of mail message unpacked with
@@ -91,7 +91,7 @@ command output)
 T}
 \&.dir	dbm data base directory file
 \&.doc	documentation file
-\&.dsc	Debian Source Control (source package)
+\&.dsc	Debian source package control file (\f[B]dsc\f[](5))
 \&.dtx	LaTeX package source file
 \&.dvi	TeX's device independent output
 \&.el	Emacs-Lisp source
Signature · 1 line
2.53.0
Signature · 1 line
<https://www.alejandro-colomar.es>