Skip to content

Commit

Permalink
Big tool rename.
Browse files Browse the repository at this point in the history
As promised, this is the "big tool rename" patch.  The primary differences
since 0.99.6 are:

  (1) git-*-script are no more.  The commands installed do not
      have any such suffix so users do not have to remember if
      something is implemented as a shell script or not.

  (2) Many command names with 'cache' in them are renamed with
      'index' if that is what they mean.

There are backward compatibility symblic links so that you and
Porcelains can keep using the old names, but the backward
compatibility support  is expected to be removed in the near
future.

Signed-off-by: Junio C Hamano <[email protected]>
  • Loading branch information
Junio C Hamano committed Sep 8, 2005
1 parent 99977bd commit 215a7ad
Show file tree
Hide file tree
Showing 160 changed files with 1,023 additions and 915 deletions.
20 changes: 10 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
git-apply
git-build-rev-cache
git-cat-file
git-checkout-cache
git-checkout-index
git-clone-pack
git-commit-tree
git-convert-cache
git-convert-objects
git-daemon
git-diff-cache
git-diff-index
git-diff-files
git-diff-helper
git-diff-stages
git-diff-tree
git-export
git-fetch-pack
git-fsck-cache
git-fsck-objects
git-get-tar-commit-id
git-hash-object
git-http-pull
git-http-fetch
git-init-db
git-local-pull
git-local-fetch
git-ls-files
git-ls-tree
git-merge-base
git-merge-cache
git-merge-index
git-mktag
git-pack-objects
git-patch-id
Expand All @@ -37,13 +37,13 @@ git-send-pack
git-show-branch
git-show-index
git-show-rev-cache
git-ssh-pull
git-ssh-push
git-ssh-fetch
git-ssh-upload
git-stripspace
git-tar-tree
git-unpack-file
git-unpack-objects
git-update-cache
git-update-index
git-update-server-info
git-upload-pack
git-var
Expand Down
10 changes: 5 additions & 5 deletions Documentation/diff-format.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
The output format from "git-diff-cache", "git-diff-tree" and
The output format from "git-diff-index", "git-diff-tree" and
"git-diff-files" are very similar.

These commands all compare two sets of things; what are
compared are different:

git-diff-cache <tree-ish>::
git-diff-index <tree-ish>::
compares the <tree-ish> and the files on the filesystem.

git-diff-cache --cached <tree-ish>::
git-diff-index --cached <tree-ish>::
compares the <tree-ish> and the cache.

git-diff-tree [-r] <tree-ish-1> <tree-ish-2> [<pattern>...]::
Expand Down Expand Up @@ -58,7 +58,7 @@ Example:
Generating patches with -p
--------------------------

When "git-diff-cache", "git-diff-tree", or "git-diff-files" are run
When "git-diff-index", "git-diff-tree", or "git-diff-files" are run
with a '-p' option, they do not produce the output described above;
instead they produce a patch file.

Expand All @@ -77,7 +77,7 @@ The "diff" formatting options can be customized via the
environment variable 'GIT_DIFF_OPTS'. For example, if you
prefer context diff:

GIT_DIFF_OPTS=-c git-diff-cache -p $(cat .git/HEAD)
GIT_DIFF_OPTS=-c git-diff-index -p $(cat .git/HEAD)


2. When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
Expand Down
4 changes: 2 additions & 2 deletions Documentation/diffcore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ June 2005
Introduction
------------

The diff commands git-diff-cache, git-diff-files, and
The diff commands git-diff-index, git-diff-files, and
git-diff-tree can be told to manipulate differences they find
in unconventional ways before showing diff(1) output. The
manipulation is collectively called "diffcore transformation".
Expand All @@ -21,7 +21,7 @@ The chain of operation
The git-diff-* family works by first comparing two sets of
files:

- git-diff-cache compares contents of a "tree" object and the
- git-diff-index compares contents of a "tree" object and the
working directory (when '--cached' flag is not used) or a
"tree" object and the index file (when '--cached' flag is
used);
Expand Down
10 changes: 5 additions & 5 deletions Documentation/git-add-script.txt → Documentation/git-add.txt
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
git-add-script(1)
=================
git-add(1)
==========

NAME
----
git-add-script - Add files to the cache.
git-add - Add files to the cache.

SYNOPSIS
--------
'git-add-script' <file>...
'git-add' <file>...

DESCRIPTION
-----------
A simple wrapper to git-update-cache to add files to the cache for people used
A simple wrapper to git-update-index to add files to the cache for people used
to do "cvs add".

OPTIONS
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
git-archimport-script(1)
========================
git-archimport(1)
=================

NAME
----
git-archimport-script - Import an arch repository into git
git-archimport - Import an arch repository into git


SYNOPSIS
--------
`git-archimport-script` [--option...] <args>
`git-archimport` [--option...] <args>

DESCRIPTION
-----------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
git-bisect-script(1)
====================
git-bisect(1)
=============

NAME
----
git-bisect-script - Find the change that introduced a bug
git-bisect - Find the change that introduced a bug


SYNOPSIS
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
git-branch-script(1)
====================
git-branch(1)
=============

NAME
----
git-branch-script - Create a new branch.
git-branch - Create a new branch.

SYNOPSIS
--------
'git-branch-script' [<branchname> [start-point]]
'git-branch' [<branchname> [start-point]]

