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

Contents of /xml/htdocs/proj/en/glep/glep-0024.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (hide annotations) (download)
Wed Mar 17 14:27:06 2004 UTC (10 years, 6 months ago) by g2boojum
Branch: MAIN
Changes since 1.1: +8 -10 lines
File MIME type: text/plain
fixo

1 g2boojum 1.1 GLEP: 24
2     Title: Consistent Gentoo tool naming scheme
3 g2boojum 1.2 Version: $Revision: 1.1 $
4     Last-Modified: $Date: 2004/03/17 14:17:26 $
5 g2boojum 1.1 Author: Donnie Berkholz <spyderous@gentoo.org>,
6     Status: Draft
7     Type: Standards
8     Content-Type: text/x-rst
9     Created: 16 March 2004
10     Post-History: 17-Mar-2004
11    
12    
13     Abstract
14     ========
15    
16     This GLEP proposes to create a more consistent, logical and usable naming
17     scheme for Gentoo-specific configuration and update tools. It proposes
18     changing the scheme to gentoo-config-<toolname> and gentoo-update-<toolname>.
19    
20    
21     Motivation
22     ==========
23    
24     A consistent prefix on these tools will allow users to easily find them on the
25     system by merely entering "gentoo-<tab><tab>" for a complete listing or
26     "gentoo-config-<tab><tab>" or "gentoo-update-<tab><tab>" to get a listing of
27     the specific category.
28    
29     In the current situation, it is trivial to miss a configuration tool unless one
30     reads a portage log of installed files for a package. Revamping the naming
31     scheme would enable users to find these tools more easily.
32    
33    
34     Specification
35     =============
36    
37     The following packages and tools are affected (gentoo- prefix removed for ease
38     of reading, current name follows suggested name)::
39    
40     config-kernel
41     x11-base/opengl-update -> config-opengl (opengl-update)
42     sys-devel/distcc -> config-distcc (distcc-config)
43     app-admin/zope-config -> config-zope (zope-config)
44     app-sci/blas-config -> config-blas (blas-config)
45     dev-java/java-config -> config-java (java-config)
46     dev-ruby/ruby-config -> config-ruby (ruby-config)
47     net-www/webapp-config -> config-webapp (webapp-config)
48     sys-devel/cc-config -> config-cc (cc-config)
49     sys-devel/gcc-config -> config-gcc (gcc-config)
50     dev-lang/python -> update-python (python-updater)
51     sys-apps/baselayout -> update-modules (modules-update)
52     sys-apps/baselayout -> update-env (env-update)
53     sys-apps/baselayout -> update-etc (etc-update)
54     sys-apps/baselayout -> config-rc (rc-update)
55    
56    
57     Rationale
58     =========
59    
60 g2boojum 1.2 Three primary options were presented for the naming scheme:
61 g2boojum 1.1
62 g2boojum 1.2 * The current scheme, \*-config and \*-update. This scheme makes finding a
63 g2boojum 1.1 tool difficult, since there is no consistency in the beginning of the name.
64     However, it may be easier for people who already know such a tool exists and
65     remember that its name correlates with the package to be configured (except
66 g2boojum 1.2 in the case of many of the \*-update tools).
67 g2boojum 1.1
68     * A slightly modified version of the proposed scheme, with an abbreviated
69 g2boojum 1.2 prefix, shorter than gentoo-\*. For example, the current gcc-config would
70 g2boojum 1.1 become gen-config-gcc or g-config-gcc. Although this is shorter to type, the
71     availability of tab completion renders that point largely moot. It may also
72     contribute to confusion through inexact specification of what it is.
73    
74 g2boojum 1.2 * The proposed scheme, gentoo-{config,update}-\*. It provides a streamlined way
75 g2boojum 1.1 to discover and use various Gentoo-specific tools, even if one does not
76     remember the exact name. A minor downside is the length of the names, but
77     again this caveat is largely moot because of tab completion.
78    
79 g2boojum 1.2 In an example of another distribution, Red Hat moved to a redhat-config-\*
80 g2boojum 1.1 scheme within the past couple of years to provide more consistent and
81     easier-to-find tools.
82    
83     After two discussions on gentoo-dev, the majority favored this unified prefix
84     for the tools, with a minority in objection, variously favoring one of the
85     first two schemes above.
86    
87    
88     Backwards Compatibility
89     =======================
90    
91     To ensure a smooth transition, a wrapper script will be provided in the old
92     location. This wrapper will print a warning, sleep 5 seconds, then run the
93     tool from its new location. The wrapper script should be provided for the next
94     two new ebuilds for the package, whether they are revision or version bumps.
95     On the third update, the wrapper script will be removed.
96    
97     In addition, einfo warnings will be added in the ebuilds for the first three
98     new ebuilds. They will run in one more ebuild beyond removal of the wrapper
99     script.
100    
101    
102     Reference Implementation
103     ========================
104    
105     not yet ..
106    
107    
108     Copyright
109     =========
110    
111     This document has been placed in the public domain.

  ViewVC Help
Powered by ViewVC 1.1.20