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

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

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

Revision 1.1 Revision 1.5
1GLEP: 31 1GLEP: 31
2Title: Character Sets for Portage Tree Items 2Title: Character Sets for Portage Tree Items
3Version: $Revision: 1.1 $ 3Version: $Revision: 1.5 $
4Author: Ciaran McCreesh <ciaranm@gentoo.org> 4Author: Ciaran McCreesh <ciaranm@gentoo.org>
5Last-Modified: $Date: 2004/10/28 17:00:22 $ 5Last-Modified: $Date: 2005/11/07 22:26:59 $
6Status: Draft 6Status: Approved
7Type: Standards Track 7Type: Standards Track
8Content-Type: text/x-rst 8Content-Type: text/x-rst
9Created: 27-October-2004 9Created: 27-Oct-2004
10Post-Date: 28-October-2004 10Post-History: 28-Oct-2004, 1-Nov-2004, 11-Nov-2004
11 11
12Abstract 12Abstract
13======== 13========
14 14
15A set of rules regarding what characters are permissible in the portage 15A set of guidelines regarding what characters are permissible in the
16tree and how they should be encoded is required. 16portage tree and how they should be encoded is required.
17
18Status
19======
20
21Approved on 8-Nov-2004 assuming that implementation will include
22documentation for correctly encoding files within nano.
17 23
18Motivation 24Motivation
19========== 25==========
20 26
21At present we have several developers and many more users whose names 27At present we have several developers and many more users whose names
22require characters (for example, accents) which are not part of the 28require characters (for example, accents) which are not part of the
23standard 'safe' 0..127 ASCII range. There is no current standard on how 29standard 'safe' 0..127 ASCII range. There is no current standard on how
24these should be represented, leading to inconsistency across the tree. 30these should be represented, leading to inconsistency across the tree.
25 31
26Although the issues involved have been discussed many times informally, no 32Although the issues involved have been discussed informally many times, no
27official decision has been made. 33official decision has been made.
28 34
29Specification 35Specification
30============= 36=============
31 37
49-------------------------------- 55--------------------------------
50 56
51For the same reasons as previously, it is proposed that UTF-8 is used as 57For the same reasons as previously, it is proposed that UTF-8 is used as
52the official encoding for ebuild and eclass files. 58the official encoding for ebuild and eclass files.
53 59
54However, developers should be warned that any output which is parsed by 60However, developers should be warned that any code which is parsed by bash
55bash (in other words, non-comments), and any output which is echoed to the 61(in other words, non-comments), and any output which is echoed to the
56screen (for example, einfo messages) must not use anything outside the 62screen (for example, einfo messages) or given to portage (for example any
63of the standard global variables) must not use anything outside the
57regular ASCII 0..127 range for compatibility purposes. 64regular ASCII 0..127 range for compatibility purposes.
58 65
59files/ Entries Character Sets 66files/ Entries Character Sets
60----------------------------- 67-----------------------------
61 68
83 90
84Certain text editors are incapable of handling UTF-8 cleanly. However, 91Certain text editors are incapable of handling UTF-8 cleanly. However,
85since the ``echangelog`` tool is generally the correct way to generate 92since the ``echangelog`` tool is generally the correct way to generate
86ChangeLog entries, this should not be a major problem. Generating 93ChangeLog entries, this should not be a major problem. Generating
87metadata.xml files correctly in these editors could become problematic. 94metadata.xml files correctly in these editors could become problematic.
88(The ``vim`` and ``emacs`` editors, which appear to be most widely used, 95The ``vim`` and ``emacs`` editors, which appear to be most widely used,
89are both capable of handling UTF-8 cleanly.) 96are both capable of handling UTF-8 cleanly -- for vim, this could be
97configured automatically via the ``gentoo-syntax`` ([4]_) package.
90 98
91References 99References
92========== 100==========
93 101
94.. [1] RFC 3629: UTF-8, a transformation format of ISO 10646 102.. [1] RFC 3629: UTF-8, a transformation format of ISO 10646
95 http://www.ietf.org/rfc/rfc3629.txt 103 http://www.ietf.org/rfc/rfc3629.txt
96.. [2] ISO/IEC 10646 (Universal Multiple-Octet Coded Character Set) 104.. [2] ISO/IEC 10646 (Universal Multiple-Octet Coded Character Set)
97.. [3] ISO/IEC 8859 (8-bit single-byte coded graphic character sets) 105.. [3] ISO/IEC 8859 (8-bit single-byte coded graphic character sets)
106.. [4] The app-vim/gentoo-syntax package,
107 https://developer.berlios.de/projects/gentoo-syntax/
98 108
99Copyright 109Copyright
100========= 110=========
101 111
102This document has been placed in the public domain. 112This document has been placed in the public domain.
103 113
104 vim: set tw=74 fileencoding=utf-8 : 114.. vim: set tw=74 fileencoding=utf-8 :
105 115

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

  ViewVC Help
Powered by ViewVC 1.1.20