GNU bug report logs - #57636
[PATCH] Recognize zstandard (.zst) suffix in lisp/info.el

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 57636 in the body.
You can then email your comments to 57636 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Sam James <sam <at> gentoo.org>
To: bug-gnu-emacs <at> gnu.org
Cc: Sam James <sam <at> gentoo.org>
Subject: [PATCH] Recognize zstandard (.zst) suffix in lisp/info.el
Date: Wed,  7 Sep 2022 05:00:40 +0100

* lisp/info.el (Info-suffix-list): Recognize .zst file extension from the
zstd compression tool. This allos reading Info pages compressed with zstandard.
---
 lisp/info.el | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/lisp/info.el b/lisp/info.el
index 1a58910c3a..fdbe1f9b90 100644
--- a/lisp/info.el
+++ b/lisp/info.el
@@ -451,6 +451,7 @@ or `Info-virtual-nodes'."
        (".info.z"    . "gunzip")
        (".info.bz2"  . ("bzip2" "-dc"))
        (".info.xz"   . "unxz")
+       (".info.zst"  . ("unzstd" "--rm" "-q"))
        (".info"      . nil)
        ("-info.Z"    . "uncompress")
        ("-info.Y"    . "unyabba")
@@ -458,6 +459,7 @@ or `Info-virtual-nodes'."
        ("-info.bz2"  . ("bzip2" "-dc"))
        ("-info.z"    . "gunzip")
        ("-info.xz"   . "unxz")
+       ("-info.zst"  . ("unzstd" "--rm" "-q"))
        ("-info"      . nil)
        ("/index.Z"   . "uncompress")
        ("/index.Y"   . "unyabba")
@@ -465,6 +467,7 @@ or `Info-virtual-nodes'."
        ("/index.z"   . "gunzip")
        ("/index.bz2" . ("bzip2" "-dc"))
        ("/index.xz"  . "unxz")
+       ("/index.zst" . ("unzstd" "--rm" "-q"))
        ("/index"     . nil)
        (".Z"         . "uncompress")
        (".Y"         . "unyabba")
@@ -472,6 +475,7 @@ or `Info-virtual-nodes'."
        (".z"         . "gunzip")
        (".bz2"       . ("bzip2" "-dc"))
        (".xz"        . "unxz")
+       (".zst"       . ("unzstd" "--rm" "-q"))
        (""           . nil)))
   "List of file name suffixes and associated decoding commands.
 Each entry should be (SUFFIX . STRING); the file is given to
-- 
2.37.3

Message #8 received at 57636 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Sam James <sam <at> gentoo.org>
Cc: 57636 <at> debbugs.gnu.org
Subject: Re: bug#57636: [PATCH] Recognize zstandard (.zst) suffix in
 lisp/info.el
Date: Wed, 07 Sep 2022 14:35:58 +0300

