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

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

[Fabian Groffen]

commit:     ec9c281b4fd5d4b36927c2b004bbcd0fe11f2d76
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Mon Apr  2 17:52:20 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Mon Apr  2 17:52:20 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=ec9c281b

qfile: update manpage

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

 man/include/qfile.desc         |  4 ++++
 man/include/qfile.optdesc.yaml |  7 +++++++
 man/qfile.1                    | 40 ++++++++++++++++++++++++----------------
 3 files changed, 35 insertions(+), 16 deletions(-)

diff --git a/man/include/qfile.desc b/man/include/qfile.desc
new file mode 100644
index 0000000..08d4bb3
--- /dev/null
+++ b/man/include/qfile.desc
@@ -0,0 +1,4 @@
+\fIqfile\fR searches packages for files they provide.  The searched
+packages must be installed, thus the search is for any file on the
+filesystem, to what package that file belongs.  It allows to identify
+which package installed a certain file.

diff --git a/man/include/qfile.optdesc.yaml b/man/include/qfile.optdesc.yaml
new file mode 100644
index 0000000..cb1cd7a
--- /dev/null
+++ b/man/include/qfile.optdesc.yaml
@@ -0,0 +1,7 @@
+verbose: |
+    Print package versions to matches, warn about problems with
+    resolving symlinks or positioning packages under an alternative
+    root.
+quiet: |
+    Don't print matching file for matches, just the package.  Don't
+    report about orphan files.

diff --git a/man/qfile.1 b/man/qfile.1
index 5bd58c7..ff92897 100644
--- a/man/qfile.1
+++ b/man/qfile.1
@@ -1,48 +1,55 @@
-.TH qfile "1" "Jun 2016" "Gentoo Foundation" "qfile"
+.\" generated by mkman.py, please do NOT edit!
+.TH qfile "1" "Apr 2018" "Gentoo Foundation" "qfile"
 .SH NAME
 qfile \- list all pkgs owning files
 .SH SYNOPSIS
 .B qfile
 \fI[opts] <filename>\fR
 .SH DESCRIPTION
-
+\fIqfile\fR searches packages for files they provide.  The searched
+packages must be installed, thus the search is for any file on the
+filesystem, to what package that file belongs.  It allows to identify
+which package installed a certain file.
 .SH OPTIONS
 .TP
 \fB\-S\fR, \fB\-\-slots\fR
-Display installed packages with slots
+Display installed packages with slots.
 .TP
 \fB\-R\fR, \fB\-\-root\-prefix\fR
-Assume arguments are already prefixed by $ROOT
+Assume arguments are already prefixed by $ROOT.
 .TP
 \fB\-b\fR, \fB\-\-basename\fR
-Match any component of the path
+Match any component of the path.
 .TP
 \fB\-o\fR, \fB\-\-orphans\fR
-List orphan files
+List orphan files.
 .TP
 \fB\-x\fR \fI<arg>\fR, \fB\-\-exclude\fR \fI<arg>\fR
-Don't look in package <arg> (used with --orphans)
+Don't look in package <arg> (used with --orphans).
 .TP
 \fB\-e\fR, \fB\-\-exact\fR
-Exact match (used with --exclude)
+Exact match (used with --exclude).
 .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 package versions to matches, warn about problems with
+resolving symlinks or positioning packages under an alternative
+root.
 .TP
 \fB\-q\fR, \fB\-\-quiet\fR
-Tighter output; suppress warnings
+Don't print matching file for matches, just the package.  Don't
+report about orphan files.
 .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 "FINDING FILES OWNERS"
 .PP
 This is the default behavior of \fBqfile\fP.  It will list the packages which
@@ -159,7 +166,7 @@ takes one argument, which can be a package name (\fBbash\fP or
 packages (ie., comparing the contents of one package with the contents of all
 the others).
 .PP
-For example, the following script will search collisions beetween all your
+For example, the following script will search collisions between all your
 installed packages. Be careful, this will takes time:
 .nf\fI
 	#!/bin/bash
@@ -202,7 +209,8 @@ TGL degrenier[at]easyconnect.fr
 .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@gentoo.org
 .SH AUTHORS
 .nf
 Ned Ludd <solar@gentoo.org>

[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@gentoo.org
 .SH AUTHORS
 .nf
 Ned Ludd <solar@gentoo.org>

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

[Fabian Groffen]

commit:     2921191511917e039e6cbca77b7b4977fc8a9eb4
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Tue Apr  3 15:29:46 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Tue Apr  3 15:29:46 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=29211915

qxpak: improve documentation

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

 man/include/qxpak.desc |  1 +
 man/qxpak.1            | 30 ++++++++++++++++--------------
 2 files changed, 17 insertions(+), 14 deletions(-)

diff --git a/man/include/qxpak.desc b/man/include/qxpak.desc
new file mode 100644
index 0000000..13b9591
--- /dev/null
+++ b/man/include/qxpak.desc
@@ -0,0 +1 @@
+\fIqxpak\fR is like ar and tar for xpak archives.

diff --git a/man/qxpak.1 b/man/qxpak.1
index dbf36f6..710df44 100644
--- a/man/qxpak.1
+++ b/man/qxpak.1
@@ -1,50 +1,52 @@
-.TH qxpak "1" "Mar 2016" "Gentoo Foundation" "qxpak"
+.\" generated by mkman.py, please do NOT edit!
+.TH qxpak "1" "Apr 2018" "Gentoo Foundation" "qxpak"
 .SH NAME
 qxpak \- manipulate xpak archives
 .SH SYNOPSIS
 .B qxpak
 \fI[opts] <misc args>\fR
 .SH DESCRIPTION
-
+\fIqxpak\fR is like ar and tar for xpak archives.
 .SH OPTIONS
 .TP
 \fB\-l\fR, \fB\-\-list\fR
-List the contents of an archive
+List the contents of an archive.
 .TP
 \fB\-x\fR, \fB\-\-extract\fR
-Extract the contents of an archive
+Extract the contents of an archive.
 .TP
 \fB\-c\fR, \fB\-\-create\fR
-Create an archive of a directory/files
+Create an archive of a directory/files.
 .TP
 \fB\-d\fR \fI<arg>\fR, \fB\-\-dir\fR \fI<arg>\fR
-Change to specified directory
+Change to specified directory.
 .TP
 \fB\-O\fR, \fB\-\-stdout\fR
-Write files to stdout
+Write files to stdout.
 .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
+Make a lot of noise.
 .TP
 \fB\-q\fR, \fB\-\-quiet\fR
-Tighter output; suppress warnings
+Tighter output; suppress warnings.
 .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@gentoo.org
 .SH AUTHORS
 .nf
 Ned Ludd <solar@gentoo.org>

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

[Fabian Groffen]

commit:     213b183db62d05fc918f323098b19ac260fc2a3c
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Fri May 18 10:08:12 2018 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Fri May 18 10:08:12 2018 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=213b183d

mkman.py: add additional authors to main authors section

 man/include/qfile-99-authors.include | 4 ----
 man/include/qfile-authors.include    | 1 +
 man/mkman.py                         | 5 ++++-
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/man/include/qfile-99-authors.include b/man/include/qfile-99-authors.include
deleted file mode 100644
index df3dc39..0000000
--- a/man/include/qfile-99-authors.include
+++ /dev/null
@@ -1,4 +0,0 @@
-.SH "ADDITIONAL CONTRIBUTORS"
-.nf
-TGL degrenier[at]easyconnect.fr
-.fi

diff --git a/man/include/qfile-authors.include b/man/include/qfile-authors.include
new file mode 100644
index 0000000..d90fe2a
--- /dev/null
+++ b/man/include/qfile-authors.include
@@ -0,0 +1 @@
+TGL <degrenier[at]easyconnect.fr>

diff --git a/man/mkman.py b/man/mkman.py
index 8444311..7089320 100755
--- a/man/mkman.py
+++ b/man/mkman.py
@@ -139,7 +139,10 @@ def MkMan(applets, applet, output):
     # Handle any fragments this applet has available
     for frag in sorted(glob.glob(os.path.join(FRAGS_DIR, '%s-*.include' % applet))):
         with open(frag) as f:
-            extra_sections += [x.rstrip() for x in f.readlines()]
+            if "-authors." in frag:
+                authors += [x.rstrip() for x in f.readlines()]
+            else:
+                extra_sections += [x.rstrip() for x in f.readlines()]
 
     data = {
         'applet': applet,

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

[Fabian Groffen]

commit:     30249c7fa6be35ae2a35fbab6381d2c51b772187
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Sun Apr 28 08:00:38 2019 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Sun Apr 28 08:00:38 2019 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=30249c7f

man/qgrep: use bold instead of italics for program refs

Signed-off-by: Fabian Groffen <grobian <AT> gentoo.org>

 man/include/qgrep.desc | 2 +-
 man/qgrep.1            | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/man/include/qgrep.desc b/man/include/qgrep.desc
index 98bcc09..e6bcf43 100644
--- a/man/include/qgrep.desc
+++ b/man/include/qgrep.desc
@@ -3,4 +3,4 @@ current portage tree and defined additional overlays.  Optionally the
 search is in all eclasses, or just in the ebuilds that are currently
 installed.  To narrow the search, multiple targets can be given using
 atom syntax.  In particular, the trailing slash (/) syntax can be used
-to match an entire category.  See also \fIqatom\fR(1).
+to match an entire category.  See also \fBqatom\fR(1).

diff --git a/man/qgrep.1 b/man/qgrep.1
index 048e28e..347c88c 100644
--- a/man/qgrep.1
+++ b/man/qgrep.1
@@ -11,7 +11,7 @@ current portage tree and defined additional overlays.  Optionally the
 search is in all eclasses, or just in the ebuilds that are currently
 installed.  To narrow the search, multiple targets can be given using
 atom syntax.  In particular, the trailing slash (/) syntax can be used
-to match an entire category.  See also \fIqatom\fR(1).
+to match an entire category.  See also \fBqatom\fR(1).
 .SH OPTIONS
 .TP
 \fB\-I\fR, \fB\-\-invert\-match\fR

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

[Fabian Groffen]

commit:     3157f0fd47930f8604c6cc668906b3131dcc15d7
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Fri May  3 17:20:51 2019 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Fri May  3 17:20:51 2019 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=3157f0fd

qkeyword.1: add description

Signed-off-by: Fabian Groffen <grobian <AT> gentoo.org>

 man/include/qkeyword.desc | 3 +++
 man/qkeyword.1            | 4 +++-
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/man/include/qkeyword.desc b/man/include/qkeyword.desc
new file mode 100644
index 0000000..3bbfb43
--- /dev/null
+++ b/man/include/qkeyword.desc
@@ -0,0 +1,3 @@
+\fIqkeyword\fR allows various searches based on KEYWORDS aimed at Gentoo
+developers.  Various modes allow to query which packages would be
+available, or are candidate for keywording.

diff --git a/man/qkeyword.1 b/man/qkeyword.1
index a575404..d32e771 100644
--- a/man/qkeyword.1
+++ b/man/qkeyword.1
@@ -6,7 +6,9 @@ qkeyword \- list packages based on keywords
 .B qkeyword
 \fI[opts] <action> <args>\fR
 .SH DESCRIPTION
-
+\fIqkeyword\fR allows various searches based on KEYWORDS aimed at Gentoo
+developers.  Various modes allow to query which packages would be
+available, or are candidate for keywording.
 .SH OPTIONS
 .TP
 \fB\-p\fR \fI<arg>\fR, \fB\-\-matchpkg\fR \fI<arg>\fR

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

[Fabian Groffen]

commit:     e7fd910eb6b95031261d4f8878bc97ca7818a9e2
Author:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
AuthorDate: Fri May 17 11:54:55 2019 +0000
Commit:     Fabian Groffen <grobian <AT> gentoo <DOT> org>
CommitDate: Fri May 17 11:54:55 2019 +0000
URL:        https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=e7fd910e

man/q: document -r/-m (cache) opts were removed

Signed-off-by: Fabian Groffen <grobian <AT> gentoo.org>

 man/include/q.desc | 8 ++++++++
 man/q.1            | 9 ++++++++-
 2 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/man/include/q.desc b/man/include/q.desc
new file mode 100644
index 0000000..7109c46
--- /dev/null
+++ b/man/include/q.desc
@@ -0,0 +1,8 @@
+.I q
+is a collection of utilities for use with Gentoo systems regarding
+installed and available packages.
+.P
+After version 0.74 of portage-utils, the cache functionality was removed
+in favour of using various trees directly, and optionally the caches
+therein.  As such the \fB-r\fR and \fB-m\fR options were removed.  It is
+no longer necessary to initialise the cache at any time.

diff --git a/man/q.1 b/man/q.1
index cbf2303..92794a2 100644
--- a/man/q.1
+++ b/man/q.1
@@ -6,7 +6,14 @@ q \- invoke a portage utility applet
 .B q
 \fI<applet> <args> \fR
 .SH DESCRIPTION
-
+.I q
+is a collection of utilities for use with Gentoo systems regarding
+installed and available packages.
+.P
+After version 0.74 of portage-utils, the cache functionality was removed
+in favour of using various trees directly, and optionally the caches
+therein.  As such the \fB-r\fR and \fB-m\fR options were removed.  It is
+no longer necessary to initialise the cache at any time.
 .SH OPTIONS
 .TP
 \fB\-i\fR, \fB\-\-install\fR