[PATCH 0/2] Extensively lint descriptions and synopses.

  • Open
  • quality assurance status badge
Details
3 participants
  • Gabriel Wicki
  • Ludovic Courtès
  • Vagrant Cascadian
Owner
unassigned
Submitted by
Gabriel Wicki
Severity
normal
G
G
Gabriel Wicki wrote on 12 Nov 21:36 +0100
(address . guix-patches@gnu.org)(address . vagrant@debian.org)
hg3zpgjejjfuex7wmzr2ylpe3zbck7bldkpubw5li6y3r7tnas@nzckb4tbxcsy
Aloha

I've linted quite a bunch of descriptions and synopses after Vagrant asked
whether someone was up to that task[1] (:

So this is it. Going through all the warnings I found quite a bunch of false
positives, or at least cases where the linting rules do not reflect the
status-quo. I'll prepare a separate patch set for my suggestions in that
regard.

Thanks for merging and have a nice day,

gabber




Gabriel Wicki (1):
gnu: Lint descriptions.

gnu/packages/astronomy.scm | 4 +-
gnu/packages/audio.scm | 8 +-
gnu/packages/autotools.scm | 6 +-
gnu/packages/axoloti.scm | 12 +--
gnu/packages/bioconductor.scm | 25 ++++---
gnu/packages/bioinformatics.scm | 4 +-
gnu/packages/calendar.scm | 2 +-
gnu/packages/check.scm | 10 +--
gnu/packages/chez.scm | 16 ++--
gnu/packages/code.scm | 2 +-
gnu/packages/compression.scm | 4 +-
gnu/packages/connman.scm | 2 +-
gnu/packages/cran.scm | 56 +++++++-------
gnu/packages/crates-graphics.scm | 15 ++--
gnu/packages/crates-io.scm | 16 ++--
gnu/packages/crates-web.scm | 2 +-
gnu/packages/crypto.scm | 9 +--
gnu/packages/databases.scm | 2 +-
gnu/packages/display-managers.scm | 2 +-
gnu/packages/docker.scm | 2 +-
gnu/packages/elm.scm | 2 +-
gnu/packages/emacs-xyz.scm | 118 ++++++++++++++---------------
gnu/packages/emulators.scm | 2 +-
gnu/packages/fonts.scm | 4 +-
gnu/packages/fpga.scm | 4 +-
gnu/packages/freedesktop.scm | 2 +-
gnu/packages/game-development.scm | 4 +-
gnu/packages/games.scm | 6 +-
gnu/packages/geo.scm | 2 +-
gnu/packages/gnunet.scm | 10 +--
gnu/packages/golang-check.scm | 2 +-
gnu/packages/golang-web.scm | 2 +-
gnu/packages/golang-xyz.scm | 10 +--
gnu/packages/golang.scm | 7 +-
gnu/packages/guile.scm | 4 +-
gnu/packages/haskell-check.scm | 34 ++++-----
gnu/packages/haskell-web.scm | 2 +-
gnu/packages/haskell-xyz.scm | 80 +++++++++++---------
gnu/packages/ibus.scm | 2 +-
gnu/packages/image.scm | 9 ++-
gnu/packages/ipfs.scm | 4 +-
gnu/packages/java-xml.scm | 6 +-
gnu/packages/java.scm | 41 +++++-----
gnu/packages/kodi.scm | 7 +-
gnu/packages/linux.scm | 23 +++---
gnu/packages/lisp-xyz.scm | 16 ++--
gnu/packages/machine-learning.scm | 24 +++---
gnu/packages/messaging.scm | 2 +-
gnu/packages/minetest.scm | 2 +-
gnu/packages/monitoring.scm | 2 +-
gnu/packages/music.scm | 11 ++-
gnu/packages/node-xyz.scm | 4 +-
gnu/packages/ocaml.scm | 6 +-
gnu/packages/opencl.scm | 2 +-
gnu/packages/perl-check.scm | 6 +-
gnu/packages/perl.scm | 14 ++--
gnu/packages/python-xyz.scm | 12 +--
gnu/packages/qt.scm | 5 +-
gnu/packages/radio.scm | 4 +-
gnu/packages/rocm.scm | 6 +-
gnu/packages/rust-apps.scm | 2 +-
gnu/packages/scanner.scm | 16 ++--
gnu/packages/search.scm | 2 +-
gnu/packages/security-token.scm | 6 +-
gnu/packages/shells.scm | 2 +-
gnu/packages/shellutils.scm | 8 +-
gnu/packages/ssh.scm | 2 +-
gnu/packages/statistics.scm | 14 ++--
gnu/packages/tcl.scm | 6 +-
gnu/packages/tex.scm | 120 +++++++++++++++---------------
gnu/packages/text-editors.scm | 6 +-
gnu/packages/textutils.scm | 5 +-
gnu/packages/tor.scm | 2 +-
gnu/packages/xdisorg.scm | 8 +-
gnu/packages/xfce.scm | 4 +-
gnu/packages/xml.scm | 7 +-
gnu/packages/xorg.scm | 2 +-
77 files changed, 462 insertions(+), 452 deletions(-)


base-commit: 33665c52c4670bc3b4d337c89ac9cc6c4c69b26f
prerequisite-patch-id: 301c84e45a417b3160d86c9701a87eed73104779
--
2.46.0
G
G
Gabriel Wicki wrote on 12 Nov 21:41 +0100
[PATCH 1/2] gnu: Lint synopses.
(address . 74329@debbugs.gnu.org)
r5yqfuj77bsp6u5j2w5pvkucdu3uuhwh4sjjmca6yjxdrsr23s@53ci2hvht26e
Attachment: file
G
G
Gabriel Wicki wrote on 12 Nov 21:42 +0100
[PATCH 2/2] gnu: Lint descriptions.
(address . 74329@debbugs.gnu.org)
scqqmefa5trtody643fnxjbhpjnncmhskxgcbwakpt3ldehkvn@totouderoyx7
Attachment: file
G
G
Gabriel Wicki wrote on 21 Nov 23:28 +0100
resend?
(address . 74329@debbugs.gnu.org)
u6atqrimx5ypgtvgbthi7gpy3yd5dinky4kovete4k74s7me4j@dcdyyqqtsetn
seems like mumi can't handle the patches i submitted..?
G
G
Gabriel Wicki wrote on 21 Nov 23:30 +0100
[PATCH 1/2] gnu: Lint synopses.
(address . 74329@debbugs.gnu.org)
d6cpl4gfbzvbgkkbk7y3ernbcay7jvnvet3wcx5mqx3irlq5a2@d2lpinltiucu
Attachment: file
G
G
Gabriel Wicki wrote on 21 Nov 23:31 +0100
[PATCH 2/2] gnu: Lint descriptions.
(address . 74329@debbugs.gnu.org)
3ddhj5k4w45oq6zm4derfpry72ewewgc7t4v3io2jujxzuwtpp@sfbvjmbwh6uc
Attachment: file
V
V
Vagrant Cascadian wrote on 11 Dec 00:08 +0100
Re: [PATCH 0/2] Extensively lint descriptions and synopses.
(address . vagrant@debian.org)
87o71jt9ud.fsf@wireframe
On 2024-11-12, Gabriel Wicki wrote:
Toggle quote (3 lines)
> I've linted quite a bunch of descriptions and synopses after Vagrant asked
> whether someone was up to that task[1] (:

Apologies! You leapt to it, and I am taking way too long to respond!

While the comprehensiveness was very nice! ... The comingled changes
made it hard to cherry-pick the patches that were definitely immediately
mergeable from the ones that needed more thinking...

Also it was hard to review, as I was not CCed on the patches ... but I
can import the latest patches from the bug tracker, which I will do now!

Clearly even simple changes take effort...


Toggle quote (4 lines)
> Gabriel Wicki (1):
> gnu: Lint descriptions.
>
> gnu/packages/astronomy.scm | 4 +-
...
Toggle quote (3 lines)
> gnu/packages/xorg.scm | 2 +-
> 77 files changed, 462 insertions(+), 452 deletions(-)

A bit much to review in one pass. :)

I will try to make some more constructive comments soon after
downloading the latest patches and looking it over!


live well,
vagrant
-----BEGIN PGP SIGNATURE-----

iHUEARYKAB0WIQRlgHNhO/zFx+LkXUXcUY/If5cWqgUCZ1jJ6gAKCRDcUY/If5cW
qi+gAP9krXpkT3oEPKPobWO6fe3dYpMiLTRZ3zmyew18lMNIHQEA4oMzg740Wngo
bQYePyfryftZVL7fkvMK4Mn1NsJVYAY=
=Mfvj
-----END PGP SIGNATURE-----

V
V
Vagrant Cascadian wrote on 11 Dec 08:08 +0100
Re: [PATCH 1/2] gnu: Lint synopses.
(name . Gabriel Wicki)(address . gabriel@erlikon.ch)
87h67au26z.fsf@wireframe
On 2024-11-12, Gabriel Wicki wrote:
Toggle quote (7 lines)
> Subject: [PATCH 1/2] gnu: Lint synopses.
>
> Correct a bunch of synopses.
>
> Change-Id: I69fb52cc783994673e2eaf92b936edc19ba92cfe
> ---
> gnu/packages/astronomy.scm | 2 +-
...
Toggle quote (3 lines)
> gnu/packages/web.scm | 2 +-
> 57 files changed, 175 insertions(+), 178 deletions(-)

Thanks! I think that alone cleared around 200 guix lint warnings!

Pushed as several split commits:

6f8c8a86d827627f503a803381bce7fbcf8f39a0 gnu: Fix synopsis in miscelaneous packages.
1b7c85f24ea6bf455a31cb289dabeadff27687f1 gnu: Fix synopsis in various go packages.
8d05f0c8db93ccd5350cb8968fd96957ea9820b2 gnu: Fix synopsis in various python packages.
2159d8fc03487da400e6694d522a41b934a2a1aa gnu: Fix synopsis in various julia packages.
3ba56d011e5b568f653c5d1cc54e407e2e9062da gnu: Fix synopsis in various texlive packages.
b158f3fb7acb8a9677898e3cfffd21abf55dbafa gnu: Fix synopsis in rust packages.
44cc1295752edb7711471dce4872c41d740d10d0 gnu: Fix synopsis in various sbcl packages.
5d77267abd2ec8a4537304c22118166cd74c1620 gnu: Fix synopsis in various emacs packages.
1199a19ba7a1486ef016e8991d21d53e9c7eb990 gnu: Fix synopsis in various haskell packages.

I used guix.git/etc/committer.scm to help format the oh-so-verbose
commit messages, and then squashed the resulting individual patches into
several grouped semi-related patches, although it required a lot of
massaging to get it "right". Clearly I had to make it hard on myself. :)

