Skip to content

Commit

Permalink
man: fix -S/--slots option description in qlist.1
Browse files Browse the repository at this point in the history
I noticed that the qlist(1) man page did not mention that -S implies -I,
so I wanted to fix that.

The man page was actually supposed to mention it, but
man/include/qlist.optdesc.yaml was incorrectly using the "slot" key to
define --slots's long description, so the man page ended up using the
short description from  q list --help  instead of the longer description
that contains "This flag implies -I.".

Renaming the key in the yaml file from "slot" to "slots" fixed the
problem.

I have regenerated the man pages with man/mkman.py, but only included
the new version of qlist.1 in this commit.

Signed-off-by: Emanuele Torre <torreemanuele6@gmail.com>
Signed-off-by: Fabian Groffen <grobian@gentoo.org>
  • Loading branch information
emanuele6 authored and grobian committed Sep 5, 2024
1 parent 8ffeecf commit 3a525dc
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion man/include/qlist.optdesc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tree: |
umap: |
List USE-flags enabled when the package was installed. This flag
implies \fB\-I\fR.
slot: |
slots: |
Display installed packages with slots (use twice for subslots).
This flag implies \fB\-I\fR.
repo: |
Expand Down
3 changes: 2 additions & 1 deletion man/qlist.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" generated by mkman.py, please do NOT edit!
.TH qlist "1" "Jan 2024" "Gentoo Foundation" "qlist"
.TH qlist "1" "Sep 2024" "Gentoo Foundation" "qlist"
.SH NAME
qlist \- list files owned by pkgname
.SH SYNOPSIS
Expand Down Expand Up @@ -27,6 +27,7 @@ Used with \fB\-I\fR to list packages available in the tree.
.TP
\fB\-S\fR, \fB\-\-slots\fR
Display installed packages with slots (use twice for subslots).
This flag implies \fB\-I\fR.
.TP
\fB\-R\fR, \fB\-\-repo\fR
Display installed packages with repository the ebuild originated from.
Expand Down

0 comments on commit 3a525dc

Please sign in to comment.