> Cc: Sam James <sam <at> gentoo.org>
> From: Sam James <sam <at> gentoo.org>
> Date: Wed,  7 Sep 2022 05:00:40 +0100
> 
> * lisp/info.el (Info-suffix-list): Recognize .zst file extension from the
> zstd compression tool. This allos reading Info pages compressed with zstandard.
> ---
>  lisp/info.el | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/lisp/info.el b/lisp/info.el
> index 1a58910c3a..fdbe1f9b90 100644
> --- a/lisp/info.el
> +++ b/lisp/info.el
> @@ -451,6 +451,7 @@ or `Info-virtual-nodes'."
>         (".info.z"    . "gunzip")
>         (".info.bz2"  . ("bzip2" "-dc"))
>         (".info.xz"   . "unxz")
> +       (".info.zst"  . ("unzstd" "--rm" "-q"))

Thanks, but I don't think I understand the --rm part: these commands
aren't supposed to replace the original compressed file with its
decompressed version, they are supposed to write the decompressed text
to stdout, where it will be read by Emacs and displayed, and leave the
original compressed files alone.

So I think you want "-dc", not "--rm -q".  Am I missing something?

Message #13 received at 57636 <at> debbugs.gnu.org (full text, mbox):

From: Sam James <sam <at> gentoo.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 57636 <at> debbugs.gnu.org
Subject: Re: bug#57636: [PATCH] Recognize zstandard (.zst) suffix in
 lisp/info.el
Date: Thu, 8 Sep 2022 03:10:21 +0100

[Message part 1 (text/plain, inline)]

> On 7 Sep 2022, at 12:35, Eli Zaretskii <eliz <at> gnu.org> wrote:
> 
>> Cc: Sam James <sam <at> gentoo.org>
>> From: Sam James <sam <at> gentoo.org>
>> Date: Wed,  7 Sep 2022 05:00:40 +0100
>> 
>> * lisp/info.el (Info-suffix-list): Recognize .zst file extension from the
>> zstd compression tool. This allos reading Info pages compressed with zstandard.
>> ---
>> lisp/info.el | 4 ++++
>> 1 file changed, 4 insertions(+)
>> 
>> diff --git a/lisp/info.el b/lisp/info.el
>> index 1a58910c3a..fdbe1f9b90 100644
>> --- a/lisp/info.el
>> +++ b/lisp/info.el
>> @@ -451,6 +451,7 @@ or `Info-virtual-nodes'."
>>        (".info.z"    . "gunzip")
>>        (".info.bz2"  . ("bzip2" "-dc"))
>>        (".info.xz"   . "unxz")
>> +       (".info.zst"  . ("unzstd" "--rm" "-q"))
> 
> Thanks, but I don't think I understand the --rm part: these commands
> aren't supposed to replace the original compressed file with its
> decompressed version, they are supposed to write the decompressed text
> to stdout, where it will be read by Emacs and displayed, and leave the
> original compressed files alone.
> 
> So I think you want "-dc", not "--rm -q".  Am I missing something?

You're missing nothing and you're exactly right. Apologies
tor the error -- that seems obvious now!

I'll send a fixed version shortly.

[signature.asc (application/pgp-signature, attachment)]

Message #18 received at 57636 <at> debbugs.gnu.org (full text, mbox):

From: Sam James <sam <at> gentoo.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 57636 <at> debbugs.gnu.org
Subject: Re: bug#57636: [PATCH] Recognize zstandard (.zst) suffix in
 lisp/info.el
Date: Thu, 8 Sep 2022 04:03:55 +0100

[Message part 1 (text/plain, inline)]

From f5b4f91e74de2a1b724d978f6ca4f25c78a50389 Mon Sep 17 00:00:00 2001
From: Sam James <sam <at> gentoo.org>
Date: Wed, 7 Sep 2022 04:57:33 +0100
Subject: [PATCH] Recognize zstandard (.zst) suffix in lisp/info.el

* lisp/info.el (Info-suffix-list): Recognize .zst file extension from the
zstd compression tool. This allos reading Info pages compressed with zstandard.

Signed-off-by: Sam James <sam <at> gentoo.org>
---
 lisp/info.el | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/lisp/info.el b/lisp/info.el
index 1a58910c3a..292bf93a6f 100644
--- a/lisp/info.el
+++ b/lisp/info.el
@@ -451,6 +451,7 @@ or `Info-virtual-nodes'."
        (".info.z"    . "gunzip")
        (".info.bz2"  . ("bzip2" "-dc"))
        (".info.xz"   . "unxz")
+       (".info.zst"  . ("zstd" "-dc"))
        (".info"      . nil)
        ("-info.Z"    . "uncompress")
        ("-info.Y"    . "unyabba")
@@ -458,6 +459,7 @@ or `Info-virtual-nodes'."
        ("-info.bz2"  . ("bzip2" "-dc"))
        ("-info.z"    . "gunzip")
        ("-info.xz"   . "unxz")
+       ("-info.zst"  . ("zstd" "-dc"))
        ("-info"      . nil)
        ("/index.Z"   . "uncompress")
        ("/index.Y"   . "unyabba")
