@matheusbsbs / matheus-bagliano / commits / 28e50bdb51
Fork 0

Describe tool renames plan.

Signed-off-by: Junio C Hamano <junkio@cox.net>

Junio C Hamano committed Sep 7, 2005 at 15:19 UTC 28e50bdb5183ced6fd14ddb850d879f6178895be
1 file changed +48 -1
TODO
+48 -1
@@ -4,7 +4,54 @@ What to expect after 0.99.6
4 This is written in a form of to-do list for me, so if I say
5 "accept patch", it means I do not currently plan to do that
6 myself. People interested in seeing it materialize please take
7 -a hint.
7 +a hint. The latest copy of this document is found at
8 +
9 + http://kernel.org/git/?p=git/git.git;a=blob;hb=todo;f=TODO
10 +
11 +Tool Renames Plan
12 +-----------------
13 +
14 + - All non-binary commands will lose -script suffix in
15 + $(bindir). The source to git-foo will be either git-foo.sh
16 + or git-foo.perl in the source tree, and the documentation
17 + will be in Documentation/git-foo.txt.
18 +
19 + - The commands whose names have 'cache' to mean 'index file'
20 + will get 'cache' in their names replaced with 'index'. For
21 + git-fsck-cache and git-convert-cache, 'cache' will be
22 + replaced with 'objects'.
23 +
24 + - The commit walkers will have 'pull' in their names replaced
25 + with 'fetch'. 'git-ssh-push' will become 'git-ssh-upload'.
26 +
27 + - We continue to follow the convention to name the C source
28 + file that contains the main program of 'git-foo' command
29 + 'foo.c'. That means we will have 'fsck-objects.c', for
30 + example.
31 +
32 + - At this moment, I am not planning to rename the symbols used
33 + in programs, nor any library sources. "cache.h" will stay
34 + "cache.h", so does "read-cache.c". "struct cache_entry" and
35 + "ce_match_stat()" will keep their names. We _might_ want to
36 + rename them in later rounds but not right now.
37 +
38 + - In 0.99.7, all renamed commands will have symbolic links in
39 + $(bindir) so that old names continue to work. These backward
40 + compatible symlinks will not be present in documentation,
41 + though. Especially, the main documentation, git(7) will talk
42 + about the new names. Old environment names defined in
43 + gitenv() will also be removed in this release.
44 +
45 + Tentatively we aim to do this on Sep 17th.
46 +
47 + - In 0.99.8, we do not install these backward compatible
48 + symbolic links in $(bindir) anymore. The Makefile will have
49 + a target to remove old symlinks from $(DESTDIR)$(bindir) you
50 + can run manually to help you clean things up.
51 +
52 + The timeframe for this is around Oct 1st, but I could be
53 + talked into delaying the symlink removal if Porcelain people
54 + find this schedule too tight.
55
56
57 Documentation