Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 650520 - app-portage/repoman's manpage does not indicate that it recurses through directories
Summary: app-portage/repoman's manpage does not indicate that it recurses through dire...
Alias: None
Product: Portage Development
Classification: Unclassified
Component: Repoman (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Portage team
Keywords: InVCS
Depends on:
Reported: 2018-03-14 20:56 UTC by zlg (RETIRED)
Modified: 2020-09-06 21:22 UTC (History)
1 user (show)

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

Add-BEHAVIOR-section.patch (0001-repoman-man-repoman.1-Add-BEHAVIOR-section-fix-bug-6.patch,1.38 KB, patch)
2018-03-29 23:10 UTC, zlg (RETIRED)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description zlg (RETIRED) gentoo-dev 2018-03-14 20:56:24 UTC
repoman's documentation doesn't clearly indicate that it can be used to recurse into directories. Users and some developers may incorrectly assume that repoman is only used in individual package directories, and give themselves more work by trying to solve the directory recursion problem on their own.

An explicit note that repoman recurses through directories avoids this confusion and communicates the true value of repoman as a repository-wide tool.

Reproducible: Always

Steps to Reproduce:
1. man repoman
2. search for 'recurs' or 'example' or any other meaningful word associated with directory traversal.
Actual Results:  
Nothing meaningful found to communicate what repoman does when invoked at a level higher than a package directory.

Expected Results:  
Some indication (or an example) showing that repoman can do things at the repository level, especially with modes that are at the package level, e.g. 'repoman manifest' at the root of a repository can and will generate manifests for all packages. Documentation should outline this behavior.
Comment 1 zlg (RETIRED) gentoo-dev 2018-03-29 23:10:29 UTC
Created attachment 526138 [details, diff]

Proposed patch; also sent to gentoo-portage-dev ML for comments.
Comment 2 Larry the Git Cow gentoo-dev 2018-03-30 02:32:20 UTC
The bug has been referenced in the following commit(s):

commit 47a3f7e905b3ba252659fa1a98071d03a1560807
Author:     zlg <>
AuthorDate: 2018-03-29 22:31:22 +0000
Commit:     Zac Medico <>
CommitDate: 2018-03-30 02:31:44 +0000

    repoman man/repoman.1: Add "BEHAVIOR" section (fix bug 650520)
    The manpage references "directory tree", but doesn't explicitly outline
    the expected behavior when run anywhere above the package directory
    Exact name of section, location within the manpage, and/or wording open
    to suggestions.
    Requested-by: zlg <>
    Signed-off-by: zlg <>

 repoman/man/repoman.1 | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)}
Comment 3 Zac Medico gentoo-dev 2020-09-06 21:22:46 UTC
Fixed in repoman-2.3.8.