Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 676928 - app-eselect/eselect-repository should give some hint about the listing symbols
Summary: app-eselect/eselect-repository should give some hint about the listing symbols
Status: UNCONFIRMED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Michał Górny
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2019-01-30 16:27 UTC by Till Schäfer
Modified: 2019-02-01 15:44 UTC (History)
0 users

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 Till Schäfer 2019-01-30 16:27:21 UTC
When using "eselect repository list [-i]" there are some colored symbols behind the repositories (I am talking about the sharp and @ in the example below). However, I cannot find any explanation about the meaning of the symbols. 

Thus, I propose to give some hint in "eselect repository help".


Example: 
eselect repository list -i 
Available repositories:
  [155] gentoo #
  [231] local_overlay @
  [344] shared_overlay @
Comment 1 Brian Evans Gentoo Infrastructure gentoo-dev 2019-01-30 16:59:57 UTC
FWIW, the symbols are explained on the wiki [1].

I do agree that some manual would be useful as well.

[1] https://wiki.gentoo.org/wiki/Eselect/Repository
Comment 2 Till Schäfer 2019-01-30 17:24:06 UTC
good to know, thx. 

However, the information about the sharp given in the wiki does not seems to be correct. Currently I see this symbol only if the sync-uri is changed. An added option (which I believe is a customization) does not lead to a sharp symbol.  Changing the location does not lead to a sharp symbol, too. 

This is related to Bug 676930 (It might be better to fully support repository options than to change the meaning of the sharp symbol here)
Comment 3 Till Schäfer 2019-01-31 14:20:47 UTC
(In reply to Till Schäfer from comment #2)
> However, the information about the sharp given in the wiki does not seems to
> be correct. Currently I see this symbol only if the sync-uri is changed. An
> added option (which I believe is a customization) does not lead to a sharp
> symbol.  Changing the location does not lead to a sharp symbol, too. 
my fault -> the description is correct (it only refers to sync information)
Comment 4 Till Schäfer 2019-02-01 15:38:54 UTC
I have created a man page.

- Pull request on github: https://github.com/mgorny/eselect-repository/pull/6/commits/14aa90f62b2bfc4742d730e48c9ff5893d2f8ec0
- The ebuild needs an adjustment, too: The MANPAGEPATH must be provided. Otherwise this is hardcoded in the Makefile
- I used the default license header for ebuilds for the man-page, but noticed later that the eselect module itself is not GPL2 -> Is this a problem? Should I change it to BSD as well?
Comment 5 Till Schäfer 2019-02-01 15:44:07 UTC
Please also have a look at the code comments in the pull request. 

The man page is close to the wiki content and the eselect module self explanation.