Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 544094 - =sys-apps/portage-2.2.14 please extend atom description in man 5 ebuild and and man 1 emerge
Summary: =sys-apps/portage-2.2.14 please extend atom description in man 5 ebuild and a...
Status: RESOLVED DUPLICATE of bug 414815
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: [OLD] Unspecified (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Portage team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-03-22 12:02 UTC by Sergey S. Starikoff
Modified: 2015-04-06 11:50 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 Sergey S. Starikoff 2015-03-22 12:02:14 UTC
Following another issue I've find that no one of core Gentoo documentation (man pages) contains _complete_ description of atom format.

The primary one as I think is man 5 ebuild.
But it's description don't contain the last unit: Reporsitory (and/or  repo-name aka overlay). Described in man portage:

                     Repository Constraints
                            Atoms  with  repository  constraints have a '::' separator appended to the right
                            side, followed by a repository name. Each repository name should  correspond  to
                            the  value  of a repo_name entry from one of the repositories that is configured
                            in repos.conf file.

                            Examples:
                            # match sed from the 'gentoo' repository
                            sys-apps/sed::gentoo
                            # match kdelibs from the 'kde-testing' repository
                            kde-base/kdelibs::kde-testing
                            # match empathy from the 'gnome' repository
                            net-im/empathy::gnome

man 1 ebuild contains short description of the same item. But it's again incomplete. repo-name field isn't mentioned.

To my mind man 5 ebuild also should be improved with addition of complete atom format:
${CATEGORY}/${PN}[-${PV}[-${PACKAGE_REVISION[:${SLOT}[:${repo-name}]]]]
Comment 1 Alexandre Rostovtsev (RETIRED) gentoo-dev 2015-03-28 18:21:02 UTC
"man 5 ebuild" describes the format of .ebuild files. And the ::repo_name syntax is intentionally not supported inside ebuilds - see bug #414815.

So the man file is correct IMHO.

*** This bug has been marked as a duplicate of bug 414815 ***
Comment 2 Sergey S. Starikoff 2015-03-28 19:31:35 UTC
(In reply to Sergey S. Starikoff from comment #0)
> To my mind man 5 ebuild also should be improved with addition of complete
> atom format:
> ${CATEGORY}/${PN}[-${PV}[-${PACKAGE_REVISION[:${SLOT}[:${repo-name}]]]]

I was mistaken.
As  Zac Medico said in bug #544096 the correct format is:
${CATEGORY}/${PN}[-${PV}[-${PACKAGE_REVISION]][:${SLOT}][::${repo-name}]
I.e. ':' as separator for slot field and '::' — for repository.

(In reply to Alexandre Rostovtsev from comment #1)
> "man 5 ebuild" describes the format of .ebuild files. And the ::repo_name
> syntax is intentionally not supported inside ebuilds - see bug #414815.
> 
> So the man file is correct IMHO.
> 
> *** This bug has been marked as a duplicate of bug 414815 ***

Maybe.
But if so: where I should search _complete_ description of atom format.
Expecting usage not only in ebuild contect, but also for more common configs (like /etc/portage/package.{keywords,…})?
Comment 3 Alexandre Rostovtsev (RETIRED) gentoo-dev 2015-03-29 02:36:46 UTC
(In reply to Sergey S. Starikoff from comment #2)
> Maybe.
> But if so: where I should search _complete_ description of atom format.
> Expecting usage not only in ebuild contect, but also for more common configs
> (like /etc/portage/package.{keywords,…})?

Probably in "man portage" - since that should be expected to discuss extensions to the basic atom syntax which are allowed inside /etc/portage.
Comment 4 Sergey S. Starikoff 2015-04-06 11:50:40 UTC
(In reply to Alexandre Rostovtsev from comment #3)
> Probably in "man portage" - since that should be expected to discuss
> extensions to the basic atom syntax which are allowed inside /etc/portage.

But for now (sys-apps/portage-2.2.14) man 5 portage contains incomplete description and both man 1 emerge and man 5 portage refers to man 5 ebuild for complete description:

man 5 portage:
«More reading: ebuild(5)»

man 1 emerge:
atom   An  atom  describes  bounds  on a package that you wish to install.  See ebuild(5) for the details on atom syntax.

So, three man pages should be reviewed. Unfortunately, my English is not well enough to suggest patches.

Also, we probably should reopen this bug, because it is NOT a question about future EAPI, but particular existing documentation issue (may be extended to question of keeping built-in documentation in up to date state).