/[gentoo]/xml/htdocs/proj/en/glep/glep-0031.html
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0031.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.1 Revision 1.4
6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links 6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! 7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8--> 8-->
9<head> 9<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.3: http://docutils.sourceforge.net/" /> 11 <meta name="generator" content="Docutils 0.3.9: http://docutils.sourceforge.net/" />
12 <title>GLEP 31 -- Character Sets for Portage Tree Items</title> 12 <title>GLEP 31 -- Character Sets for Portage Tree Items</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 13 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14</head> 14</head>
15<body bgcolor="white"> 15<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 16<table class="navigation" cellpadding="0" cellspacing="0"
22<td class="textlinks" align="left"> 22<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
24[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] 24[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
25[<b><a href="./glep-0031.txt">GLEP Source</a></b>] 25[<b><a href="./glep-0031.txt">GLEP Source</a></b>]
26</td></tr></table> 26</td></tr></table>
27<div class="document">
28<table class="rfc2822 field-list" frame="void" rules="none"> 27<table class="rfc2822 docutils field-list" frame="void" rules="none">
29<col class="field-name" /> 28<col class="field-name" />
30<col class="field-body" /> 29<col class="field-body" />
31<tbody valign="top"> 30<tbody valign="top">
32<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">31</td> 31<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">31</td>
33</tr> 32</tr>
34<tr class="field"><th class="field-name">Title:</th><td class="field-body">Character Sets for Portage Tree Items</td> 33<tr class="field"><th class="field-name">Title:</th><td class="field-body">Character Sets for Portage Tree Items</td>
35</tr> 34</tr>
36<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 35<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td>
37</tr> 36</tr>
38<tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;</td> 37<tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;</td>
39</tr> 38</tr>
40<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0031.txt?cvsroot=gentoo">2004/10/28 17:00:22</a></td> 39<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0031.txt?cvsroot=gentoo">2005/10/30 21:35:50</a></td>
41</tr> 40</tr>
42<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 41<tr class="field"><th class="field-name">Status:</th><td class="field-body">Approved</td>
43</tr> 42</tr>
44<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 43<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
45</tr> 44</tr>
46<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td> 45<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="http://www.python.org/peps/glep-0012.html">text/x-rst</a></td>
47</tr> 46</tr>
48<tr class="field"><th class="field-name">Created:</th><td class="field-body">27-October-2004</td> 47<tr class="field"><th class="field-name">Created:</th><td class="field-body">27-Oct-2004</td>
49</tr> 48</tr>
50<tr class="field"><th class="field-name">Post-Date:</th><td class="field-body">28-October-2004</td> 49<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">28-Oct-2004, 1-Nov-2004, 11-Nov-2004</td>
51</tr> 50</tr>
52</tbody> 51</tbody>
53</table> 52</table>
54<hr /> 53<hr />
55<div class="contents topic" id="contents"> 54<div class="contents topic" id="contents">
56<p class="topic-title first"><a name="contents">Contents</a></p> 55<p class="topic-title first"><a name="contents">Contents</a></p>
57<ul class="simple"> 56<ul class="simple">
58<li><a class="reference" href="#abstract" id="id7" name="id7">Abstract</a></li> 57<li><a class="reference" href="#abstract" id="id9" name="id9">Abstract</a></li>
58<li><a class="reference" href="#status" id="id10" name="id10">Status</a></li>
59<li><a class="reference" href="#motivation" id="id8" name="id8">Motivation</a></li> 59<li><a class="reference" href="#motivation" id="id11" name="id11">Motivation</a></li>
60<li><a class="reference" href="#specification" id="id9" name="id9">Specification</a><ul> 60<li><a class="reference" href="#specification" id="id12" name="id12">Specification</a><ul>
61<li><a class="reference" href="#changelog-and-metadata-character-sets" id="id10" name="id10">ChangeLog and Metadata Character Sets</a></li> 61<li><a class="reference" href="#changelog-and-metadata-character-sets" id="id13" name="id13">ChangeLog and Metadata Character Sets</a></li>
62<li><a class="reference" href="#ebuild-and-eclass-character-sets" id="id11" name="id11">Ebuild and Eclass Character Sets</a></li> 62<li><a class="reference" href="#ebuild-and-eclass-character-sets" id="id14" name="id14">Ebuild and Eclass Character Sets</a></li>
63<li><a class="reference" href="#files-entries-character-sets" id="id12" name="id12">files/ Entries Character Sets</a></li> 63<li><a class="reference" href="#files-entries-character-sets" id="id15" name="id15">files/ Entries Character Sets</a></li>
64<li><a class="reference" href="#suitable-characters-for-file-and-directory-names" id="id13" name="id13">Suitable Characters for File and Directory Names</a></li> 64<li><a class="reference" href="#suitable-characters-for-file-and-directory-names" id="id16" name="id16">Suitable Characters for File and Directory Names</a></li>
65</ul> 65</ul>
66</li> 66</li>
67<li><a class="reference" href="#backwards-compatibility" id="id14" name="id14">Backwards Compatibility</a></li> 67<li><a class="reference" href="#backwards-compatibility" id="id17" name="id17">Backwards Compatibility</a></li>
68<li><a class="reference" href="#references" id="id15" name="id15">References</a></li> 68<li><a class="reference" href="#references" id="id18" name="id18">References</a></li>
69<li><a class="reference" href="#copyright" id="id16" name="id16">Copyright</a></li> 69<li><a class="reference" href="#copyright" id="id19" name="id19">Copyright</a></li>
70</ul> 70</ul>
71</div> 71</div>
72<div class="section" id="abstract"> 72<div class="section" id="abstract">
73<h1><a class="toc-backref" href="#id7" name="abstract">Abstract</a></h1> 73<h1><a class="toc-backref" href="#id9" name="abstract">Abstract</a></h1>
74<p>A set of rules regarding what characters are permissible in the portage 74<p>A set of guidelines regarding what characters are permissible in the
75tree and how they should be encoded is required.</p> 75portage tree and how they should be encoded is required.</p>
76</div>
77<div class="section" id="status">
78<h1><a class="toc-backref" href="#id10" name="status">Status</a></h1>
79<p>Approved on 8-Nov-2004 assuming that implementation will include
80documentation for correctly encoding files within nano.</p>
76</div> 81</div>
77<div class="section" id="motivation"> 82<div class="section" id="motivation">
78<h1><a class="toc-backref" href="#id8" name="motivation">Motivation</a></h1> 83<h1><a class="toc-backref" href="#id11" name="motivation">Motivation</a></h1>
79<p>At present we have several developers and many more users whose names 84<p>At present we have several developers and many more users whose names
80require characters (for example, accents) which are not part of the 85require characters (for example, accents) which are not part of the
81standard 'safe' 0..127 ASCII range. There is no current standard on how 86standard 'safe' 0..127 ASCII range. There is no current standard on how
82these should be represented, leading to inconsistency across the tree.</p> 87these should be represented, leading to inconsistency across the tree.</p>
83<p>Although the issues involved have been discussed many times informally, no 88<p>Although the issues involved have been discussed informally many times, no
84official decision has been made.</p> 89official decision has been made.</p>
85</div> 90</div>
86<div class="section" id="specification"> 91<div class="section" id="specification">
87<h1><a class="toc-backref" href="#id9" name="specification">Specification</a></h1> 92<h1><a class="toc-backref" href="#id12" name="specification">Specification</a></h1>
88<div class="section" id="changelog-and-metadata-character-sets"> 93<div class="section" id="changelog-and-metadata-character-sets">
89<h2><a class="toc-backref" href="#id10" name="changelog-and-metadata-character-sets">ChangeLog and Metadata Character Sets</a></h2> 94<h2><a class="toc-backref" href="#id13" name="changelog-and-metadata-character-sets">ChangeLog and Metadata Character Sets</a></h2>
90<p>It is proposed that UTF-8 (<a class="footnote-reference" href="#id4" id="id1" name="id1">[1]</a>) is used for encoding ChangeLog and 95<p>It is proposed that UTF-8 (<a class="footnote-reference" href="#id5" id="id1" name="id1">[1]</a>) is used for encoding ChangeLog and
91metadata.xml files inside the portage tree.</p> 96metadata.xml files inside the portage tree.</p>
92<p>UTF-8 allows the full range of Unicode (<a class="footnote-reference" href="#id5" id="id2" name="id2">[2]</a>) characters to be expressed, 97<p>UTF-8 allows the full range of Unicode (<a class="footnote-reference" href="#id6" id="id2" name="id2">[2]</a>) characters to be expressed,
93which is necessary given the diversity of the Gentoo developer- and 98which is necessary given the diversity of the Gentoo developer- and
94user-base. It is character-compatible with ASCII for the 0..127 99user-base. It is character-compatible with ASCII for the 0..127
95characters and does not significantly increase the storage requirements 100characters and does not significantly increase the storage requirements
96for files which consist mainly of American English characters. It is 101for files which consist mainly of American English characters. It is
97widely supported, widely used and an official standard.</p> 102widely supported, widely used and an official standard.</p>
98<p>The ISO-8859-* character sets (<a class="footnote-reference" href="#id6" id="id3" name="id3">[3]</a>) would <em>not</em> be appropriate since they 103<p>The ISO-8859-* character sets (<a class="footnote-reference" href="#id7" id="id3" name="id3">[3]</a>) would <em>not</em> be appropriate since they
99cannot express the full range of required characters.</p> 104cannot express the full range of required characters.</p>
100</div> 105</div>
101<div class="section" id="ebuild-and-eclass-character-sets"> 106<div class="section" id="ebuild-and-eclass-character-sets">
102<h2><a class="toc-backref" href="#id11" name="ebuild-and-eclass-character-sets">Ebuild and Eclass Character Sets</a></h2> 107<h2><a class="toc-backref" href="#id14" name="ebuild-and-eclass-character-sets">Ebuild and Eclass Character Sets</a></h2>
103<p>For the same reasons as previously, it is proposed that UTF-8 is used as 108<p>For the same reasons as previously, it is proposed that UTF-8 is used as
104the official encoding for ebuild and eclass files.</p> 109the official encoding for ebuild and eclass files.</p>
105<p>However, developers should be warned that any output which is parsed by 110<p>However, developers should be warned that any code which is parsed by bash
106bash (in other words, non-comments), and any output which is echoed to the 111(in other words, non-comments), and any output which is echoed to the
107screen (for example, einfo messages) must not use anything outside the 112screen (for example, einfo messages) or given to portage (for example any
113of the standard global variables) must not use anything outside the
108regular ASCII 0..127 range for compatibility purposes.</p> 114regular ASCII 0..127 range for compatibility purposes.</p>
109</div> 115</div>
110<div class="section" id="files-entries-character-sets"> 116<div class="section" id="files-entries-character-sets">
111<h2><a class="toc-backref" href="#id12" name="files-entries-character-sets">files/ Entries Character Sets</a></h2> 117<h2><a class="toc-backref" href="#id15" name="files-entries-character-sets">files/ Entries Character Sets</a></h2>
112<p>Patches must clearly be in the same character set as the file they are 118<p>Patches must clearly be in the same character set as the file they are
113patching. For other files/ entries (for example, GNOME desktop files), 119patching. For other files/ entries (for example, GNOME desktop files),
114consistency with the upstream-recommended character set is most sensible.</p> 120consistency with the upstream-recommended character set is most sensible.</p>
115</div> 121</div>
116<div class="section" id="suitable-characters-for-file-and-directory-names"> 122<div class="section" id="suitable-characters-for-file-and-directory-names">
117<h2><a class="toc-backref" href="#id13" name="suitable-characters-for-file-and-directory-names">Suitable Characters for File and Directory Names</a></h2> 123<h2><a class="toc-backref" href="#id16" name="suitable-characters-for-file-and-directory-names">Suitable Characters for File and Directory Names</a></h2>
118<p>Characters outside the ASCII 0..127 range cannot safely be used for file 124<p>Characters outside the ASCII 0..127 range cannot safely be used for file
119or directory names. (Of course, not all characters inside the ASCII 0..127 125or directory names. (Of course, not all characters inside the ASCII 0..127
120range can be used safely either.)</p> 126range can be used safely either.)</p>
121</div> 127</div>
122</div> 128</div>
123<div class="section" id="backwards-compatibility"> 129<div class="section" id="backwards-compatibility">
124<h1><a class="toc-backref" href="#id14" name="backwards-compatibility">Backwards Compatibility</a></h1> 130<h1><a class="toc-backref" href="#id17" name="backwards-compatibility">Backwards Compatibility</a></h1>
125<p>The existing tree uses a mixture of encodings. It would be straightforward 131<p>The existing tree uses a mixture of encodings. It would be straightforward
126to fix existing ChangeLogs and metadata files to use UTF-8.</p> 132to fix existing ChangeLogs and metadata files to use UTF-8.</p>
127<p>The <tt class="literal"><span class="pre">echangelog</span></tt> tool is character-set agnostic. In order to properly 133<p>The <tt class="docutils literal"><span class="pre">echangelog</span></tt> tool is character-set agnostic. In order to properly
128enter UTF-8, developers would have to switch to a UTF-8 shell session. 134enter UTF-8, developers would have to switch to a UTF-8 shell session.
129This only applies if the developer is entering new text which uses 'fancy' 135This only applies if the developer is entering new text which uses 'fancy'
130characters -- existing characters are not mangled.</p> 136characters -- existing characters are not mangled.</p>
131<p>Certain text editors are incapable of handling UTF-8 cleanly. However, 137<p>Certain text editors are incapable of handling UTF-8 cleanly. However,
132since the <tt class="literal"><span class="pre">echangelog</span></tt> tool is generally the correct way to generate 138since the <tt class="docutils literal"><span class="pre">echangelog</span></tt> tool is generally the correct way to generate
133ChangeLog entries, this should not be a major problem. Generating 139ChangeLog entries, this should not be a major problem. Generating
134metadata.xml files correctly in these editors could become problematic. 140metadata.xml files correctly in these editors could become problematic.
135(The <tt class="literal"><span class="pre">vim</span></tt> and <tt class="literal"><span class="pre">emacs</span></tt> editors, which appear to be most widely used, 141The <tt class="docutils literal"><span class="pre">vim</span></tt> and <tt class="docutils literal"><span class="pre">emacs</span></tt> editors, which appear to be most widely used,
136are both capable of handling UTF-8 cleanly.)</p> 142are both capable of handling UTF-8 cleanly -- for vim, this could be
143configured automatically via the <tt class="docutils literal"><span class="pre">gentoo-syntax</span></tt> (<a class="footnote-reference" href="#id8" id="id4" name="id4">[4]</a>) package.</p>
137</div> 144</div>
138<div class="section" id="references"> 145<div class="section" id="references">
139<h1><a class="toc-backref" href="#id15" name="references">References</a></h1> 146<h1><a class="toc-backref" href="#id18" name="references">References</a></h1>
140<table class="footnote" frame="void" id="id4" rules="none"> 147<table class="docutils footnote" frame="void" id="id5" rules="none">
141<colgroup><col class="label" /><col /></colgroup> 148<colgroup><col class="label" /><col /></colgroup>
142<tbody valign="top"> 149<tbody valign="top">
143<tr><td class="label"><a class="fn-backref" href="#id1" name="id4">[1]</a></td><td><a class="reference" href="http://www.faqs.org/rfcs/rfc3629.html">RFC 3629</a>: UTF-8, a transformation format of ISO 10646 150<tr><td class="label"><a class="fn-backref" href="#id1" name="id5">[1]</a></td><td><a class="reference" href="http://www.faqs.org/rfcs/rfc3629.html">RFC 3629</a>: UTF-8, a transformation format of ISO 10646
144<a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr> 151<a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr>
145</tbody> 152</tbody>
146</table> 153</table>
147<table class="footnote" frame="void" id="id5" rules="none"> 154<table class="docutils footnote" frame="void" id="id6" rules="none">
148<colgroup><col class="label" /><col /></colgroup> 155<colgroup><col class="label" /><col /></colgroup>
149<tbody valign="top"> 156<tbody valign="top">
150<tr><td class="label"><a class="fn-backref" href="#id2" name="id5">[2]</a></td><td>ISO/IEC 10646 (Universal Multiple-Octet Coded Character Set)</td></tr> 157<tr><td class="label"><a class="fn-backref" href="#id2" name="id6">[2]</a></td><td>ISO/IEC 10646 (Universal Multiple-Octet Coded Character Set)</td></tr>
151</tbody> 158</tbody>
152</table> 159</table>
153<table class="footnote" frame="void" id="id6" rules="none"> 160<table class="docutils footnote" frame="void" id="id7" rules="none">
154<colgroup><col class="label" /><col /></colgroup> 161<colgroup><col class="label" /><col /></colgroup>
155<tbody valign="top"> 162<tbody valign="top">
156<tr><td class="label"><a class="fn-backref" href="#id3" name="id6">[3]</a></td><td>ISO/IEC 8859 (8-bit single-byte coded graphic character sets)</td></tr> 163<tr><td class="label"><a class="fn-backref" href="#id3" name="id7">[3]</a></td><td>ISO/IEC 8859 (8-bit single-byte coded graphic character sets)</td></tr>
164</tbody>
165</table>
166<table class="docutils footnote" frame="void" id="id8" rules="none">
167<colgroup><col class="label" /><col /></colgroup>
168<tbody valign="top">
169<tr><td class="label"><a class="fn-backref" href="#id4" name="id8">[4]</a></td><td>The app-vim/gentoo-syntax package,
170<a class="reference" href="https://developer.berlios.de/projects/gentoo-syntax/">https://developer.berlios.de/projects/gentoo-syntax/</a></td></tr>
157</tbody> 171</tbody>
158</table> 172</table>
159</div> 173</div>
160<div class="section" id="copyright"> 174<div class="section" id="copyright">
161<h1><a class="toc-backref" href="#id16" name="copyright">Copyright</a></h1> 175<h1><a class="toc-backref" href="#id19" name="copyright">Copyright</a></h1>
162<p>This document has been placed in the public domain.</p> 176<p>This document has been placed in the public domain.</p>
163<blockquote>
164vim: set tw=74 fileencoding=utf-8 :</blockquote> 177<!-- vim: set tw=74 fileencoding=utf-8 : -->
165</div>
166</div> 178</div>
167 179
180</div>
181<div class="footer">
168<hr class="footer" /> 182<hr class="footer" />
169<div class="footer">
170<a class="reference" href="glep-0031.txt">View document source</a>. 183<a class="reference" href="glep-0031.txt">View document source</a>.
171Generated on: 2004-10-28 16:53 UTC. 184Generated on: 2005-11-07 22:15 UTC.
172Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. 185Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
186
173</div> 187</div>
174</body> 188</body>
175</html> 189</html>
176 190

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.4

  ViewVC Help
Powered by ViewVC 1.1.20