diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/Makefile | 6 | ||||
| -rw-r--r-- | Documentation/core-tutorial.txt | 4 | ||||
| -rw-r--r-- | Documentation/everyday.txt | 6 | ||||
| -rw-r--r-- | Documentation/git-cat-file.txt | 9 | ||||
| -rw-r--r-- | Documentation/git-clone.txt | 9 | ||||
| -rw-r--r-- | Documentation/git-read-tree.txt | 11 | ||||
| -rw-r--r-- | Documentation/git-write-tree.txt | 8 | ||||
| -rw-r--r-- | Documentation/technical/pack-format.txt | 11 | ||||
| -rw-r--r-- | Documentation/tutorial-2.txt | 2 | ||||
| -rw-r--r-- | Documentation/tutorial.txt | 12 |
10 files changed, 58 insertions, 20 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index 2a08f592d9..2b0efe7921 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -52,9 +52,9 @@ man1: $(DOC_MAN1) man7: $(DOC_MAN7) install: man - $(INSTALL) -d -m755 $(DESTDIR)/$(man1) $(DESTDIR)/$(man7) - $(INSTALL) $(DOC_MAN1) $(DESTDIR)/$(man1) - $(INSTALL) $(DOC_MAN7) $(DESTDIR)/$(man7) + $(INSTALL) -d -m755 $(DESTDIR)$(man1) $(DESTDIR)$(man7) + $(INSTALL) $(DOC_MAN1) $(DESTDIR)$(man1) + $(INSTALL) $(DOC_MAN7) $(DESTDIR)$(man7) # diff --git a/Documentation/core-tutorial.txt b/Documentation/core-tutorial.txt index d1360ecde2..5a831adf43 100644 --- a/Documentation/core-tutorial.txt +++ b/Documentation/core-tutorial.txt @@ -1,5 +1,5 @@ -A short git tutorial -==================== +A git core tutorial for developers +================================== Introduction ------------ diff --git a/Documentation/everyday.txt b/Documentation/everyday.txt index 4b56370937..2ad2d61300 100644 --- a/Documentation/everyday.txt +++ b/Documentation/everyday.txt @@ -66,7 +66,7 @@ $ git prune <4> <1> running without "--full" is usually cheap and assures the repository health reasonably well. <2> check how many loose objects there are and how much -diskspace is wasted by not repacking. +disk space is wasted by not repacking. <3> without "-a" repacks incrementally. repacking every 4-5MB of loose objects accumulation may be a good rule of thumb. <4> after repack, prune removes the duplicate loose objects. @@ -86,7 +86,7 @@ Individual Developer (Standalone)[[Individual Developer (Standalone)]] ---------------------------------------------------------------------- A standalone individual developer does not exchange patches with -other poeple, and works alone in a single repository, using the +other people, and works alone in a single repository, using the following commands. * gitlink:git-show-branch[1] to see where you are. @@ -370,7 +370,7 @@ Examples Run git-daemon to serve /pub/scm from inetd.:: + ------------ -$ grep git /etc/inet.conf +$ grep git /etc/inetd.conf git stream tcp nowait nobody \ /usr/bin/git-daemon git-daemon --inetd --syslog --export-all /pub/scm ------------ diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index 504eb1b16a..5e9cbf875d 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -8,12 +8,12 @@ git-cat-file - Provide content or type information for repository objects SYNOPSIS -------- -'git-cat-file' [-t | -s | -e | <type>] <object> +'git-cat-file' [-t | -s | -e | -p | <type>] <object> DESCRIPTION ----------- Provides content or type of objects in the repository. The type -is required unless '-t' is used to find the object type, +is required unless '-t' or '-p' is used to find the object type, or '-s' is used to find the object size. OPTIONS @@ -33,6 +33,9 @@ OPTIONS Suppress all output; instead exit with zero status if <object> exists and is a valid object. +-p:: + Pretty-print the contents of <object> based on its type. + <type>:: Typically this matches the real type of <object> but asking for a type that can trivially be dereferenced from the given @@ -49,6 +52,8 @@ If '-s' is specified, the size of the <object> in bytes. If '-e' is specified, no output. +If '-p' is specified, the contents of <object> are pretty-printed. + Otherwise the raw (though uncompressed) contents of the <object> will be returned. diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index b333f51045..94d9393372 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -9,8 +9,8 @@ git-clone - Clones a repository SYNOPSIS -------- [verse] -'git-clone' [-l [-s]] [-q] [-n] [--bare] [-o <name>] [-u <upload-pack>] - [--reference <repository>] +'git-clone' [--template=<template_directory>] [-l [-s]] [-q] [-n] [--bare] + [-o <name>] [-u <upload-pack>] [--reference <repository>] <repository> [<directory>] DESCRIPTION @@ -89,6 +89,11 @@ OPTIONS the command to specify non-default path for the command run on the other end. +--template=<template_directory>:: + Specify the directory from which templates will be used; + if unset the templates are taken from the installation + defined default, typically `/usr/share/git-core/templates`. + <repository>:: The (possibly remote) repository to clone from. It can be any URL git-fetch supports. diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 844cfda8d2..1f21d95684 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -8,7 +8,7 @@ git-read-tree - Reads tree information into the index SYNOPSIS -------- -'git-read-tree' (<tree-ish> | [[-m [--aggressive]| --reset] [-u | -i]] <tree-ish1> [<tree-ish2> [<tree-ish3>]]) +'git-read-tree' (<tree-ish> | [[-m [--aggressive] | --reset | --prefix=<prefix>] [-u | -i]] <tree-ish1> [<tree-ish2> [<tree-ish3>]]) DESCRIPTION @@ -63,6 +63,15 @@ OPTIONS * when both sides adds a path identically. The resolution is to add that path. +--prefix=<prefix>/:: + Keep the current index contents, and read the contents + of named tree-ish under directory at `<prefix>`. The + original index file cannot have anything at the path + `<prefix>` itself, and have nothing in `<prefix>/` + directory. Note that the `<prefix>/` value must end + with a slash. + + <tree-ish#>:: The id of the tree object(s) to be read/merged. diff --git a/Documentation/git-write-tree.txt b/Documentation/git-write-tree.txt index 77e12cb949..c85fa89c30 100644 --- a/Documentation/git-write-tree.txt +++ b/Documentation/git-write-tree.txt @@ -8,7 +8,7 @@ git-write-tree - Creates a tree object from the current index SYNOPSIS -------- -'git-write-tree' [--missing-ok] +'git-write-tree' [--missing-ok] [--prefix=<prefix>/] DESCRIPTION ----------- @@ -30,6 +30,12 @@ OPTIONS directory exist in the object database. This option disables this check. +--prefix=<prefix>/:: + Writes a tree object that represents a subdirectory + `<prefix>`. This can be used to write the tree object + for a subproject that is in the named subdirectory. + + Author ------ Written by Linus Torvalds <torvalds@osdl.org> diff --git a/Documentation/technical/pack-format.txt b/Documentation/technical/pack-format.txt index ed2decc107..0e1ffb2427 100644 --- a/Documentation/technical/pack-format.txt +++ b/Documentation/technical/pack-format.txt @@ -5,8 +5,13 @@ GIT pack format - The header appears at the beginning and consists of the following: - 4-byte signature - 4-byte version number (network byte order) + 4-byte signature: + The signature is: {'P', 'A', 'C', 'K'} + + 4-byte version number (network byte order): + GIT currently accepts version number 2 or 3 but + generates version 2 only. + 4-byte number of objects contained in the pack (network byte order) Observation: we cannot have more than 4G versions ;-) and @@ -41,7 +46,7 @@ GIT pack format 8-byte integers to go beyond 4G objects per pack, but it is not strictly necessary. - - The header is followed by sorted 28-byte entries, one entry + - The header is followed by sorted 24-byte entries, one entry per object in the pack. Each entry is: 4-byte network byte order integer, recording where the diff --git a/Documentation/tutorial-2.txt b/Documentation/tutorial-2.txt index 08d3453e5c..9c9500c1f1 100644 --- a/Documentation/tutorial-2.txt +++ b/Documentation/tutorial-2.txt @@ -377,7 +377,7 @@ At this point you should know everything necessary to read the man pages for any of the git commands; one good place to start would be with the commands mentioned in link:everyday.html[Everyday git]. You should be able to find any unknown jargon in the -link:glossary.html[Glosssay]. +link:glossary.html[Glossary]. The link:cvs-migration.html[CVS migration] document explains how to import a CVS repository into git, and shows how to use git in a diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt index 79781adf4f..039a8598e3 100644 --- a/Documentation/tutorial.txt +++ b/Documentation/tutorial.txt @@ -429,16 +429,24 @@ $ gitk --since="2 weeks ago" drivers/ ------------------------------------- allows you to browse any commits from the last 2 weeks of commits -that modified files under the "drivers" directory. +that modified files under the "drivers" directory. (Note: you can +adjust gitk's fonts by holding down the control key while pressing +"-" or "+".) Finally, most commands that take filenames will optionally allow you to precede any filename by a commit, to specify a particular version -fo the file: +of the file: ------------------------------------- $ git diff v2.5:Makefile HEAD:Makefile.in ------------------------------------- +You can also use "git cat-file -p" to see any such file: + +------------------------------------- +$ git cat-file -p v2.5:Makefile +------------------------------------- + Next Steps ---------- |