commit:     81df4a8cfbd2998e43842440bb2d57d620b6ff7d
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Tue Apr  3 13:13:21 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Tue Apr  3 13:13:21 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=81df4a8c

qsearch: improve documentation

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

 man/include/qsearch.desc         |  3 +++
 man/include/qsearch.optdesc.yaml |  2 ++
 man/qsearch.1                    | 36 ++++++++++++++++++++----------------
 qsearch.c                        |  6 +++---
 4 files changed, 28 insertions(+), 19 deletions(-)

diff --git a/man/include/qsearch.desc b/man/include/qsearch.desc
new file mode 100644
index 0000000..281c5a3
--- /dev/null
+++ b/man/include/qsearch.desc
@@ -0,0 +1,3 @@
+\fIqsearch\fR performs a search over the name and/or description of
+packages.  By default, a search over all package names is performed over
+all ebuilds in the tree.

diff --git a/man/include/qsearch.optdesc.yaml b/man/include/qsearch.optdesc.yaml
new file mode 100644
index 0000000..9bbaeaa
--- /dev/null
+++ b/man/include/qsearch.optdesc.yaml
@@ -0,0 +1,2 @@
+verbose: Ignored for compatibility with other qapplets.
+quiet: Ignored for compatibility with other qapplets.

diff --git a/man/qsearch.1 b/man/qsearch.1
index 5f888ba..3c6032d 100644
--- a/man/qsearch.1
+++ b/man/qsearch.1
@@ -1,56 +1,60 @@
-.TH qsearch "1" "Mar 2016" "Gentoo Foundation" "qsearch"
+.\" generated by mkman.py, please do NOT edit!
+.TH qsearch "1" "Apr 2018" "Gentoo Foundation" "qsearch"
 .SH NAME
 qsearch \- search pkgname/desc
 .SH SYNOPSIS
 .B qsearch
 \fI[opts] <regex>\fR
 .SH DESCRIPTION
-
+\fIqsearch\fR performs a search over the name and/or description of
+packages.  By default, a search over all package names is performed over
+all ebuilds in the tree.
 .SH OPTIONS
 .TP
 \fB\-a\fR, \fB\-\-all\fR
-List the descriptions of every package in the cache
+List the descriptions of every package in the cache.
 .TP
 \fB\-c\fR, \fB\-\-cache\fR
-Use the portage cache (default)
+Use the portage cache.
 .TP
 \fB\-e\fR, \fB\-\-ebuilds\fR
-Use the portage ebuild tree
+Use the portage ebuild tree (default).
 .TP
 \fB\-s\fR, \fB\-\-search\fR
-Regex search package basenames
+Regex search package basenames.
 .TP
 \fB\-S\fR \fI<arg>\fR, \fB\-\-desc\fR \fI<arg>\fR
-Regex search package descriptions
+Regex search package descriptions.
 .TP
 \fB\-N\fR, \fB\-\-name\-only\fR
-Only show package name
+Only show package name.
 .TP
 \fB\-H\fR, \fB\-\-homepage\fR
-Show homepage info
+Show homepage info.
 .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
+Ignored for compatibility with other qapplets.
 .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-ut...@gentoo.org
 .SH AUTHORS
 .nf
 Ned Ludd <so...@gentoo.org>

diff --git a/qsearch.c b/qsearch.c
index a620f95..4fce4de 100644
--- a/qsearch.c
+++ b/qsearch.c
@@ -1,5 +1,5 @@
 /*
- * Copyright 2005-2014 Gentoo Foundation
+ * Copyright 2005-2018 Gentoo Foundation
  * Distributed under the terms of the GNU General Public License v2
  *
  * Copyright 2005-2010 Ned Ludd        - <so...@gentoo.org>
@@ -21,8 +21,8 @@ static struct option const qsearch_long_opts[] = {
 };
 static const char * const qsearch_opts_help[] = {
        "List the descriptions of every package in the cache",
-       "Use the portage cache (default)",
-       "Use the portage ebuild tree",
+       "Use the portage cache",
+       "Use the portage ebuild tree (default)",
        "Regex search package basenames",
        "Regex search package descriptions",
        "Only show package name",

Reply via email to