I believe the changed files are more-or-less identical to what you
proposed, with only some minor rebasing needed.

In the future, somewhat smaller patch sets from the get-go would be
easier (and possibly quicker) to review and merge. Also, if the worst
happens, and it takes a long time to review (Like this time!
Oops. Sorry!), the individual patches might be more likely to merge
successfully than one or two huge mega-patches.

Still have to follow-up with the description patches (I did manage to
rebase it on a recent master, at least)... where I suspect I will have
more opinions... but that is for another day...

Thanks again!

live well,
vagrant
-----BEGIN PGP SIGNATURE-----

iHUEARYKAB0WIQRlgHNhO/zFx+LkXUXcUY/If5cWqgUCZ1k6ZAAKCRDcUY/If5cW
qriGAP4ynlLIEPKZN0e6Ai5EvmTpLe2sHGMlg1+JUJuQUqiM7wD9ED3aQFRDFrVs
//mgd1pI0fdpDOgGaEtA+dCJWVN5ggE=
=ZDi1
-----END PGP SIGNATURE-----

G
G
Gabriel Wicki wrote on 11 Dec 12:37 +0100
(name . Vagrant Cascadian)(address . vagrant@debian.org)(address . 74329@debbugs.gnu.org)
wwduxyj725js5ff3bn73twq6vx7ouwf6nqat5nza6tsdwp44sw@h2lagt5f2fge
On Tue, Dec 10, 2024 at 11:08:20PM -0800, Vagrant Cascadian wrote:
Toggle quote (1 lines)
> Thanks! I think that alone cleared around 200 guix lint warnings!
More than that - with my cleaning efforts, i also improved our linter,
since there were LOTS of false positives (or, the linter was just not
really up to the de facto standards in our codebase) - so i eliminated
the vast majority of lint warnings [0]

Toggle quote (4 lines)
> I used guix.git/etc/committer.scm to help format the oh-so-verbose
> commit messages, and then squashed the resulting individual patches into
> several grouped semi-related patches, although it required a lot of
> massaging to get it "right". Clearly I had to make it hard on myself. :)
I didn't know about that script! And also I had no idea what the
simplest format for all those changes would have been - maybe i
should've asked in advance (: Grouping them by family definitely makes
sense.

Thanks for merging,
g

L
L
Ludovic Courtès wrote 7 days ago
control message for bug #74329
(address . control@debbugs.gnu.org)
874j31meup.fsf@gnu.org
close 74329
quit
G
G
Gabriel Wicki wrote 6 days ago
8734ij1s5r.fsf@erlikon.ch
reopen 74329
thanks

Sorry ludo', i could have worded it more precisely:
Thanks for merging the first batch.

There's still a bunch of changes pending.
?
Your comment

Commenting via the web interface is currently disabled.

To comment on this conversation send an email to 74329@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 74329
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch