Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 645554 - app-portage/portage-utils: unclear and incomplete documentation
Summary: app-portage/portage-utils: unclear and incomplete documentation
Status: RESOLVED FIXED
Alias: None
Product: Portage Development
Classification: Unclassified
Component: Tools (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Fabian Groffen
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-01-24 13:46 UTC by Kevin Vigouroux
Modified: 2018-04-05 19:03 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Kevin Vigouroux 2018-01-24 13:46:04 UTC
In my opinion, some manual pages are not precise enough. We can not use some Q applets properly unless we have prior knowledge.

The documentation could be improved by considering :

- the format of a conventional manual page.

- introduce particular notions and use cases.

- review existing definitions: use meaningful terms and be precise.

[IN PRACTICE]

See bugs #459970, #608960 (first comment)

[EXAMPLES]

# We do not know in which cases this option works.

-v, --verbose
   Make a lot of noise.

# This option does not work as expected in some cases.

-q, --quiet
   Tighter output; suppress warnings.  

# We do not know exactly what is a "pkgname".

"applets" [opts] <pkgname>


qdepends

# We do not know what is a "vdb key".

  -k <arg>, --key <arg>
     User defined vdb key

# We do not know how to change the format.

  -f, --format
     Pretty format specified depend strings
Comment 1 Kevin Vigouroux 2018-01-24 13:47:11 UTC

*** This bug has been marked as a duplicate of bug 459970 ***
Comment 2 Larry the Git Cow gentoo-dev 2018-04-02 17:27:40 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=9164549006068637d060a23a9a24f657982bfbaf

commit 9164549006068637d060a23a9a24f657982bfbaf
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-02 17:26:35 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-02 17:26:35 +0000

    qatom: improve manpage
    
    Bug: https://bugs.gentoo.org/645554

 man/include/qatom.desc         | 15 +++++++++
 man/include/qatom.optdesc.yaml | 43 ++++++++++++++++++++++++
 man/qatom.1                    | 74 ++++++++++++++++++++++++++++++++++++------
 3 files changed, 122 insertions(+), 10 deletions(-)}
Comment 3 Larry the Git Cow gentoo-dev 2018-04-02 17:52:52 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=ec9c281b4fd5d4b36927c2b004bbcd0fe11f2d76

commit ec9c281b4fd5d4b36927c2b004bbcd0fe11f2d76
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-02 17:52:20 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-02 17:52:20 +0000

    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(-)}
Comment 4 Larry the Git Cow gentoo-dev 2018-04-02 18:59:31 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=7de177d7ac1dff248f91e45bfdc3163629dae79e

commit 7de177d7ac1dff248f91e45bfdc3163629dae79e
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-02 18:59:02 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-02 18:59:02 +0000

    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(-)}
Comment 5 Larry the Git Cow gentoo-dev 2018-04-03 11:50:00 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=1def9d468742c0d6d6b24aa1f1d76243be6e24cd

commit 1def9d468742c0d6d6b24aa1f1d76243be6e24cd
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-03 11:49:41 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-03 11:49:41 +0000

    qlist: improve documentation
    
    Bug: https://bugs.gentoo.org/645554

 man/include/qlist.desc         |  6 +++++
 man/include/qlist.optdesc.yaml | 24 ++++++++++++++++++
 man/qlist.1                    | 56 +++++++++++++++++++++++++++---------------
 qlist.c                        |  2 +-
 4 files changed, 67 insertions(+), 21 deletions(-)}
Comment 6 Larry the Git Cow gentoo-dev 2018-04-03 12:56:44 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=86085691d6a42e497c1a8902cf7c24212a2dd67d

commit 86085691d6a42e497c1a8902cf7c24212a2dd67d
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-03 12:56:17 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-03 12:56:17 +0000

    qpkg: improve documentation
    
    Bug: https://bugs.gentoo.org/645554

 man/include/qpkg.desc         |  4 ++++
 man/include/qpkg.optdesc.yaml |  2 ++
 man/qpkg.1                    | 31 ++++++++++++++++++-------------
 3 files changed, 24 insertions(+), 13 deletions(-)

https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=f24b626027dceb5890b134837c6683f4593f6ce0

commit f24b626027dceb5890b134837c6683f4593f6ce0
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-03 12:15:35 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-03 12:15:35 +0000

    qmerge: improve documentation
    
    Bug: https://bugs.gentoo.org/645554

 man/include/qmerge.desc |  6 ++++++
 man/qmerge.1            | 43 +++++++++++++++++++++++++------------------
 2 files changed, 31 insertions(+), 18 deletions(-)}
Comment 7 Larry the Git Cow gentoo-dev 2018-04-03 13:39:38 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=ea69f8fc6eb1e1ee71eea57b938eac631dedb4de

commit ea69f8fc6eb1e1ee71eea57b938eac631dedb4de
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-03 13:39:15 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-03 13:39:15 +0000

    qsize: improve documentation
    
    Bug: https://bugs.gentoo.org/645554

 man/include/qpkg.optdesc.yaml |  2 +-
 man/qsize.1                   | 37 +++++++++++++++++++++----------------
 qsize.c                       |  6 +++---
 3 files changed, 25 insertions(+), 20 deletions(-)

https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=81df4a8cfbd2998e43842440bb2d57d620b6ff7d

commit 81df4a8cfbd2998e43842440bb2d57d620b6ff7d
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-03 13:13:21 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-03 13:13:21 +0000

    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(-)}
Comment 8 Larry the Git Cow gentoo-dev 2018-04-03 13:56:08 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=23b810c84c02a29f3b2766cf0fd005c53e668816

commit 23b810c84c02a29f3b2766cf0fd005c53e668816
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-03 13:51:42 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-03 13:51:42 +0000

    qtbz2: improve documentation
    
    Bug: https://bugs.gentoo.org/645554

 man/include/qsize.desc         |  3 +++
 man/include/qsize.optdesc.yaml |  5 +++++
 man/include/qtbz2.desc         |  2 ++
 man/include/qtbz2.optdesc.yaml |  2 ++
 man/qtbz2.1                    | 33 ++++++++++++++++++---------------
 5 files changed, 30 insertions(+), 15 deletions(-)}
Comment 9 Larry the Git Cow gentoo-dev 2018-04-03 15:21:00 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=454020200171d3d921b0f7e2229d4e527e1e6b2a

commit 454020200171d3d921b0f7e2229d4e527e1e6b2a
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-03 15:19:43 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-03 15:19:43 +0000

    quse: improve documentation
    
    Bug: https://bugs.gentoo.org/645554

 man/include/quse.desc         |  2 ++
 man/include/quse.optdesc.yaml | 11 +++++++++++
 man/quse.1                    | 40 ++++++++++++++++++++++++----------------
 quse.c                        |  4 ++--
 4 files changed, 39 insertions(+), 18 deletions(-)}
Comment 10 Larry the Git Cow gentoo-dev 2018-04-03 20:00:07 UTC
The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/proj/portage-utils.git/commit/?id=2921191511917e039e6cbca77b7b4977fc8a9eb4

commit 2921191511917e039e6cbca77b7b4977fc8a9eb4
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-03 15:29:46 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-03 15:29:46 +0000

    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(-)}
Comment 11 Larry the Git Cow gentoo-dev 2018-04-05 19:03:07 UTC
The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=34b636503cc7dcabe32b9b377c2eb77cb5fd5575

commit 34b636503cc7dcabe32b9b377c2eb77cb5fd5575
Author:     Fabian Groffen <grobian@gentoo.org>
AuthorDate: 2018-04-05 19:02:10 +0000
Commit:     Fabian Groffen <grobian@gentoo.org>
CommitDate: 2018-04-05 19:02:34 +0000

    app-portage/portage-utils: version bump to 0.70
    
    This release fixes multiple bugs lingering around for a while.
    
    Closes: https://bugs.gentoo.org/651546
    Closes: https://bugs.gentoo.org/646310
    Closes: https://bugs.gentoo.org/645554
    Closes: https://bugs.gentoo.org/643820
    Closes: https://bugs.gentoo.org/638032
    Closes: https://bugs.gentoo.org/608960
    Closes: https://bugs.gentoo.org/607498
    Closes: https://bugs.gentoo.org/558306
    Closes: https://bugs.gentoo.org/526596
    Closes: https://bugs.gentoo.org/470168
    Closes: https://bugs.gentoo.org/351100
    Closes: https://bugs.gentoo.org/335453
    Package-Manager: Portage-2.3.24, Repoman-2.3.6

 app-portage/portage-utils/Manifest                 |  2 +-
 .../portage-utils/portage-utils-0.62.ebuild        |  2 +-
 .../portage-utils/portage-utils-0.63.ebuild        | 43 ----------------------
 ...ls-0.64-r1.ebuild => portage-utils-0.70.ebuild} | 16 +-------
 4 files changed, 4 insertions(+), 59 deletions(-)