DESCRIPTION
-----------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
git-checkout-cache(1)
git-checkout-index(1)
=====================
v0.1, May 2005

NAME
----
git-checkout-cache - Copy files from the cache to the working directory
git-checkout-index - Copy files from the cache to the working directory


SYNOPSIS
--------
'git-checkout-cache' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>]
'git-checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>]
[--] <file>...

DESCRIPTION
Expand Down Expand Up @@ -46,48 +46,48 @@ OPTIONS

Note that the order of the flags matters:

git-checkout-cache -a -f file.c
git-checkout-index -a -f file.c

will first check out all files listed in the cache (but not overwrite
any old ones), and then force-checkout `file.c` a second time (ie that
one *will* overwrite any old contents with the same filename).

Also, just doing "git-checkout-cache" does nothing. You probably meant
"git-checkout-cache -a". And if you want to force it, you want
"git-checkout-cache -f -a".
Also, just doing "git-checkout-index" does nothing. You probably meant
"git-checkout-index -a". And if you want to force it, you want
"git-checkout-index -f -a".

Intuitiveness is not the goal here. Repeatability is. The reason for
the "no arguments means no work" thing is that from scripts you are
supposed to be able to do things like:

find . -name '*.h' -print0 | xargs -0 git-checkout-cache -f --
find . -name '*.h' -print0 | xargs -0 git-checkout-index -f --

which will force all existing `*.h` files to be replaced with their
cached copies. If an empty command line implied "all", then this would
force-refresh everything in the cache, which was not the point.

To update and refresh only the files already checked out:

git-checkout-cache -n -f -a && git-update-cache --ignore-missing --refresh
git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh

Oh, and the "--" is just a good idea when you know the rest will be
filenames. Just so that you wouldn't have a filename of "-a" causing
problems (not possible in the above example, but get used to it in
scripting!).

The prefix ability basically makes it trivial to use
git-checkout-cache as an "export as tree" function. Just read the
git-checkout-index as an "export as tree" function. Just read the
desired tree into the index, and do a

git-checkout-cache --prefix=git-export-dir/ -a
git-checkout-index --prefix=git-export-dir/ -a

and git-checkout-cache will "export" the cache into the specified
and git-checkout-index will "export" the cache into the specified
directory.

NOTE The final "/" is important. The exported name is literally just
prefixed with the specified string, so you can also do something like

git-checkout-cache --prefix=.merged- Makefile
git-checkout-index --prefix=.merged- Makefile

to check out the currently cached copy of `Makefile` into the file
`.merged-Makefile`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
git-checkout-script(1)
======================
git-checkout(1)
===============

NAME
----
git-checkout-script - Checkout and switch to a branch.
git-checkout - Checkout and switch to a branch.

SYNOPSIS
--------
'git-checkout-script' [-f] [-b <new_branch>] [<branch>]
'git-checkout' [-f] [-b <new_branch>] [<branch>]

DESCRIPTION
-----------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
git-cherry-pick-script(1)
=========================
git-cherry-pick(1)
==================
v0.99.5 Aug 2005

NAME
----
git-cherry-pick-script - Apply the change introduced by an existing commit.
git-cherry-pick - Apply the change introduced by an existing commit.

SYNOPSIS
--------
'git-cherry-pick-script' [-n] [-r] <commit>
'git-cherry-pick' [-n] [-r] <commit>

DESCRIPTION
-----------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
git-clone-script(1)
===================
git-clone(1)
============
v0.1, July 2005

NAME
----
git-clone-script - Clones a repository.
git-clone - Clones a repository.


SYNOPSIS
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
git-commit-script(1)
====================
git-commit(1)
=============
v0.99.4, Aug 2005

NAME
----
git-commit-script - Record your changes
git-commit - Record your changes

SYNOPSIS
--------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
git-convert-cache(1)
====================
git-convert-objects(1)
======================
v0.1, May 2005

NAME
----
git-convert-cache - Converts old-style GIT repository
git-convert-objects - Converts old-style GIT repository


SYNOPSIS
--------
'git-convert-cache'
'git-convert-objects'

DESCRIPTION
-----------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
git-count-objects-script(1)
===========================
git-count-objects(1)
====================

NAME
----
git-count-objects-script - Reports on unpacked objects.
git-count-objects - Reports on unpacked objects.

SYNOPSIS
--------
'git-count-objects-script'
'git-count-objects'

DESCRIPTION
-----------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
git-cvsimport-script(1)
=======================
git-cvsimport(1)
================
v0.1, July 2005

NAME
----
git-cvsimport-script - Import a CVS repository into git
git-cvsimport - Import a CVS repository into git


SYNOPSIS
--------
'git-cvsimport-script' [ -o <branch-for-HEAD> ] [ -h ] [ -v ]
'git-cvsimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ]
[ -d <CVSROOT> ] [ -p <options-for-cvsps> ]
[ -C <GIT_repository> ] [ -i ] [ -k ]
[ -s <subst> ] [ -m ] [ -M regex ] [ <CVS_module> ]
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-diff-files.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ DESCRIPTION
Compares the files in the working tree and the cache. When paths
are specified, compares only those named paths. Otherwise all
entries in the cache are compared. The output format is the
same as "git-diff-cache" and "git-diff-tree".
same as "git-diff-index" and "git-diff-tree".

OPTIONS
-------
Expand Down
Loading

0 comments on commit 215a7ad

Please sign in to comment.