[gentoo-commits] proj/portage-utils:master commit in: man/include/, man/

[Fabian Groffen]

commit:     7de177d7ac1dff248f91e45bfdc3163629dae79e
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Mon Apr  2 18:59:02 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Mon Apr  2 18:59:02 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=7de177d7

qgrep: improve documentation

Bug: https://bugs.gentoo.org/645554

 man/include/qgrep.desc         |  3 +++
 man/include/qgrep.optdesc.yaml |  5 ++++
 man/qgrep.1                    | 54 +++++++++++++++++++++++-------------------
 3 files changed, 38 insertions(+), 24 deletions(-)

diff --git a/man/include/qgrep.desc b/man/include/qgrep.desc
new file mode 100644
index 0000000..c95d35a
--- /dev/null
+++ b/man/include/qgrep.desc
@@ -0,0 +1,3 @@
+\fIqgrep\fR searches for a given pattern in all ebuilds of the current
+portage tree.  Optionally the search is in all eclasses, or just in the
+ebuilds that are currently installed.

diff --git a/man/include/qgrep.optdesc.yaml b/man/include/qgrep.optdesc.yaml
new file mode 100644
index 0000000..87b174e
--- /dev/null
+++ b/man/include/qgrep.optdesc.yaml
@@ -0,0 +1,5 @@
+verbose: |
+    Print multiple matches per files.  When this option is given
+    multiple times, also linenumber are printed for matches next to file
+    names.
+quiet: Ignored for compatibility with other qapplets.

diff --git a/man/qgrep.1 b/man/qgrep.1
index e31e45a..bd140b3 100644
--- a/man/qgrep.1
+++ b/man/qgrep.1
@@ -1,80 +1,86 @@
-.TH qgrep "1" "Mar 2016" "Gentoo Foundation" "qgrep"
+.\" generated by mkman.py, please do NOT edit!
+.TH qgrep "1" "Apr 2018" "Gentoo Foundation" "qgrep"
 .SH NAME
 qgrep \- grep in ebuilds
 .SH SYNOPSIS
 .B qgrep
 \fI[opts] <misc args>\fR
 .SH DESCRIPTION
-
+\fIqgrep\fR searches for a given pattern in all ebuilds of the current
+portage tree.  Optionally the search is in all eclasses, or just in the
+ebuilds that are currently installed.
 .SH OPTIONS
 .TP
 \fB\-I\fR, \fB\-\-invert\-match\fR
-Select non-matching lines
+Select non-matching lines.
 .TP
 \fB\-i\fR, \fB\-\-ignore\-case\fR
-Ignore case distinctions
+Ignore case distinctions.
 .TP
 \fB\-H\fR, \fB\-\-with\-filename\fR
-Print the filename for each match
+Print the filename for each match.
 .TP
 \fB\-N\fR, \fB\-\-with\-name\fR
-Print the package or eclass name for each match
+Print the package or eclass name for each match.
 .TP
 \fB\-c\fR, \fB\-\-count\fR
-Only print a count of matching lines per FILE
+Only print a count of matching lines per FILE.
 .TP
 \fB\-l\fR, \fB\-\-list\fR
-Only print FILE names containing matches
+Only print FILE names containing matches.
 .TP
 \fB\-L\fR, \fB\-\-invert\-list\fR
-Only print FILE names containing no match
+Only print FILE names containing no match.
 .TP
 \fB\-e\fR, \fB\-\-regexp\fR
-Use PATTERN as a regular expression
+Use PATTERN as a regular expression.
 .TP
 \fB\-x\fR, \fB\-\-extended\fR
-Use PATTERN as an extended regular expression
+Use PATTERN as an extended regular expression.
 .TP
 \fB\-J\fR, \fB\-\-installed\fR
-Search in installed ebuilds instead of the tree
+Search in installed ebuilds instead of the tree.
 .TP
 \fB\-E\fR, \fB\-\-eclass\fR
-Search in eclasses instead of ebuilds
+Search in eclasses instead of ebuilds.
 .TP
 \fB\-s\fR, \fB\-\-skip\-comments\fR
-Skip comments lines
+Skip comments lines.
 .TP
 \fB\-S\fR \fI<arg>\fR, \fB\-\-skip\fR \fI<arg>\fR
-Skip lines matching <arg>
+Skip lines matching <arg>.
 .TP
 \fB\-B\fR \fI<arg>\fR, \fB\-\-before\fR \fI<arg>\fR
-Print <arg> lines of leading context
+Print <arg> lines of leading context.
 .TP
 \fB\-A\fR \fI<arg>\fR, \fB\-\-after\fR \fI<arg>\fR
-Print <arg> lines of trailing context
+Print <arg> lines of trailing context.
 .TP
 \fB\-\-root\fR \fI<arg>\fR
-Set the ROOT env var
+Set the ROOT env var.
 .TP
 \fB\-v\fR, \fB\-\-verbose\fR
-Make a lot of noise
+Print multiple matches per files.  When this option is given
+multiple times, also linenumber are printed for matches next to file
+names.
 .TP
 \fB\-q\fR, \fB\-\-quiet\fR
-Tighter output; suppress warnings
+Ignored for compatibility with other qapplets.
 .TP
 \fB\-C\fR, \fB\-\-nocolor\fR
-Don't output color
+Don't output color.
 .TP
 \fB\-h\fR, \fB\-\-help\fR
-Print this help and exit
+Print this help and exit.
 .TP
 \fB\-V\fR, \fB\-\-version\fR
-Print version and exit
+Print version and exit.
 
 .SH "REPORTING BUGS"
 Please report bugs via http://bugs.gentoo.org/
 .br
-Product: Portage Development; Component: Tools
+Product: Portage Development; Component: Tools, Assignee:
+portage-utils@g.o
 .SH AUTHORS
 .nf
 Ned Ludd <solar@g.o>