Gentoo Archives: gentoo-commits

From: Fabian Groffen <grobian@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] proj/portage-utils:master commit in: man/include/, /, man/
Date: Tue, 03 Apr 2018 15:21:06
Message-Id: 1522768783.454020200171d3d921b0f7e2229d4e527e1e6b2a.grobian@gentoo
1 commit: 454020200171d3d921b0f7e2229d4e527e1e6b2a
2 Author: Fabian Groffen <grobian <AT> gentoo <DOT> org>
3 AuthorDate: Tue Apr 3 15:19:43 2018 +0000
4 Commit: Fabian Groffen <grobian <AT> gentoo <DOT> org>
5 CommitDate: Tue Apr 3 15:19:43 2018 +0000
6 URL: https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=45402020
7
8 quse: improve documentation
9
10 Bug: https://bugs.gentoo.org/645554
11
12 man/include/quse.desc | 2 ++
13 man/include/quse.optdesc.yaml | 11 +++++++++++
14 man/quse.1 | 40 ++++++++++++++++++++++++----------------
15 quse.c | 4 ++--
16 4 files changed, 39 insertions(+), 18 deletions(-)
17
18 diff --git a/man/include/quse.desc b/man/include/quse.desc
19 new file mode 100644
20 index 0000000..7492774
21 --- /dev/null
22 +++ b/man/include/quse.desc
23 @@ -0,0 +1,2 @@
24 +\fIquse\fR searches in ebuilds for a match in IUSE, KEYWORDS or LICENSE.
25 +It can also search for USE-flags and show their descriptions.
26
27 diff --git a/man/include/quse.optdesc.yaml b/man/include/quse.optdesc.yaml
28 new file mode 100644
29 index 0000000..2a3675d
30 --- /dev/null
31 +++ b/man/include/quse.optdesc.yaml
32 @@ -0,0 +1,11 @@
33 +exact: Search for exact string, e.g.\ do not use regular expression matching.
34 +format: |
35 + Advanced option to manually override the variable searched for in
36 + ebuilds. By default, the search is \fIIUSE=\fR, the \fB\-K\fR and
37 + \fB\-L\fR override that to \fIKEYWORDS=\fR and \fILICENSE=\fR
38 + respectively. This option, sets the search to any variable. Note
39 + that the equals sign is part of the search, and needs to be set.
40 +verbose: |
41 + Show problems encountered during parsing. These are mostly
42 + diagnostic and indicate possible incorrectness in the results.
43 +quiet: Ignored for compatibility with other qapplets.
44
45 diff --git a/man/quse.1 b/man/quse.1
46 index e1e6db9..9b632b7 100644
47 --- a/man/quse.1
48 +++ b/man/quse.1
49 @@ -1,56 +1,64 @@
50 -.TH quse "1" "Mar 2016" "Gentoo Foundation" "quse"
51 +.\" generated by mkman.py, please do NOT edit!
52 +.TH quse "1" "Apr 2018" "Gentoo Foundation" "quse"
53 .SH NAME
54 quse \- find pkgs using useflags
55 .SH SYNOPSIS
56 .B quse
57 \fI[opts] <useflag>\fR
58 .SH DESCRIPTION
59 -
60 +\fIquse\fR searches in ebuilds for a match in IUSE, KEYWORDS or LICENSE.
61 +It can also search for USE-flags and show their descriptions.
62 .SH OPTIONS
63 .TP
64 \fB\-e\fR, \fB\-\-exact\fR
65 -Show exact non regexp matching using strcmp
66 +Search for exact string, e.g.\ do not use regular expression matching.
67 .TP
68 \fB\-a\fR, \fB\-\-all\fR
69 -Show annoying things in IUSE
70 +List all ebuilds, don't match anything.
71 .TP
72 \fB\-K\fR, \fB\-\-keywords\fR
73 -Use the KEYWORDS vs IUSE
74 +Use the KEYWORDS vs IUSE.
75 .TP
76 \fB\-L\fR, \fB\-\-license\fR
77 -Use the LICENSE vs IUSE
78 +Use the LICENSE vs IUSE.
79 .TP
80 \fB\-D\fR, \fB\-\-describe\fR
81 -Describe the USE flag
82 +Describe the USE flag.
83 .TP
84 \fB\-F\fR \fI<arg>\fR, \fB\-\-format\fR \fI<arg>\fR
85 -Use your own variable formats. -F NAME=
86 +Advanced option to manually override the variable searched for in
87 +ebuilds. By default, the search is \fIIUSE=\fR, the \fB\-K\fR and
88 +\fB\-L\fR override that to \fIKEYWORDS=\fR and \fILICENSE=\fR
89 +respectively. This option, sets the search to any variable. Note
90 +that the equals sign is part of the search, and needs to be set.
91 .TP
92 \fB\-N\fR, \fB\-\-name\-only\fR
93 -Only show package name
94 +Only show package name.
95 .TP
96 \fB\-\-root\fR \fI<arg>\fR
97 -Set the ROOT env var
98 +Set the ROOT env var.
99 .TP
100 \fB\-v\fR, \fB\-\-verbose\fR
101 -Make a lot of noise
102 +Show problems encountered during parsing. These are mostly
103 +diagnostic and indicate possible incorrectness in the results.
104 .TP
105 \fB\-q\fR, \fB\-\-quiet\fR
106 -Tighter output; suppress warnings
107 +Ignored for compatibility with other qapplets.
108 .TP
109 \fB\-C\fR, \fB\-\-nocolor\fR
110 -Don't output color
111 +Don't output color.
112 .TP
113 \fB\-h\fR, \fB\-\-help\fR
114 -Print this help and exit
115 +Print this help and exit.
116 .TP
117 \fB\-V\fR, \fB\-\-version\fR
118 -Print version and exit
119 +Print version and exit.
120
121 .SH "REPORTING BUGS"
122 Please report bugs via http://bugs.gentoo.org/
123 .br
124 -Product: Portage Development; Component: Tools
125 +Product: Portage Development; Component: Tools, Assignee:
126 +portage-utils@g.o
127 .SH AUTHORS
128 .nf
129 Ned Ludd <solar@g.o>
130
131 diff --git a/quse.c b/quse.c
132 index ea8a326..05ba2f4 100644
133 --- a/quse.c
134 +++ b/quse.c
135 @@ -1,5 +1,5 @@
136 /*
137 - * Copyright 2005-2014 Gentoo Foundation
138 + * Copyright 2005-2018 Gentoo Foundation
139 * Distributed under the terms of the GNU General Public License v2
140 *
141 * Copyright 2005-2010 Ned Ludd - <solar@g.o>
142 @@ -26,7 +26,7 @@ static struct option const quse_long_opts[] = {
143 };
144 static const char * const quse_opts_help[] = {
145 "Show exact non regexp matching using strcmp",
146 - "Show annoying things in IUSE",
147 + "List all ebuilds, don't match anything",
148 "Use the KEYWORDS vs IUSE",
149 "Use the LICENSE vs IUSE",
150 "Describe the USE flag",