X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fuser-manual.txt;h=01c1af6b6a69253dd2460962fdfccb2d3bc50237;hb=2fd02c92dbb6e575b7e62ea9dfa85ef45ebe58b6;hp=86b91a53e5c822782ed7682c83d435180d7b682f;hpb=008442f5e798e511cc0cd5d9443552b0d107d558;p=git.git diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 86b91a53e..01c1af6b6 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -18,7 +18,7 @@ People needing to do actual development will also want to read Further chapters cover more specialized topics. Comprehensive reference documentation is available through the man -pages. For a command such as "git clone", just use +pages. For a command such as "git clone ", just use ------------------------------------------------ $ man git-clone @@ -178,7 +178,7 @@ As you can see, a commit shows who made the latest change, what they did, and why. Every commit has a 40-hexdigit id, sometimes called the "object name" or the -"SHA1 id", shown on the first line of the "git show" output. You can usually +"SHA1 id", shown on the first line of the "git-show" output. You can usually refer to a commit by a shorter name, such as a tag or a branch name, but this longer name can also be useful. Most importantly, it is a globally unique name for this commit: so if you tell somebody else the object name (for @@ -390,7 +390,7 @@ references with the same shorthand name, see the "SPECIFYING REVISIONS" section of linkgit:git-rev-parse[1]. [[Updating-a-repository-with-git-fetch]] -Updating a repository with git fetch +Updating a repository with git-fetch ------------------------------------ Eventually the developer cloned from will do additional work in her @@ -417,7 +417,7 @@ $ git fetch linux-nfs ------------------------------------------------- New remote-tracking branches will be stored under the shorthand name -that you gave "git remote add", in this case linux-nfs: +that you gave "git-remote add", in this case linux-nfs: ------------------------------------------------- $ git branch -r @@ -1048,7 +1048,7 @@ $ git diff shows the difference between the working tree and the index file. -Note that "git add" always adds just the current contents of a file +Note that "git-add" always adds just the current contents of a file to the index; further changes to the same file will be ignored unless you run git-add on the file again. @@ -1111,7 +1111,7 @@ Ignoring files A project will often generate files that you do 'not' want to track with git. This typically includes files generated by a build process or temporary backup files made by your editor. Of course, 'not' tracking files with git -is just a matter of 'not' calling "`git add`" on them. But it quickly becomes +is just a matter of 'not' calling "`git-add`" on them. But it quickly becomes annoying to have these untracked files lying around; e.g. they make "`git add .`" and "`git commit -a`" practically useless, and they keep showing up in the output of "`git status`". @@ -1254,16 +1254,15 @@ these three "file stages" represents a different version of the file: ------------------------------------------------- $ git show :1:file.txt # the file in a common ancestor of both branches -$ git show :2:file.txt # the version from HEAD, but including any - # nonconflicting changes from MERGE_HEAD -$ git show :3:file.txt # the version from MERGE_HEAD, but including any - # nonconflicting changes from HEAD. +$ git show :2:file.txt # the version from HEAD. +$ git show :3:file.txt # the version from MERGE_HEAD. ------------------------------------------------- -Since the stage 2 and stage 3 versions have already been updated with -nonconflicting changes, the only remaining differences between them are -the important ones; thus linkgit:git-diff[1] can use the information in -the index to show only those conflicts. +When you ask linkgit:git-diff[1] to show the conflicts, it runs a +three-way diff between the conflicted merge results in the work tree with +stages 2 and 3 to show only hunks whose contents come from both sides, +mixed (in other words, when a hunk's merge results come only from stage 2, +that part is not conflicting and is not shown. Same for stage 3). The diff above shows the differences between the working-tree version of file.txt and the stage 2 and stage 3 versions. So instead of preceding @@ -1304,7 +1303,7 @@ $ git diff -3 file.txt # diff against stage 3 $ git diff --theirs file.txt # same as the above. ------------------------------------------------- -The linkgit:git-log[1] and gitk[1] commands also provide special help +The linkgit:git-log[1] and linkgit:gitk[1] commands also provide special help for merges: ------------------------------------------------- @@ -1450,7 +1449,7 @@ Checking out an old version of a file In the process of undoing a previous bad change, you may find it useful to check out an older version of a particular file using -linkgit:git-checkout[1]. We've used git checkout before to switch +linkgit:git-checkout[1]. We've used git-checkout before to switch branches, but it has quite different behavior if it is given a path name: the command @@ -1652,7 +1651,7 @@ Sharing development with others =============================== [[getting-updates-with-git-pull]] -Getting updates with git pull +Getting updates with git-pull ----------------------------- After you clone a repository and make a few changes of your own, you @@ -1771,7 +1770,7 @@ Public git repositories Another way to submit changes to a project is to tell the maintainer of that project to pull the changes from your repository using linkgit:git-pull[1]. In the section "<>" we described this as a way to get +Getting updates with git-pull>>" we described this as a way to get updates from the "main" repository, but it works just as well in the other direction. @@ -1880,8 +1879,7 @@ $ chmod a+x hooks/post-update ------------------------------------------------- (For an explanation of the last two lines, see -linkgit:git-update-server-info[1], and the documentation -link:hooks.html[Hooks used by git].) +linkgit:git-update-server-info[1] and linkgit:githooks[5].) Advertise the URL of proj.git. Anybody else should then be able to clone or pull from that URL, for example with a command line like: @@ -1965,10 +1963,10 @@ error: failed to push to 'ssh://yourserver.com/~you/proj.git' This can happen, for example, if you: - - use `git reset --hard` to remove already-published commits, or - - use `git commit --amend` to replace already-published commits + - use `git-reset --hard` to remove already-published commits, or + - use `git-commit --amend` to replace already-published commits (as in <>), or - - use `git rebase` to rebase any already-published commits (as + - use `git-rebase` to rebase any already-published commits (as in <>). You may force git-push to perform the update anyway by preceding the @@ -1993,7 +1991,7 @@ the right to push to the same repository. In that case, the correct solution is to retry the push after first updating your work by either a pull or a fetch followed by a rebase; see the <> and -link:cvs-migration.html[git for CVS users] for more. +linkgit:gitcvs-migration[7] for more. [[setting-up-a-shared-repository]] Setting up a shared repository @@ -2002,7 +2000,7 @@ Setting up a shared repository Another way to collaborate is by using a model similar to that commonly used in CVS, where several developers with special rights all push to and pull from a single shared repository. See -link:cvs-migration.html[git for CVS users] for instructions on how to +linkgit:gitcvs-migration[7] for instructions on how to set this up. However, while there is nothing wrong with git's support for shared @@ -2172,7 +2170,7 @@ they are for, or what status they are in. To get a reminder of what changes are in a specific branch, use: ------------------------------------------------- -$ git log linux..branchname | git-shortlog +$ git log linux..branchname | git shortlog ------------------------------------------------- To see whether it has already been merged into the test or release branches, @@ -2445,8 +2443,8 @@ patches to the new mywork. The result will look like: ................................................ In the process, it may discover conflicts. In that case it will stop -and allow you to fix the conflicts; after fixing conflicts, use "git -add" to update the index with those contents, and then, instead of +and allow you to fix the conflicts; after fixing conflicts, use "git-add" +to update the index with those contents, and then, instead of running git-commit, just run ------------------------------------------------- @@ -2702,8 +2700,8 @@ master branch. In more detail: git fetch and fast-forwards --------------------------- -In the previous example, when updating an existing branch, "git -fetch" checks to make sure that the most recent commit on the remote +In the previous example, when updating an existing branch, "git-fetch" +checks to make sure that the most recent commit on the remote branch is a descendant of the most recent commit on your copy of the branch before updating your copy of the branch to point at the new commit. Git calls this process a <>. @@ -2728,7 +2726,7 @@ resulting in a situation like: o--o--o <-- new head of the branch ................................................ -In this case, "git fetch" will fail, and print out a warning. +In this case, "git-fetch" will fail, and print out a warning. In that case, you can still force git to update to the new head, as described in the following section. However, note that in the @@ -2737,7 +2735,7 @@ unless you've already created a reference of your own pointing to them. [[forcing-fetch]] -Forcing git fetch to do non-fast-forward updates +Forcing git-fetch to do non-fast-forward updates ------------------------------------------------ If git fetch fails because the new head of a branch is not a @@ -2812,7 +2810,7 @@ You can also add a "+" to force the update each time: $ git config remote.example.fetch +master:ref/remotes/example/master ------------------------------------------------- -Don't do this unless you're sure you won't mind "git fetch" possibly +Don't do this unless you're sure you won't mind "git-fetch" possibly throwing away commits on mybranch. Also note that all of the above configuration can be performed by @@ -3108,7 +3106,7 @@ $ git prune to remove any of the "loose" objects that are now contained in the pack. This will also remove any unreferenced objects (which may be -created when, for example, you use "git reset" to remove a commit). +created when, for example, you use "git-reset" to remove a commit). You can verify that the loose objects are gone by looking at the .git/objects directory or by running @@ -3137,7 +3135,7 @@ branch still exists, as does everything it pointed to. The branch pointer itself just doesn't, since you replaced it with another one. There are also other situations that cause dangling objects. For -example, a "dangling blob" may arise because you did a "git add" of a +example, a "dangling blob" may arise because you did a "git-add" of a file, but then, before you actually committed it and made it part of the bigger picture, you changed something else in that file and committed that *updated* thing--the old state that you added originally ends up @@ -3187,7 +3185,7 @@ Usually, dangling blobs and trees aren't very interesting. They're almost always the result of either being a half-way mergebase (the blob will often even have the conflict markers from a merge in it, if you have had conflicting merges that you fixed up by hand), or simply -because you interrupted a "git fetch" with ^C or something like that, +because you interrupted a "git-fetch" with ^C or something like that, leaving _some_ of the new objects in the object database, but just dangling and useless. @@ -3236,7 +3234,7 @@ it is with linkgit:git-fsck[1]; this may be time-consuming. Assume the output looks like this: ------------------------------------------------ -$ git-fsck --full +$ git fsck --full broken link from tree 2d9263c6d23595e7cb2a21e5ebbb53655278dff8 to blob 4b9458b3786228369c63936db65827de3cc06200 missing blob 4b9458b3786228369c63936db65827de3cc06200 @@ -3466,14 +3464,14 @@ done NOTE: Do not use local URLs here if you plan to publish your superproject! -See what files `git submodule` created: +See what files `git-submodule` created: ------------------------------------------------- $ ls -a . .. .git .gitmodules a b c d ------------------------------------------------- -The `git submodule add` command does a couple of things: +The `git-submodule add` command does a couple of things: - It clones the submodule under the current directory and by default checks out the master branch. @@ -3519,7 +3517,7 @@ init` to add the submodule repository URLs to `.git/config`: $ git submodule init ------------------------------------------------- -Now use `git submodule update` to clone the repositories and check out the +Now use `git-submodule update` to clone the repositories and check out the commits specified in the superproject: ------------------------------------------------- @@ -3529,8 +3527,8 @@ $ ls -a . .. .git a.txt ------------------------------------------------- -One major difference between `git submodule update` and `git submodule add` is -that `git submodule update` checks out a specific commit, rather than the tip +One major difference between `git-submodule update` and `git-submodule add` is +that `git-submodule update` checks out a specific commit, rather than the tip of a branch. It's like checking out a tag: the head is detached, so you're not working on a branch. @@ -3696,7 +3694,7 @@ removed. The only thing `--remove` means is that update-index will be considering a removed file to be a valid thing, and if the file really does not exist any more, it will update the index accordingly. -As a special case, you can also do `git-update-index --refresh`, which +As a special case, you can also do `git update-index --refresh`, which will refresh the "stat" information of each index to match the current stat information. It will 'not' update the object status itself, and it will only update the fields that are used to quickly test whether @@ -3731,7 +3729,7 @@ unsaved state that you might want to restore later!) your current index. Normal operation is just ------------------------------------------------- -$ git-read-tree +$ git read-tree ------------------------------------------------- and your index file will now be equivalent to the tree that you saved @@ -3754,7 +3752,7 @@ index file with read-tree, and then you need to check out the result with ------------------------------------------------- -$ git-checkout-index filename +$ git checkout-index filename ------------------------------------------------- or, if you want to check out all of the index, use `-a`. @@ -3772,7 +3770,7 @@ from one representation to the other: Tying it all together ~~~~~~~~~~~~~~~~~~~~~ -To commit a tree you have instantiated with "git-write-tree", you'd +To commit a tree you have instantiated with "git write-tree", you'd create a "commit" object that refers to that tree and the history behind it--most notably the "parent" commits that preceded it in history. @@ -3791,7 +3789,7 @@ You create a commit object by giving it the tree that describes the state at the time of the commit, and a list of parents: ------------------------------------------------- -$ git-commit-tree -p [-p ..] +$ git commit-tree -p [-p ..] ------------------------------------------------- and then giving the reason for the commit on stdin (either through @@ -3854,14 +3852,14 @@ linkgit:git-cat-file[1] to examine details about the object: ------------------------------------------------- -$ git-cat-file -t +$ git cat-file -t ------------------------------------------------- shows the type of the object, and once you have the type (which is usually implicit in where you find the object), you can use ------------------------------------------------- -$ git-cat-file blob|tree|commit|tag +$ git cat-file blob|tree|commit|tag ------------------------------------------------- to show its contents. NOTE! Trees have binary content, and as a result @@ -3875,7 +3873,7 @@ follow the convention of having the top commit name in `.git/HEAD`, you can do ------------------------------------------------- -$ git-cat-file commit HEAD +$ git cat-file commit HEAD ------------------------------------------------- to see what the top commit was. @@ -3899,7 +3897,7 @@ To get the "base" for the merge, you first look up the common parent of two commits with ------------------------------------------------- -$ git-merge-base +$ git merge-base ------------------------------------------------- which will return you the commit they are both based on. You should @@ -3907,7 +3905,7 @@ now look up the "tree" objects of those commits, which you can easily do with (for example) ------------------------------------------------- -$ git-cat-file commit | head -1 +$ git cat-file commit | head -1 ------------------------------------------------- since the tree object information is always the first line in a commit @@ -3924,12 +3922,12 @@ you have in your current index anyway). To do the merge, do ------------------------------------------------- -$ git-read-tree -m -u +$ git read-tree -m -u ------------------------------------------------- which will do all trivial merge operations for you directly in the index file, and you can just write the result out with -`git-write-tree`. +`git write-tree`. [[merging-multiple-trees-2]] @@ -3943,18 +3941,18 @@ entries" in it. Such an index tree can 'NOT' be written out to a tree object, and you will have to resolve any such merge clashes using other tools before you can write out the result. -You can examine such index state with `git-ls-files --unmerged` +You can examine such index state with `git ls-files --unmerged` command. An example: ------------------------------------------------ -$ git-read-tree -m $orig HEAD $target -$ git-ls-files --unmerged +$ git read-tree -m $orig HEAD $target +$ git ls-files --unmerged 100644 263414f423d0e4d70dae8fe53fa34614ff3e2860 1 hello.c 100644 06fa6a24256dc7e560efa5687fa84b51f0263c3a 2 hello.c 100644 cc44c73eb783565da5831b4d820c962954019b69 3 hello.c ------------------------------------------------ -Each line of the `git-ls-files --unmerged` output begins with +Each line of the `git ls-files --unmerged` output begins with the blob mode bits, blob SHA1, 'stage number', and the filename. The 'stage number' is git's way to say which tree it came from: stage 1 corresponds to `$orig` tree, stage 2 `HEAD` @@ -3972,9 +3970,9 @@ program, e.g. `diff3`, `merge`, or git's own merge-file, on the blob objects from these three stages yourself, like this: ------------------------------------------------ -$ git-cat-file blob 263414f... >hello.c~1 -$ git-cat-file blob 06fa6a2... >hello.c~2 -$ git-cat-file blob cc44c73... >hello.c~3 +$ git cat-file blob 263414f... >hello.c~1 +$ git cat-file blob 06fa6a2... >hello.c~2 +$ git cat-file blob cc44c73... >hello.c~3 $ git merge-file hello.c~2 hello.c~1 hello.c~3 ------------------------------------------------ @@ -3985,7 +3983,7 @@ merge result for this file is by: ------------------------------------------------- $ mv -f hello.c~2 hello.c -$ git-update-index hello.c +$ git update-index hello.c ------------------------------------------------- When a path is in unmerged state, running `git-update-index` for @@ -3998,10 +3996,10 @@ for this. There is `git-merge-index` program that extracts the stages to temporary files and calls a "merge" script on it: ------------------------------------------------- -$ git-merge-index git-merge-one-file hello.c +$ git merge-index git-merge-one-file hello.c ------------------------------------------------- -and that is what higher level `git merge -s resolve` is implemented with. +and that is what higher level `git-merge -s resolve` is implemented with. [[hacking-git]] Hacking git @@ -4097,7 +4095,7 @@ functions like `get_sha1_basic()` or the likes. This is just to get you into the groove for the most libified part of Git: the revision walker. -Basically, the initial version of `git log` was a shell script: +Basically, the initial version of `git-log` was a shell script: ---------------------------------------------------------------- $ git-rev-list --pretty $(git-rev-parse --default HEAD "$@") | \ @@ -4129,10 +4127,10 @@ commits one by one with the function `get_revision()`. If you are interested in more details of the revision walking process, just have a look at the first implementation of `cmd_log()`; call -`git-show v1.3.0{tilde}155^2{tilde}4` and scroll down to that function (note that you +`git show v1.3.0{tilde}155^2{tilde}4` and scroll down to that function (note that you no longer need to call `setup_pager()` directly). -Nowadays, `git log` is a builtin, which means that it is _contained_ in the +Nowadays, `git-log` is a builtin, which means that it is _contained_ in the command `git`. The source side of a builtin is - a function called `cmd_`, typically defined in `builtin-.c`, @@ -4148,7 +4146,7 @@ since they share quite a bit of code. In that case, the commands which are _not_ named like the `.c` file in which they live have to be listed in `BUILT_INS` in the `Makefile`. -`git log` looks more complicated in C than it does in the original script, +`git-log` looks more complicated in C than it does in the original script, but that allows for a much greater flexibility and performance. Here again it is a good point to take a pause. @@ -4159,9 +4157,9 @@ the organization of Git (after you know the basic concepts). So, think about something which you are interested in, say, "how can I access a blob just knowing the object name of it?". The first step is to find a Git command with which you can do it. In this example, it is either -`git show` or `git cat-file`. +`git-show` or `git-cat-file`. -For the sake of clarity, let's stay with `git cat-file`, because it +For the sake of clarity, let's stay with `git-cat-file`, because it - is plumbing, and @@ -4220,10 +4218,10 @@ To find out how the result can be used, just read on in `cmd_cat_file()`: ----------------------------------- Sometimes, you do not know where to look for a feature. In many such cases, -it helps to search through the output of `git log`, and then `git show` the +it helps to search through the output of `git log`, and then `git-show` the corresponding commit. -Example: If you know that there was some test case for `git bundle`, but +Example: If you know that there was some test case for `git-bundle`, but do not remember where it was (yes, you _could_ `git grep bundle t/`, but that does not illustrate the point!): @@ -4252,7 +4250,10 @@ You see, Git is actually the best tool to find out about the source of Git itself! [[glossary]] -include::glossary.txt[] +GIT Glossary +============ + +include::glossary-content.txt[] [[git-quick-start]] Appendix A: Git Quick Reference