Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 356165 - app-portage/layman split out a layman.conf manpage
Summary: app-portage/layman split out a layman.conf manpage
Status: RESOLVED FIXED
Alias: None
Product: Portage Development
Classification: Unclassified
Component: Third-Party Tools (show other bugs)
Hardware: All Linux
: Normal enhancement (vote)
Assignee: Brian Dolbec
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-02-23 04:58 UTC by Duncan
Modified: 2013-06-02 12:38 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 Duncan 2011-02-23 04:58:11 UTC
In the layman manpage, CONFIGURATION section, there are two different "overlays" entries.  The second one is correct for that config parameter.  The first one SHOULD be "local_list", tho by default it points to a file named "overlays.xml", confusing the situation even worse, since the (real) "overlays" option doesn't point to the overlays file, but rather to a remote URL, while the "local_list" option (cross-)points to the overlays file.

Left as "normal" severity (not minor/trivial as docs changes might normally be) since someone actually trying to use this documentation could screw their layman config in rather "interesting" ways.

BTW, a separate layman.conf (5) manpage would be nice...  (Feel free to reduce to enhancement severity after the above is fixed, or simply tell me to file a separate bug for this request, if it'd work better.)
Comment 1 Aaron D Borden 2011-08-16 17:05:30 UTC
Also, "OVERLAY LISTS > Overlay list format" is missing the actual file format.
"Layman uses a central list of overlays in XML format. The file looks like this:"

It should have an example of what the layman XML list format looks like, instead  the next heading starts.
Comment 2 Brian Dolbec (RETIRED) gentoo-dev 2011-08-16 20:11:08 UTC
I just checked and the source text does have the example in there. It is also in the html pages, but it is not appearing in the man page so there is a bug in a makefile.  I will work on it.

I am not sure fat this will warrant a new release.  I have also been contemplating changing some of the variable names in the config.
Comment 3 Brian Dolbec (RETIRED) gentoo-dev 2011-08-16 23:42:15 UTC
(In reply to comment #1)
> Also, "OVERLAY LISTS > Overlay list format" is missing the actual file format.
> "Layman uses a central list of overlays in XML format. The file looks like
> this:"
> 
> It should have an example of what the layman XML list format looks like,
> instead  the next heading starts.

Aaron, i can't reproduce your problem with the example xml file format.  I installed layman-1.4.2, also checked the tarball and it is there.  It also shows the example in a terminal using "man layman".
Comment 4 Brian Dolbec (RETIRED) gentoo-dev 2012-03-11 02:04:27 UTC
Well, now that I am finally a dev, I have finally gotten around to pushing the manpage corrections to the tree.  It is fixed in layman-1.4.2-r3 which should be available within a few hours from your local mirror.

Layman-2.0.0_rc3 already has the corrections along with some variable/file names changed to better reflect what they are and help avoid the cross purpose naming that was present in the 1.* series.
Comment 5 Pacho Ramos gentoo-dev 2013-06-02 12:38:23 UTC
(In reply to Brian Dolbec from comment #4)
> Well, now that I am finally a dev, I have finally gotten around to pushing
> the manpage corrections to the tree.  It is fixed in layman-1.4.2-r3 which
> should be available within a few hours from your local mirror.
> 
> Layman-2.0.0_rc3 already has the corrections along with some variable/file
> names changed to better reflect what they are and help avoid the cross
> purpose naming that was present in the 1.* series.

closing then