Skip to content

Commit

Permalink
[PATCH 1/4] split core-git.txt and update
Browse files Browse the repository at this point in the history
Split the core-git.txt file
Formatting fix to the diff-format.txt

Signed-off-by: David Greaves <[email protected]>
  • Loading branch information
lbt authored and Junio C Hamano committed May 10, 2005
1 parent 3be4b61 commit 2cf565c
Show file tree
Hide file tree
Showing 39 changed files with 2,262 additions and 1,712 deletions.
1,660 changes: 0 additions & 1,660 deletions Documentation/core-git.txt

This file was deleted.

16 changes: 8 additions & 8 deletions Documentation/diff-format.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ customization also applies to "git-diff-tree-helper".
these commands internally invoke "diff" like this:

diff -L a/<path> -L a/<path> -pu <old> <new>
+
For added files, `/dev/null` is used for <old>. For removed
files, `/dev/null` is used for <new>
+
The "diff" formatting options can be customized via the
environment variable 'GIT_DIFF_OPTS'. For example, if you
prefer context diff:

For added files, `/dev/null` is used for <old>. For removed
files, `/dev/null` is used for <new>

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-cache -p $(cat .git/HEAD)


2. When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
Expand Down
32 changes: 32 additions & 0 deletions Documentation/git-apply-patch-script.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
git-apply-patch-script(1)
=========================
v0.1, May 2005

NAME
----
git-apply-patch-script - Sample script to apply the diffs from git-diff-*


SYNOPSIS
--------
'git-apply-patch-script'

DESCRIPTION
-----------
This is a sample script to be used via the 'GIT_EXTERNAL_DIFF'
environment variable to apply the differences that the "git-diff-*"
family of commands report to the current work tree.


Author
------
Written by Linus Torvalds <[email protected]>

Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <[email protected]>.

GIT
---
Part of the link:git.html[git] suite

55 changes: 55 additions & 0 deletions Documentation/git-cat-file.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
git-cat-file(1)
===============
v0.1, May 2005

NAME
----
git-cat-file - Provide content or type information for repository objects


SYNOPSIS
--------
'git-cat-file' (-t | <type>) <object>

DESCRIPTION
-----------
Provides content or type of objects in the repository. The type
is required if '-t' is not being used to find the object type.

OPTIONS
-------
<object>::
The sha1 identifier of the object.

-t::
Instead of the content, show the object type identified by
<object>.

<type>::
Typically this matches the real type of <object> but asking
for a type that can trivially dereferenced from the given
<object> is also permitted. An example is to ask for a
"tree" with <object> being a commit object that contains it,
or to ask for a "blob" with <object> being a tag object that
points at it.

OUTPUT
------
If '-t' is specified, one of the <type>.

Otherwise the raw (though uncompressed) contents of the <object> will
be returned.


Author
------
Written by Linus Torvalds <[email protected]>

Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <[email protected]>.

GIT
---
Part of the link:git.html[git] suite

48 changes: 48 additions & 0 deletions Documentation/git-check-files.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
git-check-files(1)
==================
v0.1, May 2005

NAME
----
git-check-files - Verify a list of files are up-to-date



SYNOPSIS
--------
'git-check-files' <file>...

DESCRIPTION
-----------
Check that a list of files are up-to-date between the filesystem and
the cache. Used to verify a patch target before doing a patch.

Files that do not exist on the filesystem are considered up-to-date
(whether or not they are in the cache).

Emits an error message on failure:

preparing to update existing file <file> not in cache::
<file> exists but is not in the cache

preparing to update file <file> not uptodate in cache::
<file> on disk is not up-to-date with the cache

Exits with a status code indicating success if all files are
up-to-date.

see also: link:git-update-cache.html[git-update-cache]


Author
------
Written by Linus Torvalds <[email protected]>

Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <[email protected]>.

GIT
---
Part of the link:git.html[git] suite

102 changes: 102 additions & 0 deletions Documentation/git-checkout-cache.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
git-checkout-cache(1)
=====================
v0.1, May 2005

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


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

DESCRIPTION
-----------
Will copy all files listed from the cache to the working directory
(not overwriting existing files).

OPTIONS
-------
-q::
be quiet if files exist or are not in the cache

-f::
forces overwrite of existing files

-a::
checks out all files in the cache (will then continue to
process listed files).

-n::
Don't checkout new files, only refresh files already checked
out.

--prefix=<string>::
When creating files, prepend <string> (usually a directory
including a trailing /)

--::
Do not interpret any more arguments as options.

Note that the order of the flags matters:

git-checkout-cache -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".

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 --

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

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
desired tree into the index, and do a

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

and git-checkout-cache 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

to check out the currently cached copy of `Makefile` into the file
`.merged-Makefile`

Author
------
Written by Linus Torvalds <[email protected]>

Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <[email protected]>.

GIT
---
Part of the link:git.html[git] suite

81 changes: 81 additions & 0 deletions Documentation/git-commit-tree.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
git-commit-tree(1)
==================
v0.1, May 2005

NAME
----
git-commit-tree - Creates a new commit object


SYNOPSIS
--------
'git-commit-tree' <tree> [-p <parent commit>]\ < changelog

DESCRIPTION
-----------
Creates a new commit object based on the provided tree object and
emits the new commit object id on stdout. If no parent is given then
it is considered to be an initial tree.

A commit object usually has 1 parent (a commit after a change) or up
to 16 parents. More than one parent represents a merge of branches
that led to them.

While a tree represents a particular directory state of a working
directory, a commit represents that state in "time", and explains how
to get there.

Normally a commit would identify a new "HEAD" state, and while git
doesn't care where you save the note about that state, in practice we
tend to just write the result to the file `.git/HEAD`, so that we can
always see what the last committed state was.

OPTIONS
-------
<tree>::
An existing tree object

-p <parent commit>::
Each '-p' indicates a the id of a parent commit object.


Commit Information
------------------

A commit encapsulates:

- all parent object ids
- author name, email and date
- committer name and email and the commit time.

If not provided, "git-commit-tree" uses your name, hostname and domain to
provide author and committer info. This can be overridden using the
following environment variables.

GIT_AUTHOR_NAME
GIT_AUTHOR_EMAIL
GIT_AUTHOR_DATE
GIT_COMMITTER_NAME
GIT_COMMITTER_EMAIL

(nb <,> and '\n's are stripped)

A commit comment is read from stdin (max 999 chars). If a changelog
entry is not provided via '<' redirection, "git-commit-tree" will just wait
for one to be entered and terminated with ^D

see also: link:git-write-tree.html[git-write-tree]


Author
------
Written by Linus Torvalds <[email protected]>

Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <[email protected]>.

GIT
---
Part of the link:git.html[git] suite

30 changes: 30 additions & 0 deletions Documentation/git-convert-cache.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
git-convert-cache(1)
====================
v0.1, May 2005

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


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

DESCRIPTION
-----------
Converts old-style GIT repository to the latest format


Author
------
Written by Linus Torvalds <[email protected]>

Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <[email protected]>.

GIT
---
Part of the link:git.html[git] suite

Loading

0 comments on commit 2cf565c

Please sign in to comment.