@@ -465,6 +467,7 @@ or `Info-virtual-nodes'."
        ("/index.z"   . "gunzip")
        ("/index.bz2" . ("bzip2" "-dc"))
        ("/index.xz"  . "unxz")
+       ("/index.zst" . ("zstd" "-dc"))
        ("/index"     . nil)
        (".Z"         . "uncompress")
        (".Y"         . "unyabba")
@@ -472,6 +475,7 @@ or `Info-virtual-nodes'."
        (".z"         . "gunzip")
        (".bz2"       . ("bzip2" "-dc"))
        (".xz"        . "unxz")
+       (".zst"       . ("zstd" "-dc"))
        (""           . nil)))
   "List of file name suffixes and associated decoding commands.
 Each entry should be (SUFFIX . STRING); the file is given to
--
2.37.3

[signature.asc (application/pgp-signature, attachment)]

Message #25 received at 57636-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Sam James <sam <at> gentoo.org>
Cc: 57636-done <at> debbugs.gnu.org
Subject: Re: bug#57636: [PATCH] Recognize zstandard (.zst) suffix in
 lisp/info.el
Date: Thu, 08 Sep 2022 11:52:12 +0300

> From: Sam James <sam <at> gentoo.org>
> Date: Thu, 8 Sep 2022 04:03:55 +0100
> Cc: 57636 <at> debbugs.gnu.org
> 
> From f5b4f91e74de2a1b724d978f6ca4f25c78a50389 Mon Sep 17 00:00:00 2001
> From: Sam James <sam <at> gentoo.org>
> Date: Wed, 7 Sep 2022 04:57:33 +0100
> Subject: [PATCH] Recognize zstandard (.zst) suffix in lisp/info.el
> 
> * lisp/info.el (Info-suffix-list): Recognize .zst file extension from the
> zstd compression tool. This allos reading Info pages compressed with zstandard.
> 
> Signed-off-by: Sam James <sam <at> gentoo.org>

Thanks, installed on the master branch.

For the future, please observe some of our coding conventions that in
this case caused me some manual work while applying the patch:

  . don't use Signed-off-by, our commit hooks reject that
  . lines in commit log messages should be shorter than 78 characters
  . we mention the bug number, when appropriate, in the commit log

Message #33 received at 57636-done <at> debbugs.gnu.org (full text, mbox):

From: Sam James <sam <at> gentoo.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 57636-done <at> debbugs.gnu.org
Subject: Re: bug#57636: [PATCH] Recognize zstandard (.zst) suffix in
 lisp/info.el
Date: Fri, 9 Sep 2022 05:21:27 +0100

[Message part 1 (text/plain, inline)]

> On 8 Sep 2022, at 09:52, Eli Zaretskii <eliz <at> gnu.org> wrote:
> 
>> From: Sam James <sam <at> gentoo.org>
>> Date: Thu, 8 Sep 2022 04:03:55 +0100
>> Cc: 57636 <at> debbugs.gnu.org
>> 
>> From f5b4f91e74de2a1b724d978f6ca4f25c78a50389 Mon Sep 17 00:00:00 2001
>> From: Sam James <sam <at> gentoo.org>
>> Date: Wed, 7 Sep 2022 04:57:33 +0100
>> Subject: [PATCH] Recognize zstandard (.zst) suffix in lisp/info.el
>> 
>> * lisp/info.el (Info-suffix-list): Recognize .zst file extension from the
>> zstd compression tool. This allos reading Info pages compressed with zstandard.
>> 
>> Signed-off-by: Sam James <sam <at> gentoo.org>
> 
> Thanks, installed on the master branch.
> 
> For the future, please observe some of our coding conventions that in
> this case caused me some manual work while applying the patch:
> 
>  . don't use Signed-off-by, our commit hooks reject that
>  . lines in commit log messages should be shorter than 78 characters
>  . we mention the bug number, when appropriate, in the commit log
> 

Many thanks and I'll keep these notes in mind.

I was struggling a bit with the ChangeLog format
as I've not had to use it much before, so
apologies for the line length issue too.

Appreciate the help & merge!

Best,
sam

[signature.asc (application/pgp-signature, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.