Gentoo Archives: gentoo-commits

From: "Ulrich Müller" <ulm@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] proj/devmanual:master commit in: profiles/updates/, function-reference/query-functions/, ebuild-writing/eapi/, ...
Date: Thu, 29 Dec 2016 21:39:27
Message-Id: 1483038004.ef00b42a6af4ca7d9c4eeff41ef652ee2e5edc56.ulm@gentoo
1 commit: ef00b42a6af4ca7d9c4eeff41ef652ee2e5edc56
2 Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
3 AuthorDate: Wed Dec 28 19:39:23 2016 +0000
4 Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
5 CommitDate: Thu Dec 29 19:00:04 2016 +0000
6 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=ef00b42a
7
8 Change "atom" to "package dependency specification" throughout.
9
10 Bug: 603970
11
12 ebuild-writing/eapi/text.xml | 48 +++++++++++++++--------------
13 function-reference/query-functions/text.xml | 6 ++--
14 general-concepts/dependencies/text.xml | 8 ++---
15 profiles/updates/text.xml | 5 +--
16 4 files changed, 36 insertions(+), 31 deletions(-)
17
18 diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml
19 index 59e0bf3..a918fd0 100644
20 --- a/ebuild-writing/eapi/text.xml
21 +++ b/ebuild-writing/eapi/text.xml
22 @@ -89,9 +89,9 @@ src_compile() {
23 <li>
24 <p><b>SLOT dependencies</b></p>
25 <p>
26 - Any valid atom can be constrained to match a specific SLOT. This
27 - is accomplished by appending a colon to the atom, followed by a
28 - SLOT value.
29 + Any valid package dependency specification can be constrained to match
30 + a specific SLOT. This is accomplished by appending a colon to the
31 + specification, followed by a SLOT value.
32 </p>
33 <p>
34 <b>SLOT dependency examples:</b>
35 @@ -166,34 +166,34 @@ doman foo.lang.1
36 <body>
37 <ul>
38 <li>
39 - <p><b>Blocker Atoms</b></p>
40 + <p><b>Blockers</b></p>
41 <p>
42 <ul>
43 <li>
44 <p><b>New Meaning for Old Syntax</b></p>
45 <p>
46 - Blocker atoms which use the previously existing !atom syntax now
47 - have a slightly different meaning. These blocker atoms indicate
48 - that conflicting packages may be temporarily installed
49 - simultaneously. When temporary simultaneous installation of
50 - conflicting packages occurs, the installation of a newer package
51 - may overwrite any colliding files that belong to an older package
52 - which is explicitly blocked. When such file collisions occur, the
53 - colliding files cease to belong to the older package, and they
54 - remain installed after the older package is eventually
55 - uninstalled. The older package is uninstalled only after any newer
56 - blocking packages have been merged on top of it.
57 + Blockers which use the previously existing <c>!</c> syntax
58 + now have a slightly different meaning. These so-called
59 + <e>weak blocks</e> indicate that conflicting packages may
60 + be temporarily installed simultaneously. When temporary
61 + simultaneous installation of conflicting packages occurs, the
62 + installation of a newer package may overwrite any colliding
63 + files that belong to an older package which is explicitly
64 + blocked. When such file collisions occur, the colliding files
65 + cease to belong to the older package, and they remain installed
66 + after the older package is eventually uninstalled. The older
67 + package is uninstalled only after any newer blocking packages
68 + have been merged on top of it.
69 </p>
70 </li>
71 <li>
72 - <p><b>New !!atom Syntax</b></p>
73 + <p><b>New <c>!!</c> Operator</b></p>
74 <p>
75 - A new !!atom syntax is now supported, for use in special cases for
76 - which temporary simultaneous installation of conflicting packages
77 - should not be allowed. If a given package happens to be blocked by
78 - a mixture of atoms consisting of both the !atom and !!atom
79 - syntaxes, the !!atom syntax takes precedence over the !atom
80 - syntax.
81 + A new <c>!!</c> operator for <e>strong blocks</e> is now
82 + supported, for use in special cases for which temporary
83 + simultaneous installation of conflicting packages should not be
84 + allowed. If both weak and strong blocks match a given package,
85 + the strong block takes precedence.
86 </p>
87 </li>
88 </ul>
89 @@ -731,7 +731,9 @@ REQUIRED_USE="|| ( foo bar baz )"
90 RDEPEND="dev-libs/foo:0/3"
91 </codesample>
92 <p>
93 - Dependency atoms can use <b>slot operators</b> to clarify what should happen if the slot and/or sub-slot of a runtime dependency changes:
94 + Package dependency specifications can use <b>slot operators</b> to
95 + clarify what should happen if the slot and/or sub-slot of a runtime
96 + dependency changes:
97 </p>
98 <ul>
99 <li>
100
101 diff --git a/function-reference/query-functions/text.xml b/function-reference/query-functions/text.xml
102 index 66e595f..97d2dfb 100644
103 --- a/function-reference/query-functions/text.xml
104 +++ b/function-reference/query-functions/text.xml
105 @@ -96,8 +96,10 @@ query variables and similar state.
106 <c>best_version pkg</c>
107 </ti>
108 <ti>
109 - Echoes the highest versioned atom of <c>pkg</c> which is currently
110 - installed.
111 + Echoes category, name and version of the highest version of <c>pkg</c>
112 + that is currently installed.
113 + Example: <c>best_version app-editors/emacs:24</c> will output
114 + <c>app-editors/emacs-24.5-r3</c>.
115 </ti>
116 </tr>
117 <tr>
118
119 diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml
120 index df6df43..18fcefd 100644
121 --- a/general-concepts/dependencies/text.xml
122 +++ b/general-concepts/dependencies/text.xml
123 @@ -109,10 +109,10 @@ DEPEND="dev-lang/ruby
124 </codesample>
125
126 <p>
127 -Each atom is the full category and name of a package. Atoms are separated by
128 -arbitrary whitespace <d/> convention is to specify one atom per line for
129 -readability purposes. When specifying names, the category part should be treated
130 -as mandatory.
131 +Each <e>package dependency specification</e> is the full category and name of
132 +a package. Dependency specifications are separated by arbitrary whitespace <d/>
133 +convention is to have one specification per line for readability purposes.
134 +When specifying names, the category part should be treated as mandatory.
135 </p>
136
137 </body>
138
139 diff --git a/profiles/updates/text.xml b/profiles/updates/text.xml
140 index ae859e4..7136aea 100644
141 --- a/profiles/updates/text.xml
142 +++ b/profiles/updates/text.xml
143 @@ -36,10 +36,11 @@ the actual changes to the package have to be done manually.
144 </tr>
145 <tr>
146 <ti>
147 - <c>slotmove atom oldslot newslot</c>
148 + <c>slotmove spec oldslot newslot</c>
149 </ti>
150 <ti>
151 - Indicates that the atom specified has changed slots.
152 + Indicates that the package matching dependency specification <c>spec</c>
153 + has changed slots.
154 </ti>
155 </tr>
156 </table>