usbutils description same as synopsis

  • Done
  • quality assurance status badge
Details
4 participants
  • mikadoZero
  • mirai
  • swedebugia
  • Taylan Kammer
Owner
unassigned
Submitted by
mikadoZero
Severity
normal
M
M
mikadoZero wrote on 12 Mar 2019 19:36
(address . bug-guix@gnu.org)
ef7cszwx.fsf@yandex.com
The description of the usbutils package is the same as it's synopsis.
It mentions that it includes tools but only mentions one. It would be
nice if the description provided further information.
S
S
swedebugia wrote on 13 Mar 2019 07:19
7C4AE97F-B729-4ABE-82F0-E42833C1C7DE@riseup.net
mikadoZero <mikadozero@yandex.com> skrev: (12 mars 2019 19:36:30 CET)
Toggle quote (4 lines)
>The description of the usbutils package is the same as it's synopsis.
>It mentions that it includes tools but only mentions one. It would be
>nice if the description provided further information.

Would you like to submit a patch with a better description?
--
Sent from my k-9 mail for Android.
Attachment: file
M
M
mikadoZero wrote on 25 Mar 2019 02:24
[bug#34829] [PATCH] gnu: usbutils: Make package description different from synopsis.
(name . Guix-patches)(address . guix-patches@gnu.org)
cucftrb690i.fsf@yandex.com
This is one of my first patches to Guix. Feedback is appreciated.

This patch provides a description for usbutils. Previously the
description was just a copy of the synopsis.

After looking at the usbutils readme I understand why the description
was a copy of the synopsis. There is not a lot of information on the
usbutils readme. So looking for additional information I ran `locate
usbutils` which listed these binaries:

lsusb
usb-devices
usbhid-dump

I have taking into account the descriptions from their man pages as well
as the usbutils readme and attempted a new description for usbutils.

There is a linting warning which is independent of this patch.
`guix lint usbutils`
usbutils@010: URI http://www.linux-usb.org/returned suspiciously small
file (369 bytes)

These build commands are successful:
guix build --rounds=4 usbutils
guix build --system=armhf-linux --rounds=4 usbutils
guix build --system=aarch64-linux --rounds=4 usbutils

--------

From 00a6add2736d3695b16f0c40177751852fbc6a67 Mon Sep 17 00:00:00 2001
From: mikadoZero <mikadozero@yandex.com>
Date: Sun, 24 Mar 2019 20:49:05 -0400
Subject: [PATCH] gnu: usbutils: Make package description different from
synopsis.

* gnu/packages/linux.scm (usbutils): Change package description.
---
gnu/packages/linux.scm | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)

Toggle diff (27 lines)
diff --git a/gnu/packages/linux.scm b/gnu/packages/linux.scm
index bc2219b1fa..9554ca4bfa 100644
--- a/gnu/packages/linux.scm
+++ b/gnu/packages/linux.scm
@@ -33,6 +33,7 @@
;;; Copyright © 2018 Pierre Langlois <pierre.langlois@gmx.com>
;;; Copyright © 2018 Vasile Dumitrascu <va511e@yahoo.com>
;;; Copyright © 2019 Tim Gesthuizen <tim.gesthuizen@yahoo.de>
+;;; Copyright © 2019 mikadoZero <mikadozero@yandex.com>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -785,9 +786,10 @@ slabtop, and skill.")
`(("pkg-config" ,pkg-config)))
(home-page "http://www.linux-usb.org/")
(synopsis
- "Tools for working with USB devices, such as lsusb")
+ "Tools for working with USB devices")
(description
- "Tools for working with USB devices, such as lsusb.")
+ "Collection of tools to query what type of USB devices are connected to the
+system, including lsusb.")
(license license:gpl2+)))
(define-public e2fsprogs
--
2.21.0
T
T
Taylan Kammer wrote on 25 Mar 2019 06:32
Re: bug#34829: [PATCH] gnu: usbutils: Make package description different from synopsis.
(name . mikadoZero)(address . mikadozero@yandex.com)(name . Guix-patches)(address . guix-patches@gnu.org)
CAJuFOK6mARVWzM7XQmoqf3Cg2TvH5VD9Vt3bos0j1hNQJhAk4Q@mail.gmail.com
On Mon, Mar 25, 2019, 02:34 mikadoZero <mikadozero@yandex.com> wrote:

Toggle quote (6 lines)
> There is a linting warning which is independent of this patch.
> `guix lint usbutils`
> usbutils@010: URI http://www.linux-usb.org/ returned suspiciously small
> file (369 bytes)
>

This seems to be because the website uses frames
for all its actual content.


I guess it's best to ignore the warning. Not sure if
the linter could be made intelligent enough to
handle this correctly.

- Taylan

Toggle quote (1 lines)
>
Attachment: file
M
M
mirai wrote on 5 Jan 2023 13:09
(no subject)
(name . control)(address . control@debbugs.gnu.org)
718b024b-13df-d894-eb64-faa56664e04d@makinata.eu
tags 34828 + patch
tags 34829 + patch
quit

--

bump for visibility
B
Closed
?