Bug#986357: Please improve package description
Hi! On Sat, 2023-02-25 at 03:58:34 +, peter green wrote: > As far as the current description goes, I think it's generally not > too bad but I think there are some minor improvements that could be > made. […] > * I feel it lacks a bit in "big picture", I *think* sqv is the main > command line tool for the sequoia project. If that is the case > it would be nice to say so expliciltly and upfront. The main CLI is sq. The sqv CLI is intended to be the equivalent of gpgv, as in a verification only tool, where the full blown thing is not necessary. > Also since > people will be comparing it with gpg it might be an idea to point > out explicitly whether things like web of trust support are > included. AFAIK there's a separate sq-wot tool for this. Other related projects include sq-keyring-linter and sqop, or even the GnuPG Chameleon, or openpgp-cert-d among others. > * I'm not sure a list of subcommands belongs in a package > description or if the description would be better sticking > to describing functionality. Given that the CLI is still in flux, I guess for now it might be helpful, but perhaps a more descriptive one might be better, dunno. Thanks, Guillem
Bug#986357: Please improve package description
On Sat, Feb 25, 2023 at 03:58:34AM +, peter green wrote: > It looks like the description we have today was written when sq was > first packaged, but wasn't actually incorporated into the package > until later because of > https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=993633 > > Version 0.25.0-1 simply had > > > Description: Command-line frontends for Sequoia > > This package contains the following binaries built from the Rust crate > > "sequoia-sq": > >- sq That's correct. I think now the description makes sense, and I like the improvements you propose. Enrico -- GPG key: 4096R/634F4BD1E7AD5568 2009-05-08 Enrico Zini
Bug#986357: Please improve package description
At the time you wrote this, i think the sq package description was pretty similar to what it is today: It looks like the description we have today was written when sq was first packaged, but wasn't actually incorporated into the package until later because of https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=993633 Version 0.25.0-1 simply had Description: Command-line frontends for Sequoia This package contains the following binaries built from the Rust crate "sequoia-sq": - sq As far as the current description goes, I think it's generally not too bad but I think there are some minor improvements that could be made. * It would be nice if we could get rid of the last couple of lines (which are generated by debcargo) somehow since they are largely redundant. Not sure if this is possible with current debcargo. * I feel it lacks a bit in "big picture", I *think* sqv is the main command line tool for the sequoia project. If that is the case it would be nice to say so expliciltly and upfront. Also since people will be comparing it with gpg it might be an idea to point out explicitly whether things like web of trust support are included. * I'm not sure a list of subcommands belongs in a package description or if the description would be better sticking to describing functionality.
Bug#986357: Please improve package description
Hi Enrico-- On Sun 2021-04-04 10:02:27 +0200, Enrico Zini wrote: > The package contains a user-facing tool, and the package description > contains mostly redundant technical details about how the package is > generated. > > Could you please update the description so that it explains what the sq > command is supposed to do, so that one could use the description to see > if it's a package that might do some of what they need? Sorry for the long delay in getting back to you. At the time you wrote this, i think the sq package description was pretty similar to what it is today: Description: OpenPGP command-line tool from Sequoia sq is a command-line interface for OpenPGP, structured using subcommands and implemented in Rust. . Subcommands include: help, decrypt, encrypt, sign, verify, armor, dearmor, autocrypt, inspect, key, keyring, certify, packet. . It offers modern cryptographic algorithms by default, like Ed25519 and Curve25519. . The tool offers both message handling (encryption, decryption, signing, and verification), and key and certificate management (key generation, certificate maintenance, and certification), and is interoperable with other major OpenPGP implementations like GnuPG (gpg). . WARNING: sq does not have a stable CLI interface yet. Use with caution in scripts. This package contains the following binaries built from the Rust crate "sequoia-sq": - sq This contains the fact that it's a command-line OpenPGP tool, describes the various things it can do, and references some comparable implementations (so people can find it if they search for GnuPG or gpg) Can you say a little bit more about what you would prefer it to say instead? --dkg signature.asc Description: PGP signature
Bug#986357: Please improve package description
Package: sq Version: 0.25.0-1 Severity: normal Hello, thanks for packaging Sequoia. The package contains a user-facing tool, and the package description contains mostly redundant technical details about how the package is generated. Could you please update the description so that it explains what the sq command is supposed to do, so that one could use the description to see if it's a package that might do some of what they need? Enrico -- System Information: Debian Release: 10.8 APT prefers stable APT policy: (500, 'stable') Architecture: amd64 (x86_64) Foreign Architectures: i386 Kernel: Linux 5.10.0-0.bpo.3-amd64 (SMP w/4 CPU cores) Kernel taint flags: TAINT_WARN Locale: LANG=en_IE.UTF-8, LC_CTYPE=en_IE.UTF-8 (charmap=UTF-8), LANGUAGE=en_IE:en (charmap=UTF-8) Shell: /bin/sh linked to /usr/bin/dash Init: systemd (via /run/systemd/system) LSM: AppArmor: enabled
