bug#34829: usbutils description same as synopsis

bug#34829: usbutils description same as synopsis

[mikadoZero]

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.

bug#34829: usbutils description same as synopsis

[swedebugia]

[-- Attachment #1: Type: text/plain, Size: 376 bytes --]

mikadoZero <mikadozero@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.

[-- Attachment #2: Type: text/html, Size: 655 bytes --]

bug#34829: [PATCH] gnu: usbutils: Make package description different from synopsis.

[mikadoZero]

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

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

bug#34829: [PATCH] gnu: usbutils: Make package description different from synopsis.

[Taylan Kammer]

[-- Attachment #1: Type: text/plain, Size: 507 bytes --]

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

> 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.

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

>

[-- Attachment #2: Type: text/html, Size: 1326 bytes --]

[bug#62347] [PATCH 0/2] Update usbutils description & use G-Expression.

[Bruno Victal]

* Modernize with G-Expressions.
* Rebase #34829 [1] patch to resolve merge-conflict.
  * Applied minor texinfo tweaks and adjustments to commit message.


[1]: https://issues.guix.gnu.org/34829


Bruno Victal (1):
  gnu: usbutils: Use G-Expressions.

mikadoZero (1):
  gnu: usbutils: Make package description different from synopsis.

 gnu/packages/linux.scm | 39 ++++++++++++++++++++-------------------
 1 file changed, 20 insertions(+), 19 deletions(-)

-- 
2.39.1

[bug#62347] [PATCH 1/2] gnu: usbutils: Make package description different from synopsis.

[Bruno Victal]

From: mikadoZero <mikadozero@yandex.com>

* gnu/packages/linux.scm (usbutils)[description]:  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 ef05e77ec8..f0a590104b 100644
--- a/gnu/packages/linux.scm
+++ b/gnu/packages/linux.scm
@@ -33,6 +33,7 @@
 ;;; Copyright © 2018, 2019 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>
 ;;; Copyright © 2019, 2020, 2021, 2022 Maxim Cournoyer <maxim.cournoyer@gmail.com>
 ;;; Copyright © 2019 Stefan Stefanović <stefanx2ovic@gmail.com>
 ;;; Copyright © 2019-2022 Brice Waegeneire <brice@waegenei.re>
@@ -2399,9 +2400,10 @@ (define-public usbutils
      (list autoconf automake libtool 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 @command{lsusb}.")
     (license license:gpl2+)))
 
 (define-public usbip-utils

base-commit: d377cfbd11a96b98fd07a7ceb7e79590e1cee336
-- 
2.39.1

[bug#62347] [PATCH 2/2] gnu: usbutils: Use G-Expressions.

[Bruno Victal]

* gnu/packages/linux.scm (usbutils): Use G-Expressions.
---
 gnu/packages/linux.scm | 33 ++++++++++++++++-----------------
 1 file changed, 16 insertions(+), 17 deletions(-)

diff --git a/gnu/packages/linux.scm b/gnu/packages/linux.scm
index f0a590104b..240c62bb14 100644
--- a/gnu/packages/linux.scm
+++ b/gnu/packages/linux.scm
@@ -2377,23 +2377,22 @@ (define-public usbutils
     (build-system gnu-build-system)
     (outputs (list "out" "python"))
     (arguments
-     `(#:phases
-       (modify-phases %standard-phases
-         (add-before 'bootstrap 'patch-bootstrap-scripts
-           (lambda _
-             (substitute* "usbhid-dump/bootstrap"
-               (("/bin/sh") (which "sh")))))
-         (add-after 'install 'separate-python-output
-           ;; Separating one Python script shaves more than 106 MiB from :out.
-           (lambda* (#:key outputs #:allow-other-keys)
-             (let ((out        (assoc-ref outputs "out"))
-                   (out:python (assoc-ref outputs "python")))
-               (for-each (lambda (file)
-                           (let ((old (string-append out "/" file))
-                                 (new (string-append out:python "/" file)))
-                             (mkdir-p (dirname new))
-                             (rename-file old new)))
-                         (list "bin/lsusb.py"))))))))
+     (list
+      #:phases
+      #~(modify-phases %standard-phases
+          (add-before 'bootstrap 'patch-bootstrap-scripts
+            (lambda _
+              (substitute* "usbhid-dump/bootstrap"
+                (("/bin/sh") (which "sh")))))
+          (add-after 'install 'separate-python-output
+            ;; Separating one Python script shaves more than 106 MiB from :out.
+            (lambda _
+              (for-each (lambda (file)
+                          (let ((old (string-append #$output "/" file))
+                                (new (string-append #$output:python "/" file)))
+                            (mkdir-p (dirname new))
+                            (rename-file old new)))
+                        (list "bin/lsusb.py")))))))
     (inputs
      (list eudev libusb python))
     (native-inputs
-- 
2.39.1

bug#62347: [PATCH 0/2] Update usbutils description & use G-Expression.

[Ludovic Courtès]

Bruno Victal <mirai@makinata.eu> skribis:

> Bruno Victal (1):
>   gnu: usbutils: Use G-Expressions.
>
> mikadoZero (1):
>   gnu: usbutils: Make package description different from synopsis.

Applied, thanks!

bug#34829: control-msg

[Bruno Victal]

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