GNU bug report logs - #74329
[PATCH 0/2] Extensively lint descriptions and synopses.

Previous Next

Package: guix-patches;

Reported by: Gabriel Wicki <gabriel <at> erlikon.ch>

Date: Tue, 12 Nov 2024 20:38:02 UTC

Severity: normal

Tags: patch

Full log


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

From: Gabriel Wicki <gabriel <at> erlikon.ch>
To: 74329 <at> debbugs.gnu.org
Cc: vagrant <at> debian.org, ludo <at> gnu.org
Subject: [PATCH v2 5/6] gnu: Fix description beginnings.
Date: Sun, 5 Jan 2025 02:49:13 +0100
* gnu/packages/ibus.scm (ibus-libhangul): Fix description.
* gnu/packages/java-xml.scm (java-kxml2): Fix description.
* gnu/packages/java.scm (java-jsch-agentproxy-core,
java-jsch-agentproxy-sshagent, java-jsch-agentproxy-usocket-jna,
java-jsch-agentproxy-pageant, java-jsch-agentproxy-usocket-nc,
java-jsch-agentproxy-connector-factory, java-jsch-agentproxy-jsch): Fix
description.
* gnu/packages/linux.scm (libnetfilter-cthelper): Fix description.
* gnu/packages/python-xyz.scm (python-dbus): Fix description.
* gnu/packages/text-editors.scm (jucipp): Fix description.

Change-Id: Ib0aaebad8b08cdbc03652c4269bd2b1cd2ece0ba
---
 gnu/packages/ibus.scm         |  2 +-
 gnu/packages/java-xml.scm     |  6 ++---
 gnu/packages/java.scm         | 41 ++++++++++++++++++-----------------
 gnu/packages/linux.scm        |  4 ++--
 gnu/packages/python-xyz.scm   |  2 +-
 gnu/packages/text-editors.scm |  6 ++---
 6 files changed, 31 insertions(+), 30 deletions(-)

