GNU bug report logs - #34829
usbutils description same as synopsis

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 34829 in the body.
You can then email your comments to 34829 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: mikadoZero <mikadozero <at> yandex.com>
To: bug-guix <at> gnu.org
Subject: usbutils description same as synopsis
Date: Tue, 12 Mar 2019 14:36:30 -0400

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.

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

From: swedebugia <swedebugia <at> riseup.net>
To: bug-guix <at> gnu.org,mikadoZero <mikadozero <at> yandex.com>,34829 <at> debbugs.gnu.org
Subject: Re: bug#34829: usbutils description same as synopsis
Date: Wed, 13 Mar 2019 07:19:08 +0100

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

mikadoZero <mikadozero <at> yandex.com> skrev: (12 mars 2019 19:36:30 CET)
>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.

[Message part 2 (text/html, inline)]

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

From: mikadoZero <mikadozero <at> yandex.com>
To: Guix-patches <guix-patches <at> gnu.org>
Subject: [bug#34829] [PATCH] gnu: usbutils: Make package description different
 from synopsis.
Date: Sun, 24 Mar 2019 21:24:45 -0400

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 <at> 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 <at> 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(-)

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 <at> gmx.com>
 ;;; Copyright © 2018 Vasile Dumitrascu <va511e <at> yahoo.com>
 ;;; Copyright © 2019 Tim Gesthuizen <tim.gesthuizen <at> yahoo.de>
+;;; Copyright © 2019 mikadoZero <mikadozero <at> 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

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

From: Taylan Kammer <taylan.kammer <at> gmail.com>
To: mikadoZero <mikadozero <at> yandex.com>
Cc: Guix-patches <guix-patches <at> gnu.org>
Subject: Re: bug#34829: [PATCH] gnu: usbutils: Make package description
 different from synopsis.
Date: Mon, 25 Mar 2019 06:32:05 +0100

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

On Mon, Mar 25, 2019, 02:34 mikadoZero <mikadozero <at> yandex.com> wrote:

> There is a linting warning which is independent of this patch.
> `guix lint usbutils`
> usbutils <at> 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.

view-source:http://www.linux-usb.org

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

- Taylan

>

[Message part 2 (text/html, inline)]

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

From: Bruno Victal <mirai <at> makinata.eu>
To: 34829-done <at> debbugs.gnu.org
Subject: control-msg
Date: Wed, 19 Apr 2023 13:40:17 +0100

Done with a718f5f55bd005a93d1969238043776ead33d89e (via <https://issues.guix.gnu.org/62347>)

Previous Next

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