unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Bruno Victal <mirai@makinata.eu>
Cc: 62348@debbugs.gnu.org, ludo@gnu.org, mikadoZero <mikadozero@yandex.com>
Subject: [bug#62348] [PATCH 1/3] gnu: psmisc: Make description more informative.
Date: Tue, 21 Mar 2023 18:20:47 +0100	[thread overview]
Message-ID: <87v8iu10nk.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <40a8417b0c696509da522c9b5c072f004c0615f0.1679418658.git.mirai@makinata.eu> (Bruno Victal's message of "Tue, 21 Mar 2023 17:11:20 +0000")

Hello,

Bruno Victal <mirai@makinata.eu> writes:

> From: mikadoZero <mikadozero@yandex.com>
>
> The text for the description is taken from the psmisc readme.
>
> * gnu/packages/linux.scm (psmisc)[description]: Make description more
> informative.

Thanks.

> +     "A package of small utilities that use the proc file-system.

This should be a complete sentence, e.g.,

  Psmisc is a set of small utilities…

> +@itemize @bullet
> +@item @command{fuser} - Identifies processes using files or sockets
> +@item @command{killall} - kills processes by name, e.g. @samp{killall -HUP @var{name}}
> +@item @command{prtstat} - prints statistics of a process
> +@item @command{pslog} - prints log path(s) of a process
> +@item @command{pstree} - shows the currently running processes as a tree
> +@item @command{peekfd} - shows the data travelling over a file descriptor
> +@end itemize")

I suggest to remove the dashes, and probably add semicolons at the end
of all but last item:

  @item @command{fuser} identifies processes using files or sockets;

I suggest to add a comma after "e.g.", so Texinfo cannot consider it to
be the end of a sentence:

  @item @command{killall} kills processes by name, e.g., @samp{killall -HUP @var{name}};

Actually, I even wonder if providing an example if worth being in
a generic description. I probably belongs to a user manual:

  @item @command{killall} kills processes by name;

Regards,
-- 
Nicolas Goaziou




  reply	other threads:[~2023-03-21 17:21 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-21 17:04 [bug#62348] [PATCH 0/3] Update psmisc to 23.6 Bruno Victal
2023-03-21 17:11 ` [bug#62348] [PATCH 1/3] gnu: psmisc: Make description more informative Bruno Victal
2023-03-21 17:20   ` Nicolas Goaziou [this message]
2023-03-21 17:11 ` [bug#62348] [PATCH 2/3] gnu: psmisc: Use G-Expressions Bruno Victal
2023-03-21 17:11 ` [bug#62348] [PATCH 3/3] gnu: psmisc: Update to 23.6 Bruno Victal
2023-03-21 19:23 ` [bug#62348] [PATCH v2 1/3] gnu: psmisc: Make description more informative Bruno Victal
2023-03-21 19:23   ` [bug#62348] [PATCH v2 2/3] gnu: psmisc: Use G-Expressions Bruno Victal
2023-03-21 19:23   ` [bug#62348] [PATCH v2 3/3] gnu: psmisc: Update to 23.6 Bruno Victal
2023-08-24 16:52 ` [bug#62348] [PATCH v3 0/3] Improve psmisc description & update Bruno Victal
2023-08-24 16:54   ` [bug#62348] [PATCH v3 1/3] gnu: psmisc: Make description more informative Bruno Victal
2023-08-24 16:54   ` [bug#62348] [PATCH v3 2/3] gnu: psmisc: Use G-Expressions Bruno Victal
2023-08-24 16:54   ` [bug#62348] [PATCH v3 3/3] gnu: psmisc: Update to 23.6 Bruno Victal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87v8iu10nk.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=62348@debbugs.gnu.org \
    --cc=ludo@gnu.org \
    --cc=mikadozero@yandex.com \
    --cc=mirai@makinata.eu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).