Commit Graph

335 Commits

Author SHA1 Message Date
Junio C Hamano
4607166d07 Documentation: pull/clone ref mapping clarification.
Josef Weidendorfer points out that git-clone documentation does not
mention the initial copying of remote branch heads into corresponding
local branches.  Also clarify the purpose of the ref mappings description
in the "remotes" file and recommended workflow.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-06 00:26:21 -08:00
Junio C Hamano
28ffb8987a Documentation: format-patch
Add examples section and talk about using this to cherry-pick
commits.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-05 02:55:18 -08:00
Junio C Hamano
fdd089793c Documentation: git-fetch/pull updates.
We do not accept multiple <refspecs> on one Pull:/Push: line
right now (we could lift this tentative workaround for the
broken refnames), but we have always accepted multiple such
lines, so use that form in the examples and discussion.

Also explicitly mention that Octopus is made only with an
explicit command line request and never from Pull: lines.

Add a couple of cross references.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-05 01:39:18 -08:00
Jon Loeliger
bccf5956c3 Added a few examples to git-pull man page.
Clarified and added notes for pull/push refspecs.
Converted to back-ticks for literal text examples.

[jc: Also fixed git-pull description that still talked about its
calling git-resolve or git-octopus (we do not anymore; instead
we just call git-merge).  BTW, I am reasonably impressed by how
well "git-am -3" applied this patch, which had some conflicts
because I've updated the documentation somewhat.]

Signed-off-by: Jon Loeliger <jdl@freescale.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-04 19:28:39 -08:00
Junio C Hamano
d8ae1d10cd Document the --no-commit flag better
Pasky and I did overlapping documentation independently; this is to
pick up better wordings from what he sent me.

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-04 18:17:16 -08:00
Junio C Hamano
3746501664 Documentation: -merge and -pull: describe merge strategies.
... and give a couple of examples of running 'git pull' against
local repository.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-04 00:18:29 -08:00
Junio C Hamano
810bf1f944 Documentation: git-add -- do not say "cache", add examples.
Its use of git-ls-files --others is very nice, but sometimes gives
surprising results, so we'd better talk about it.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-04 00:04:17 -08:00
Junio C Hamano
2be8fd085e Illustration: "Commit DAG Revision Naming"
Jon Loeliger's ASCII art in the git-rev-parse(1) manual.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-03 14:55:49 -08:00
Junio C Hamano
36f05ef485 Illustration: "Git Diff Types"
Jon Loeliger's ASCII art in the Tutorial.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-03 14:55:48 -08:00
Junio C Hamano
a3114b3428 Document --since and --until options to rev-parse.
The usability magic were hidden in the source code without being
documented, and even the maintainer did not know about them ;-).

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-02 23:41:25 -08:00
Junio C Hamano
8e6ae4ad5f Add -P to the documentation head.
This is a companion patch for 211dcac643
commit, to add the newly introduced -P option to the list of options.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-01 17:07:21 -08:00
Martin Langhoff
211dcac643 cvsimport: introduce -P <cvsps-output-file> option
-P:: <cvsps-output-file>
       Instead of calling cvsps, read the provided cvsps output file. Useful
       for debugging or when cvsps is being handled outside cvsimport.

Signed-off-by: Martin Langhoff <martin@catalyst.net.nz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-01 16:57:38 -08:00
Petr Baudis
085c1e2212 git-am.txt is no stub anymore
That notice was added by me for the emergency documentation, but Junio
already expanded it to a full-fledged manual page. This patch removes
the notice.

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-01 14:45:49 -08:00
Petr Baudis
3c64314c4b Documentation for git-fmt-merge-msg
Simple description. It appears to be mostly internal command, but hey, it
is (it seems) the only undocumented one, so let's fix it up...

Also add a note about it to git-merge documentation.

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-01 14:45:49 -08:00
Jon Loeliger
4f9dcf7e5c Remove 'Previously this command was known as ...' messages.
For a 1.0 release, there is no need to maintain the
historical "Previously this command was known as..."
information on the doc splash page.  It is noise;
command names should stand on their own now.

