Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 603970 - Do not use the term "atom"
Summary: Do not use the term "atom"
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2016-12-28 19:54 UTC by Ulrich Müller
Modified: 2016-12-29 21:39 UTC (History)
0 users

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


Attachments
Change "atom" to "package dependency specification" throughout (0001-Change-atom-to-package-dependency-specification-thro.patch,5.97 KB, patch)
2016-12-28 19:54 UTC, Ulrich Müller
Details | Diff
Change "atom" to "package dependency specification" throughout (0001-Change-atom-to-package-dependency-specification-thro.patch,6.09 KB, patch)
2016-12-29 18:29 UTC, Ulrich Müller
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ulrich Müller gentoo-dev 2016-12-28 19:54:59 UTC
Created attachment 457668 [details, diff]
Change "atom" to "package dependency specification" throughout

Currently the term "atom" is used quite inconsistently. In the section about blockers it includes the block operator (i.e., ! or !!). When describing the best_version function, it is used in the sense of category/package-version, and when describing profiles/updates is is used in the actual sense of ebuild(5).

I think that we should avoid the term altogether because it also is a misnomer. These "atoms" are everything else but atomic. PMS uses "package dependency specification" instead, see bug 174322.

Patch is attached, please review.
Comment 1 Göktürk Yüksek archtester gentoo-dev 2016-12-29 04:32:36 UTC
LGTM for the most part. My only confusion is about best_version() where the word "atom" implied a specific syntax (i.e. ${PN}-{PV} etc.) whereas simply saying "Echoes category, name and version" is a bit vague about the format of the output. Maybe we should say something like "Echoes category, name and version ... in the format of a package dependency specification."
Comment 2 Ulrich Müller gentoo-dev 2016-12-29 08:50:25 UTC
(In reply to Göktürk Yüksek from comment #1)
> LGTM for the most part. My only confusion is about best_version() where the
> word "atom" implied a specific syntax (i.e. ${PN}-{PV} etc.) whereas simply
> saying "Echoes category, name and version" is a bit vague about the format
> of the output. Maybe we should say something like "Echoes category, name and
> version ... in the format of a package dependency specification."

See? Because that's not what the function does. It actually takes a package dependency specification as its _input_, but its output isn't in that format. For example, "best_version app-editors/emacs:24" will output "app-editors/emacs-24.5-r3". (Maybe we should simply add that example?)
Comment 3 Göktürk Yüksek archtester gentoo-dev 2016-12-29 18:04:25 UTC
Portage has the following: https://gitweb.gentoo.org/proj/portage.git/tree/bin/phase-helpers.sh#n890

"""
# Returns highest installed matching category/package-version (without .ebuild).
"""

I think an example would make it clear enough.
Comment 4 Ulrich Müller gentoo-dev 2016-12-29 18:29:38 UTC
Created attachment 457850 [details, diff]
Change "atom" to "package dependency specification" throughout

Updated patch with example added.
Comment 5 Göktürk Yüksek archtester gentoo-dev 2016-12-29 18:58:56 UTC
Ack
Comment 6 Ulrich Müller gentoo-dev 2016-12-29 21:39:45 UTC
Pushed. Closing.