Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 440524 - man 5 ebuild does not describe mirror:// syntax for SRC_URIs
Summary: man 5 ebuild does not describe mirror:// syntax for SRC_URIs
Status: CONFIRMED
Alias: None
Product: Documentation
Classification: Unclassified
Component: [OLD] Portage Documentation (show other bugs)
Hardware: All Linux
: Normal enhancement (vote)
Assignee: Portage team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-10-31 11:06 UTC by Patric Schmitz
Modified: 2020-09-10 18:40 UTC (History)
3 users (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 Patric Schmitz 2012-10-31 11:06:19 UTC
The ebuild manpage doesn't mention the mirror:// syntax. This is confusing to users trying to understand their ebuilds. It also does not inform ebuild-authors of the possibility to use the mirror URI shortcut if the don't know of the possibility via other means. I would expect the ebuild manpage to contain a short note in the SRC_URI description mentioning sth. like: "Valid URI's are ftp:// http:// or rsync:// sources or URIs of the type mirror://name which is a shorthand for all URIs defined under name in ${PORTDIR}/profiles/thirdpartymirrors". Maybe i have just missed where in the portage documentation that information can be found, in that case the bug report would be void.

Reproducible: Always
Comment 1 Zac Medico gentoo-dev 2012-10-31 21:51:29 UTC
I don't see it documented anywhere in the portage docs. We can document it with an example like is done here:

  http://devmanual.gentoo.org/quickstart/index.html#information-variables
Comment 2 Patric Schmitz 2012-11-02 12:05:02 UTC
Sounds good. I would, however, add a remark on where those mirrors are defined, as in my original remark. For example I don't know myself wether ${PORTDIR}/profiles/thirdpartymirrors is the only place where mirror shortcuts can be defined. I expect that to be mentioned somewhere. Also I wonder wether rsync, ftp and http are the only normal URI types allowed, I think that should be mentioned, too.