diff --git a/gnu/packages/ibus.scm b/gnu/packages/ibus.scm
index 0dfce29ea3..a1b54c0605 100644
--- a/gnu/packages/ibus.scm
+++ b/gnu/packages/ibus.scm
@@ -972,7 +972,7 @@ (define-public ibus-libhangul
     (home-page "https://github.com/libhangul/ibus-hangul")
     (synopsis "Hangul engine for IBus")
     (description
-     "ibus-hangul is a Korean input method engine for IBus.")
+     "Korean input method engine for IBus.")
     (license gpl2+)))
 
 (define-public ibus-table
diff --git a/gnu/packages/java-xml.scm b/gnu/packages/java-xml.scm
index 0153e26ef8..99b1cf47f1 100644
--- a/gnu/packages/java-xml.scm
+++ b/gnu/packages/java-xml.scm
@@ -552,9 +552,9 @@ (define-public java-kxml2
      (list java-junit))
     (home-page "http://kxml.org")
     (synopsis "XML pull parser")
-    (description "kXML is a small XML pull parser, specially designed for
-constrained environments such as Applets, Personal Java or devices compliant
-with the Mobile Information Device Profile (MIDP).")
+    (description "@emph{kXML} is a small XML pull parser, specially designed
+for constrained environments such as Applets, Personal Java or devices
+compliant with the Mobile Information Device Profile (MIDP).")
     (license license:expat)))
 
 (define-public java-stax
diff --git a/gnu/packages/java.scm b/gnu/packages/java.scm
index 679daf6fb5..29d9cdbe33 100644
--- a/gnu/packages/java.scm
+++ b/gnu/packages/java.scm
@@ -13241,9 +13241,9 @@ (define-public java-jsch-agentproxy-core
        #:tests? #f)); no tests
     (home-page "https://github.com/ymnk/jsch-agent-proxy")
     (synopsis "Core component of the proxy to ssh-agent and Pageant in Java")
-    (description "jsch-agent-proxy is a proxy program to OpenSSH's ssh-agent
-and Pageant included Putty.  It will be easily integrated into JSch, and users
-will be allowed to use these programs for authentication.")
+    (description "@command{jsch-agent-proxy} is a proxy program to OpenSSH's
+ssh-agent and Pageant included Putty.  It will be easily integrated into JSch,
+and users will be allowed to use these programs for authentication.")
     (license license:bsd-3)))
 
 (define-public java-jsch-agentproxy-sshagent
@@ -13257,9 +13257,9 @@ (define-public java-jsch-agentproxy-sshagent
     (inputs
      (list java-jsch-agentproxy-core))
     (synopsis "Proxy to ssh-agent")
-    (description "jsch-agent-proxy is a proxy program to OpenSSH's ssh-agent
-and Pageant included in Putty. This component contains the code for a proxy to
-ssh-agent.")))
+    (description "@command{jsch-agent-proxy} is a proxy program to OpenSSH's
+ssh-agent and Pageant included in Putty.  This component contains the code for
+a proxy to ssh-agent.")))
 
 (define-public java-jsch-agentproxy-usocket-jna
   (package
@@ -13272,9 +13272,9 @@ (define-public java-jsch-agentproxy-usocket-jna
     (inputs
      (list java-jsch-agentproxy-core java-native-access))
     (synopsis "USocketFactory implementation using JNA")
-    (description "jsch-agent-proxy is a proxy program to OpenSSH's ssh-agent
-and Pageant included in Putty. This component contains an implementation of
-USocketFactory using @dfn{JNA} (Java Native Access).")))
+    (description "@command{jsch-agent-proxy} is a proxy program to OpenSSH's
+ssh-agent and Pageant included in Putty.  This component contains an
+implementation of USocketFactory using @dfn{JNA} (Java Native Access).")))
 
 (define-public java-jsch-agentproxy-pageant
   (package
@@ -13288,9 +13288,9 @@ (define-public java-jsch-agentproxy-pageant
      (list java-jsch-agentproxy-core java-native-access
            java-native-access-platform))
     (synopsis "Proxy to pageant")
-    (description "jsch-agent-proxy is a proxy program to OpenSSH's ssh-agent
-and Pageant included in Putty. This component contains the code for a proxy to
-pageant.")))
+    (description "@command{jsch-agent-proxy} is a proxy program to OpenSSH's
+ssh-agent and Pageant included in Putty.  This component contains the code for
+a proxy to pageant.")))
 
 (define-public java-jsch-agentproxy-usocket-nc
   (package
@@ -13303,9 +13303,9 @@ (define-public java-jsch-agentproxy-usocket-nc
     (inputs
      (list java-jsch-agentproxy-core))
     (synopsis "USocketFactory implementation using netcat")
-    (description "jsch-agent-proxy is a proxy program to OpenSSH's ssh-agent
-and Pageant included in Putty. This component contains an implementation of
-USocketFactory using netcat.")))
+    (description "@command{jsch-agent-proxy} is a proxy program to OpenSSH's
+ssh-agent and Pageant included in Putty.  This component contains an
+implementation of USocketFactory using netcat.")))
 
 (define-public java-jsch-agentproxy-connector-factory
   (package
@@ -13320,8 +13320,9 @@ (define-public java-jsch-agentproxy-connector-factory
            java-jsch-agentproxy-usocket-jna java-jsch-agentproxy-pageant
            java-jsch-agentproxy-usocket-nc))
     (synopsis "Connector factory for jsch agent proxy")
-    (description "jsch-agent-proxy is a proxy program to OpenSSH's ssh-agent
-and Pageant included in Putty. This component contains a connector factory.")))
+    (description "@command{jsch-agent-proxy} is a proxy program to OpenSSH's
+ssh-agent and Pageant included in Putty.  This component contains a connector
+factory.")))
 
 (define-public java-jsch-agentproxy-jsch
   (package
@@ -13334,9 +13335,9 @@ (define-public java-jsch-agentproxy-jsch
     (inputs
      (list java-jsch java-jsch-agentproxy-core))
     (synopsis "JSch integration library for agentproxy")
-    (description "jsch-agent-proxy is a proxy program to OpenSSH's ssh-agent
-and Pageant included in Putty. This component contains a library to use
-jsch-agent-proxy with JSch.")))
+    (description "@command{jsch-agent-proxy} is a proxy program to OpenSSH's
+ssh-agent and Pageant included in Putty.  This component contains a library to
+use jsch-agent-proxy with JSch.")))
 
 (define-public java-apache-ivy
   (package
diff --git a/gnu/packages/linux.scm b/gnu/packages/linux.scm
index 214dafafbd..99db965223 100644
--- a/gnu/packages/linux.scm
+++ b/gnu/packages/linux.scm
@@ -8472,8 +8472,8 @@ (define-public libnetfilter-cthelper
     (native-inputs (list pkg-config))
     (inputs (list libmnl))
     (synopsis "Library for user-space connection tracking helpers")
-    (description "libnetfilter_cthelper is a userspace library that provides a
-programming interface to user-space connection tracking helpers.
+    (description "@emph{libnetfilter_cthelper} is a userspace library that
+provides a programming interface to user-space connection tracking helpers.
 @enumerate
 @item
 register new user-space connection tracking helpers
diff --git a/gnu/packages/python-xyz.scm b/gnu/packages/python-xyz.scm
index 1ce4e7a594..3239902492 100644
--- a/gnu/packages/python-xyz.scm
+++ b/gnu/packages/python-xyz.scm
@@ -13847,7 +13847,7 @@ (define-public python-dbus
      `(("python" ,python-wrapper)
        ("dbus-glib" ,dbus-glib)))
     (synopsis "Python bindings for D-bus")
-    (description "python-dbus provides bindings for libdbus, the reference
+    (description "Bindings for libdbus, the reference
 implementation of D-Bus.")
     (home-page "https://www.freedesktop.org/wiki/Software/DBusBindings/")
     (properties `((python2-variant . ,(delay python2-dbus))))
diff --git a/gnu/packages/text-editors.scm b/gnu/packages/text-editors.scm
index 9060fc72e2..8b4d1d0db7 100644
--- a/gnu/packages/text-editors.scm
+++ b/gnu/packages/text-editors.scm
@@ -624,9 +624,9 @@ (define-public jucipp
            universal-ctags))
     (synopsis "Lightweight C++ IDE")
     (description
-     "juCi++ is a small @acronym{IDE, Integrated Development Environment}
-designed especially towards libclang with speed, stability, and ease of use
-in mind.
+     "@emph{juCi++} is a small @acronym{IDE, Integrated Development
+Environment} designed especially towards libclang with speed, stability, and
+ease of use in mind.
 
 It supports autocompletion, on-the-fly warnings and errors, syntax
 highlighting, and integrates with Git as well as the CMake and Meson build
-- 
2.46.0





This bug report was last modified 142 days ago.

Previous Next


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