Signed-off-by: Jon Loeliger <jdl@freescale.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-01 14:45:48 -08:00
Junio C Hamano
710c97dbb1 Document the use of "current directory" as pull source.
The repository to pull from can be a local repository, and as a
special case the current directory can be specified to perform
merges across local branches.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-01 14:03:13 -08:00
Linus Torvalds
bd66361195 Add examples for git-log documentation and others.
I don't think people really follow the links or think very abstractly at
all in the first place.

So I was thinking more of some explicit examples. I actually think every
command should have an example in the man-page, and hey, here's a patch to
start things off.

Of course, I'm not exactly "Mr Documentation", and I don't know that this
is the prettiest way to do this, but I checked that the resulting html and
man-page seems at least reasonable.

And hey, if the examples look like each other, that's just because I'm
also not "Mr Imagination".

Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-30 22:54:39 -08:00
Junio C Hamano
64b1f6e676 Fix rev-list documentation again (--sparse and pathspec)
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-30 17:28:03 -08:00
Junio C Hamano
12ea5bea58 Update git-pack-objects documentation.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-30 17:28:03 -08:00
Junio C Hamano
69e0c25641 Update usage string and documentation for git-rev-list.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-30 17:28:02 -08:00
Chris Shoemaker
918db541e0 Add to usage and docs for git-add.sh
Signed-off-by: Chris Shoemaker <c.shoemaker@cox.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-30 17:28:01 -08:00
Chris Shoemaker
14470c0de3 Add to documentation of git-update-index arguments and usage.
Removed unknown [--version] option.

Signed-off-by: Chris Shoemaker <c.shoemaker@cox.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-30 17:28:01 -08:00
Junio C Hamano
5773c9f2b2 Documentation updates.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-29 14:32:56 -07:00
Junio C Hamano
a67c1d0809 Fix recent documentation format breakage.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-29 00:50:42 -07:00
Junio C Hamano
7d8b7c21c9 git-apply --numstat
The new option, --numstat, shows number of inserted and deleted
lines for each path.  It is similar to --stat output but is
meant to be more machine friendly by giving number of added and
deleted lines and unabbreviated paths.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-28 22:28:57 -07:00
c.shoemaker@cox.net
59df2a11fe Minor clarifications in diffcore documentation
Signed-off-by: Chris Shoemaker <c.shoemaker at cox.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-28 22:21:35 -07:00
c.shoemaker@cox.net
1cb7f22e5c Remove -r from common diff options documentation in one more place
Signed-off-by: Chris Shoemaker <c.shoemaker at cox.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-28 22:21:32 -07:00
Chris Shoemaker
50b8e355b6 Documentation changes to recursive option for git-diff-tree
Update docs and usages regarding '-r' recursive option for git-diff-tree.
Remove '-r' from common diff options, mention it only for git-diff-tree.
Remove one extraneous use of '-r' with git-diff-files in get-merge.sh.
Sync the synopsis and usage string for git-diff-tree.

Signed-off-by: Chris Shoemaker <c.shoemaker at cox.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-28 13:37:38 -07:00
Junio C Hamano
a77a922212 Document git-patch-id a bit better.
Pavel Roskin wondered what the SHA1 output at the beginning of
git-diff-tree was about.  The only consumer of that information
so far is this git-patch-id command, which was inadequately
documented.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-28 02:39:56 -07:00
Johannes Schindelin
a60d2d8f2d Link git-name-rev and git-symbolic-ref from the main git page
According to my checks, these were the only commands not yet linked.

Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-28 02:15:14 -07:00
Johannes Schindelin
bd321bcc51 Add git-name-rev
git-name-rev tries to find nice symbolic names for commits. It does so by
walking the commits from the refs. When the symbolic name is ambiguous, the
following heuristic is applied: Try to avoid too many ~'s, and if two ambiguous
names have the same count of ~'s, take the one whose last number is smaller.

With "--tags", the names are derived only from tags.

