/[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.2
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.2 $
4Author: Ciaran McCreesh <ciaranm@gentoo.org> 4Author: Ciaran McCreesh <ciaranm@gentoo.org>
5Last-Modified: $Date: 2004/10/28 17:00:22 $ 5Last-Modified: $Date: 2004/11/01 20:24:06 $
6Status: Draft 6Status: Draft
7Type: Standards Track 7Type: Standards Track
8Content-Type: text/x-rst 8Content-Type: text/x-rst
9Created: 27-October-2004 9Created: 27-October-2004
10Post-Date: 28-October-2004 10Post-Date: 28-October-2004, 1-November-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 17
18Motivation 18Motivation
19========== 19==========
20 20
21At present we have several developers and many more users whose names 21At present we have several developers and many more users whose names
22require characters (for example, accents) which are not part of the 22require characters (for example, accents) which are not part of the
23standard 'safe' 0..127 ASCII range. There is no current standard on how 23standard 'safe' 0..127 ASCII range. There is no current standard on how
24these should be represented, leading to inconsistency across the tree. 24these should be represented, leading to inconsistency across the tree.
25 25
26Although the issues involved have been discussed many times informally, no 26Although the issues involved have been discussed informally many times, no
27official decision has been made. 27official decision has been made.
28 28
29Specification 29Specification
30============= 30=============
31 31
49-------------------------------- 49--------------------------------
50 50
51For the same reasons as previously, it is proposed that UTF-8 is used as 51For the same reasons as previously, it is proposed that UTF-8 is used as
52the official encoding for ebuild and eclass files. 52the official encoding for ebuild and eclass files.
53 53
54However, developers should be warned that any output which is parsed by 54However, 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 55(in other words, non-comments), and any output which is echoed to the
56screen (for example, einfo messages) must not use anything outside the 56screen (for example, einfo messages) or given to portage (for example any
57of the standard global variables) must not use anything outside the
57regular ASCII 0..127 range for compatibility purposes. 58regular ASCII 0..127 range for compatibility purposes.
58 59
59files/ Entries Character Sets 60files/ Entries Character Sets
60----------------------------- 61-----------------------------
61 62
83 84
84Certain text editors are incapable of handling UTF-8 cleanly. However, 85Certain text editors are incapable of handling UTF-8 cleanly. However,
85since the ``echangelog`` tool is generally the correct way to generate 86since the ``echangelog`` tool is generally the correct way to generate
86ChangeLog entries, this should not be a major problem. Generating 87ChangeLog entries, this should not be a major problem. Generating
87metadata.xml files correctly in these editors could become problematic. 88metadata.xml files correctly in these editors could become problematic.
88(The ``vim`` and ``emacs`` editors, which appear to be most widely used, 89The ``vim`` and ``emacs`` editors, which appear to be most widely used,
89are both capable of handling UTF-8 cleanly.) 90are both capable of handling UTF-8 cleanly -- for vim, this could be
91configured automatically via the ``gentoo-syntax`` ([4]_) package.
90 92
91References 93References
92========== 94==========
93 95
94.. [1] RFC 3629: UTF-8, a transformation format of ISO 10646 96.. [1] RFC 3629: UTF-8, a transformation format of ISO 10646
95 http://www.ietf.org/rfc/rfc3629.txt 97 http://www.ietf.org/rfc/rfc3629.txt
96.. [2] ISO/IEC 10646 (Universal Multiple-Octet Coded Character Set) 98.. [2] ISO/IEC 10646 (Universal Multiple-Octet Coded Character Set)
97.. [3] ISO/IEC 8859 (8-bit single-byte coded graphic character sets) 99.. [3] ISO/IEC 8859 (8-bit single-byte coded graphic character sets)
100.. [4] The app-vim/gentoo-syntax package,
101 https://developer.berlios.de/projects/gentoo-syntax/
98 102
99Copyright 103Copyright
100========= 104=========
101 105
102This document has been placed in the public domain. 106This document has been placed in the public domain.

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

  ViewVC Help
Powered by ViewVC 1.1.20