Gentoo Archives: gentoo-commits

From: "Michal Gorny (mgorny)" <mgorny@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] gentoo commit in xml/htdocs/proj/en/Python/python-r1: dev-guide.xml
Date: Wed, 28 Nov 2012 19:49:41
Message-Id: 20121128194928.CB9C020C65@flycatcher.gentoo.org
1 mgorny 12/11/28 19:49:28
2
3 Modified: dev-guide.xml
4 Log:
5 Make the inheritance safer. Pinpoint the differences between eclasses.
6
7 Revision Changes Path
8 1.6 xml/htdocs/proj/en/Python/python-r1/dev-guide.xml
9
10 file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/Python/python-r1/dev-guide.xml?rev=1.6&view=markup
11 plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/Python/python-r1/dev-guide.xml?rev=1.6&content-type=text/plain
12 diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/Python/python-r1/dev-guide.xml?r1=1.5&r2=1.6
13
14 Index: dev-guide.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/Python/python-r1/dev-guide.xml,v
17 retrieving revision 1.5
18 retrieving revision 1.6
19 diff -u -r1.5 -r1.6
20 --- dev-guide.xml 27 Nov 2012 20:41:24 -0000 1.5
21 +++ dev-guide.xml 28 Nov 2012 19:49:28 -0000 1.6
22 @@ -1,7 +1,7 @@
23 <?xml version="1.0" encoding="UTF-8"?>
24 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
25
26 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/Python/python-r1/dev-guide.xml,v 1.5 2012/11/27 20:41:24 mgorny Exp $ -->
27 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/Python/python-r1/dev-guide.xml,v 1.6 2012/11/28 19:49:28 mgorny Exp $ -->
28
29 <guide lang="en">
30 <title>python-r1 Developer's Guide</title>
31 @@ -23,8 +23,8 @@
32 <!-- See http://creativecommons.org/licenses/by-sa/3.0/ -->
33 <license version="3.0"/>
34
35 -<version>5</version>
36 -<date>2012-11-27</date>
37 +<version>6</version>
38 +<date>2012-11-28</date>
39
40 <chapter id="Introductory_info">
41 <title>Introductory information</title>
42 @@ -192,11 +192,12 @@
43 </ol>
44
45 <note>
46 - Please note that the <c>distutils-r1</c>
47 - and <c>python-single-r1</c> eclasses inherit <c>python-r1</c>
48 - implicitly, and <c>python-r1</c> inherits
49 - <c>python-utils-r1</c>. There is therefore no need to ever
50 - inherit more than one eclass from the suite.
51 + Please note that the <c>distutils-r1</c> eclass inherits
52 + <c>python-r1</c> implicitly and all the eclasses inherit
53 + <c>python-utils-r1</c>. <c>python-r1</c>
54 + and <c>python-single-r1</c> can not be used together. There is
55 + therefore no need to ever inherit more than one eclass
56 + from the suite.
57 </note>
58 </body>
59 </section>
60 @@ -312,18 +313,80 @@
61 </section>
62 </chapter>
63
64 -<chapter id="The_fundamentals_of_python_r1_eclass">
65 - <title>The fundamentals of python-r1 eclass</title>
66 +<chapter id="Common_metadata_variables">
67 + <title>Common metadata variables</title>
68
69 <section id="pr1_General_notes">
70 <title>General notes</title>
71
72 <body>
73 - <note>
74 + <p>
75 The variables listed in this section apply to ebuilds using
76 - <c>python-single-r1</c> and <c>distutils-r1</c> eclasses as well,
77 - through the rules of implicit inheritance.
78 - </note>
79 + <c>python-r1</c>, <c>distutils-r1</c>
80 + and <c>python-single-r1</c> eclasses.
81 + </p>
82 +
83 + <p>
84 + The following table lists the differences between the values
85 + of the metadata variables according to the inherited eclass:
86 + </p>
87 +
88 + <table>
89 + <tr>
90 + <th>Variable</th>
91 + <th>Common description</th>
92 + <th>python-r1 and distutils-r1</th>
93 + <th>python-single-r1</th>
94 + </tr>
95 +
96 + <tr>
97 + <ti><c>IUSE</c></ti>
98 + <ti>
99 + USE flags for selecting the interpreter.
100 + </ti>
101 + <ti>
102 + <c>PYTHON_TARGETS</c>
103 + </ti>
104 + <ti>
105 + <c>PYTHON_TARGETS</c> and <c>PYTHON_SINGLE_TARGET</c>
106 + </ti>
107 + </tr>
108 +
109 + <tr>
110 + <ti><c>PYTHON_DEPS</c></ti>
111 + <ti>
112 + Dependencies upon Python interpreters.
113 + </ti>
114 + <ti>
115 + USE-conditional upon <c>PYTHON_TARGETS</c>.
116 + In <c>distutils-r1</c>, automatically added
117 + to <c>RDEPEND</c> and <c>DEPEND</c>.
118 + </ti>
119 + <ti>
120 + USE-conditional upon <c>PYTHON_SINGLE_TARGET</c>.
121 + </ti>
122 + </tr>
123 +
124 + <tr>
125 + <ti><c>PYTHON_USEDEP</c></ti>
126 + <ti>
127 + USE-dependency string for depending on other packages.
128 + </ti>
129 + <ti>
130 + Compatible with packages using <c>python-r1</c>
131 + and <c>python-distutils-ng</c>.
132 + </ti>
133 + <ti>
134 + Compatible with packages using <c>python-r1</c>,
135 + <c>python-single-r1</c> and <c>python-distutils-ng</c>.
136 + </ti>
137 + </tr>
138 + </table>
139 +
140 + <p>
141 + The afore-mentioned variables are described in depth
142 + in the sections following.
143 + </p>
144 </body>
145 </section>