With "--stdin", the stdin is parsed, and after every sha1 for which a name
could be found, the name is appended. (Try "git log | git name-rev --stdin".)

Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-26 16:31:58 -07:00
Junio C Hamano
271440e3b6 git-am: make it easier after fixing up an unapplicable patch.
Instead of having the user to edit the mail message, let the hand merge
result stored in .dotest/patch and continue, which is easier to manage.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-25 23:35:37 -07:00
Petr Baudis
8548ea8ded Add some missing commands to the git.txt commands list
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-25 22:51:39 -07:00
Petr Baudis
d43367af55 Documentation for git-shell
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-25 22:51:13 -07:00
Josef Weidendorfer
1114b26e8f Add git-mv
It supersedes git-rename by adding functionality to move multiple
files, directories or symlinks into another directory.  It also
provides according documentation.

The implementation renames multiple files, using the arguments from
the command line to produce an array of sources and destinations.  In
a first pass, all requested renames are checked for errors, and
overwriting of existing files is only allowed with '-f'.  The actual
renaming is done in a second pass.  This ensures that any error
condition is checked before anything is changed.

Signed-off-by: Josef Weidendorfer <Josef.Weidendorfer@gmx.de>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-23 17:25:08 -07:00
Junio C Hamano
05625af32e Fix malformatted git-am documentation.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-21 20:57:34 -07:00
Petr Baudis
2707da9c08 Update git-daemon's documentation wrt. new options
New options --timeout, --init-timeout, --export-all and whitelist support
were added to git-daemon, but noone bothered to also add the proper
documentation. This patch aims to fix that.

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-20 22:32:08 -07:00
Junio C Hamano
baa720f501 Finish git-am documentation.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-20 22:32:07 -07:00
Petr Baudis
42e2cba204 Brief documentation for the mysterious git-am script
The git-am script is nowhere called and nowhere (including itself)
explained, and the name isn't helpful either. For those like me who will
wonder what is it about, add some documentation stub for it to the
documentation.

I probably got something wrong and I don't feel like investigating all the
options - this is just kind of "emergency" docs.

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-20 22:32:07 -07:00
Junio C Hamano
d6a73596e7 git-fetch/push/pull: documentation.
The documentation was lazily sharing the argument description across these
commands.

Lazy may be a way of life, but that does not justify confusing others ;-).

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-19 21:25:39 -07:00
Junio C Hamano
76e712f1b3 git-clone: always keep pack sent from remote (documentation).
This adjusts the documentation.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-19 14:43:43 -07:00
Junio C Hamano
4aaa702794 git-checkout: revert specific paths to either index or a given tree-ish.
When extra paths arguments are given, git-checkout reverts only those
paths to either the version recorded in the index or the version
recorded in the given tree-ish.

This has been on the TODO list for quite a while.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-18 01:29:27 -07:00
Junio C Hamano
58452f9442 git-apply: remove unused --show-files flag.
Linus says he does not use it (and the thinking behind its initial
introduction), and neither Cogito nor StGIT uses it.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-17 17:41:58 -07:00
Junio C Hamano
d88156e943 Update documentation for C-style quoting.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-17 17:41:56 -07:00
Junio C Hamano
2b2dabc29f Merge branch 'fixes' 2005-10-17 17:41:37 -07:00
Junio C Hamano
fd25c82a80 git-checkout-index: documentation updates.
Now the behaviour of '-a' has been straightened out, document it.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-17 17:38:09 -07:00
Junio C Hamano
622ef9df19 ref-format documentation.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-16 22:41:59 -07:00
Junio C Hamano
f865a2ad98 Merge branch 'fixes' 2005-10-16 12:23:59 -07:00
Junio C Hamano
29504118f8 Merge branch 'svn' of http://netz.smurf.noris.de/git/git
[jc: I have my pre-commit hook enabled to catch trailing whitespaces,
 and fixed them up while merging.]

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-16 11:55:35 -07:00
Junio C Hamano
15fad5f4d7 whatchanged: document -m option from git-diff-tree.
The documentation for git-whatchanged is meant to describe only
the most frequently used options from git-diff-tree.  Because "why
doesn't it show merges" was asked more than once, we'd better
describe '-m' option there.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-15 23:49:27 -07:00