diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/cvs-migration.txt | 2 | ||||
| -rw-r--r-- | Documentation/diffcore.txt | 14 | ||||
| -rw-r--r-- | Documentation/git-archimport.txt | 62 | ||||
| -rw-r--r-- | Documentation/hooks.txt | 4 | ||||
| -rw-r--r-- | Documentation/tutorial.txt | 4 |
5 files changed, 63 insertions, 23 deletions
diff --git a/Documentation/cvs-migration.txt b/Documentation/cvs-migration.txt index 6e48bdef9e..390a72392b 100644 --- a/Documentation/cvs-migration.txt +++ b/Documentation/cvs-migration.txt @@ -186,7 +186,7 @@ you would use git-rev-list and git-diff-tree like this: nitfol(); }' -We have already talked about the "--stdin" form of git-diff-tree +We have already talked about the "\--stdin" form of git-diff-tree command that reads the list of commits and compares each commit with its parents. The git-whatchanged command internally runs the equivalent of the above command, and can be used like this: diff --git a/Documentation/diffcore.txt b/Documentation/diffcore.txt index a0ffe85a25..1908b92f38 100644 --- a/Documentation/diffcore.txt +++ b/Documentation/diffcore.txt @@ -22,8 +22,8 @@ The git-diff-* family works by first comparing two sets of files: - 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 + working directory (when '\--cached' flag is not used) or a + "tree" object and the index file (when '\--cached' flag is used); - git-diff-files compares contents of the index file and the @@ -164,11 +164,11 @@ similarity score different from the default 50% by giving a number after "-M" or "-C" option (e.g. "-M8" to tell it to use 8/10 = 80%). -Note. When the "-C" option is used with --find-copies-harder +Note. When the "-C" option is used with `\--find-copies-harder` option, git-diff-\* commands feed unmodified filepairs to diffcore mechanism as well as modified ones. This lets the copy detector consider unmodified files as copy source candidates at -the expense of making it slower. Without --find-copies-harder, +the expense of making it slower. Without `\--find-copies-harder`, git-diff-\* commands can detect copies only if the file that was copied happened to have been modified in the same changeset. @@ -220,7 +220,7 @@ diffcore-pickaxe This transformation is used to find filepairs that represent changes that touch a specified string, and is controlled by the --S option and the --pickaxe-all option to the git-diff-* +-S option and the `\--pickaxe-all` option to the git-diff-* commands. When diffcore-pickaxe is in use, it checks if there are @@ -229,9 +229,9 @@ whose "result" side does not. Such a filepair represents "the string appeared in this changeset". It also checks for the opposite case that loses the specified string. -When --pickaxe-all is not in effect, diffcore-pickaxe leaves +When `\--pickaxe-all` is not in effect, diffcore-pickaxe leaves only such filepairs that touches the specified string in its -output. When --pickaxe-all is used, diffcore-pickaxe leaves all +output. When `\--pickaxe-all` is used, diffcore-pickaxe leaves all filepairs intact if there is such a filepair, or makes the output empty otherwise. The latter behaviour is designed to make reviewing of the changes in the context of the whole diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt index 8ce5f0a93f..fa0779b39e 100644 --- a/Documentation/git-archimport.txt +++ b/Documentation/git-archimport.txt @@ -3,29 +3,69 @@ git-archimport(1) NAME ---- -git-archimport - Import an arch repository into git +git-archimport - Import an Arch repository into GIT SYNOPSIS -------- -`git-archimport` [--option...] <args> +`git-archimport` [ -h ] [ -v ] [ -T ] [ -t tempdir ] + <archive/branch> [ <archive/branch> ] DESCRIPTION ----------- -The script expects you to provide the key roots where it can start the -import from an 'initial import' or 'tag' type of Arch commit. It will -then follow all the branching and tagging within the provided roots. +Imports a project from one or more Arch repositories. It will follow branches +and repositories within the namespaces defined by the <archive/branch> +parameters suppplied. If it cannot find the remote branch a merge comes from +it will just import it as a regular commit. If it can find it, it will mark it +as a merge whenever possible (see discussion below). -It will die if it sees branches that have different roots. +The script expects you to provide the key roots where it can start the import +from an 'initial import' or 'tag' type of Arch commit. It will follow and import +new branches within the provided roots. +It expects to be dealing with one project only. If it sees +branches that have different roots, it will refuse to run. In that case, edit your +<archive/branch> parameters to define clearly the scope of the import. + +`git-archimport` uses `tla` extensively in the background to access the Arch repository. +Make sure you have a recent version of `tla` available in the path. `tla` must +know about the repositories you pass to `git-archimport`. + +For the initial import `git-archimport` expects to find itself in an empty +directory. To follow the development of a project that uses Arch, rerun +`git-archimport` with the same parameters as the initial import to perform incremental imports. + +MERGES +------ +Patch merge data from Arch is used to mark merges in GIT as well. GIT +does not care much about tracking patches, and only considers a merge when a +branch incorporates all the commits since the point they forked. The end result +is that GIT will have a good idea of how far branches have diverged. So the +import process does lose some patch-trading metadata. + +Fortunately, when you try and merge branches imported from Arch, +GIT will find a good merge base, and it has a good chance of identifying +patches that have been traded out-of-sequence between the branches. OPTIONS ------- ---option:: - Some option not yet documented. -<args>...:: - Some argument not yet documented. +-h:: + Display usage. + +-v:: + Verbose output. + +-T:: + Many tags. Will create a tag for every commit, reflecting the commit + name in the Arch repository. + +-t <tmpdir>:: + Override the default tempdir. + + +<archive/branch>:: + Archive/branch identifier in a format that `tla log` understands. Author @@ -34,7 +74,7 @@ Written by Martin Langhoff <martin@catalyst.net.nz>. Documentation -------------- -Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. +Documentation by Junio C Hamano, Martin Langhoff and the git-list <git@vger.kernel.org>. GIT --- diff --git a/Documentation/hooks.txt b/Documentation/hooks.txt index ca0efeeccf..57f4720871 100644 --- a/Documentation/hooks.txt +++ b/Documentation/hooks.txt @@ -57,7 +57,7 @@ pre-commit ---------- This hook is invoked by `git-commit`, and can be bypassed -with `--no-verify` option. It takes no parameter, and is +with `\--no-verify` option. It takes no parameter, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with non-zero status from this script causes the `git-commit` to abort. @@ -70,7 +70,7 @@ commit-msg ---------- This hook is invoked by `git-commit`, and can be bypassed -with `--no-verify` option. It takes a single parameter, the +with `\--no-verify` option. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with non-zero status causes the `git-commit` to abort. diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt index 6e100dbb60..928a22cd78 100644 --- a/Documentation/tutorial.txt +++ b/Documentation/tutorial.txt @@ -828,7 +828,7 @@ which will very loudly warn you that you're now committing a merge (which is correct, so never mind), and you can write a small merge message about your adventures in git-merge-land. -After you're done, start up `gitk --all` to see graphically what the +After you're done, start up `gitk \--all` to see graphically what the history looks like. Notice that `mybranch` still exists, and you can switch to it, and continue to work with it if you want to. The `mybranch` branch will not contain the merge, but next time you merge it @@ -883,7 +883,7 @@ not actually do a merge. Instead, it just updated the top of the tree of your branch to that of the `master` branch. This is often called 'fast forward' merge. -You can run `gitk --all` again to see how the commit ancestry +You can run `gitk \--all` again to see how the commit ancestry looks like, or run `show-branch`, which tells you this. ------------------------------------------------ |