summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)Author
2006-01-23New tutorialJ. Bruce Fields
The current Documentation/tutorial.txt concentrates on the lower-level git interfaces. So it's useful to people developing alternative porcelains, to advanced users, etc., but not so much to beginning users. I think it makes sense for the main tutorial to address those beginnning users, so with this patch I'm proposing that we move Documentation/tutorial.txt to Documentation/core-tutorial.txt and replace it by a new tutorial. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-22git-grep: clarification on parameters.Junio C Hamano
We forgot to make sure that there is no more than one pattern parameter. Also when looking for files in a directory called '--others', it passed that path limiter without preceding the end-of-options marker '--' to underlying git-ls-files, which misunderstood it as one of its options instead. $ git grep --others -e Meta/Make Meta $ git grep -o -e Meta/Make Meta $ git grep -o Meta/Make Meta look for a string "Meta/Make" from untracked files in Meta/ directory. $ git grep Meta/Make --others looks for the same string from tracked files in ./--others directory. On the other hand, $ git grep -e Meta/Make --others does not have a freestanding pattern, so everybody is parameter and there is no path specifier. It looks for the string in all the untracked files without any path limiter. [jc: updated with usability enhancements and documentation cleanups from Sean.] Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-22Document git-ls-files --directoryPetr Baudis
Add the appropriate bit of documentation. Signed-off-by: Petr Baudis <pasky@suse.cz> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-22Minor git-reset and git-commit documentation fixesJ. Bruce Fields
Minor copyediting of recent additions to git-commit and git-reset documentation. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-21AsciiDoc fixes for the git-svnimport manpageFlorian Weimer
Change "SVN:: Perl" to "SVN::Perl", wrap a long line, and clean up the description of positional arguments. Signed-off-by: Florian Weimer <fw@deneb.enyo.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-20update using-topic-branchesLuck, Tony
Update documentation to warn users not to create noise in then Linux history by creating pointless "Auto-update from upstream" merge commits. Signed-off-by: Tony Luck <tony.luck@intel.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-16git-push: fix --tags and document it.Junio C Hamano
Previously 'git-push --tags dst', used information from remotes/dst to determine which refs to push; this patch corrects it, and also documents the --tags option. Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-16git-cvsimport: Add -A <author-conv-file> optionAndreas Ericsson
This patch adds the option to specify an author name/email conversion file in the format exon=Andreas Ericsson <ae@op5.se> spawn=Simon Pawn <spawn@frog-pond.org> which will translate the ugly cvs authornames to the more informative git style. The info is saved in $GIT_DIR/cvs-authors, so that subsequent incremental imports will use the same author-info even if no -A option is specified. If an -A option *is* specified, the info in $GIT_DIR/cvs-authors is appended/updated appropriately. Docs updated accordingly. Signed-off-by: Andreas Ericsson <ae@op5.se> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-15Merge branches 'jc/checkout', 'jc/format-patch', 'jc/octopus', 'jc/sb' and ↵Junio C Hamano
'jc/clone'
2006-01-15show-branch: --current includes the current branch.Junio C Hamano
With this, the command includes the current branch to the list of revs to be shown when it is not given on the command line. This is handy to use in the configuration file like this: [showbranch] default = --current default = heads/* ; primary branches, not topics under ; subdirectories Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-15show-branch: make the current branch and merge commits stand out.Junio C Hamano
This changes the character used to mark the commits that is on the branch from '+' to '*' for the current branch, to make it stand out. Also we show '-' for merge commits. When you have a handful branches with relatively long diversion, it is easier to see which one is the current branch this way. Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-15Documentation: show-branch.Junio C Hamano
Describe showbranch.default configuration item and give an example. Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-15clone: --naked option.Junio C Hamano
The new option --naked is to help creating a naked repository for public consumption. $ git clone -l -s --naked \ /pub/scm/.../torvalds/linux-2.6.git subproj-2.6.git is equivalent to this sequence: $ git clone -l -s -n /pub/scm/.../torvalds/linux-2.6.git temp $ mv temp/.git subproj-2.6.git $ rmdir temp Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-14checkout: merge local modifications while switching branches.Junio C Hamano
* Instead of going interactive, introduce a command line switch '-m' to allow merging changes when normal two-way merge by read-tree prevents branch switching. * Leave the unmerged stages intact if automerge fails, but reset index entries of cleanly merged paths to that of the new branch, so that "git diff" (not "git diff HEAD") would show the local modifications. * Swap the order of trees in read-tree three-way merge used in the fallback, so that `git diff` to show the conflicts become more natural. * Describe the new option and give more examples in the documentation. Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-14Merge fixes up to GIT 1.1.2Junio C Hamano
2006-01-14GIT 1.1.2v1.1.2Junio C Hamano
2006-01-13Documentation: git-reset - interrupted workflow.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-13Documentation: git-commit -aJunio C Hamano
A bit more elaboration on what "update all paths" means. Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-13Documentation: clarify fetch parameter descriptions.J. Bruce Fields
Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-11Add --keep option to keep downloaded packs to git-fetch.Tom Prince
Signed-off-by: Tom Prince <tom.prince@ualberta.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-11GIT 1.1.1v1.1.1Junio C Hamano
2006-01-11glossary: explain "master" and "origin"Johannes Schindelin
If you are a long time git user/developer, you forget that to a new git user, these words have not the same meaning as to you. [jc: with updates from J. Bruce Fields.] Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-08git-daemon --base-pathPetr Baudis
Tommi Virtanen expressed a wish on #git to be able to use short and elegant git URLs by making git-daemon 'root' in a given directory. This patch implements this, causing git-daemon to interpret all paths relative to the given base path if any is given. Signed-off-by: Petr Baudis <pasky@suse.cz> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-08git-fetch: auto-following tags.Junio C Hamano
I added things to ls-remote so that Cogito can auto-follow tags easily and correctly a while ago, but git-fetch did not use the facility. Recently added git-describe command relies on repository keeping up-to-date set of tags, which made it much more attractive to automatically follow tags, so we do that as well. Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-06Merge fixes up to GIT 1.0.7Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-06Fix git-symbolic-ref typo in git.txt.Jon Loeliger
Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-06Documentation/git-svnimport: document -T and -t switches correctlyEric Wong
The -T and -t switches are swapped in the documentation and actual code. I've made the documentation match the code. Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-06Wrap synopsis lines and use [verse] to keep formattingJonas Fonseca
In addition, also fixes a few synopses to be more consistent and a gitlink. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-06trivial: clarify, what are the config's user.name and user.email aboutAlex Riesen
Signed-off-by: Alex Riesen <raa.lkml@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-01-06git-init-db(1): Describe --shared and the idempotent nature of init-dbJonas Fonseca
Based on the recent discussion on the mailing list. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-29Documentation: spell.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-28git-describe: documentation.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-24Tutorial: mention shared repository management.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-24Merge fixes up to GIT 1.0.4Junio C Hamano
2005-12-23ls-files --full-name: usage string and documentation.Junio C Hamano
Somehow this option was not mentioned anywhere in the documentation nor the usage string. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-23rev-parse: --show-cdupJunio C Hamano
When --show-prefix is useful, sometimes it is easier to cd up to the toplevel of the tree. This is equivalent to: git rev-parse --show-prefix | sed -e 's|[^/][^/]*|..|g' but we do not have to invoke sed for that. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-23git-clone: Support changing the origin branch with -oJohannes Schindelin
Earlier, git-clone stored upstream's master in the branch named 'origin', possibly overwriting an existing such branch. Now you can change it by calling git-clone with '-o <other_name>'. [jc: added ref format check, subdirectory safety, documentation and usage string.] Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-21A shared repository should be writable by members.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-20diff --abbrev: document --abbrev=<n> form.Junio C Hamano
It was implemented there but was not advertised. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-20diff: --abbrev optionJunio C Hamano
When I show transcripts to explain how something works, I often find myself hand-editing the diff-raw output to shorten various object names in the output. This adds --abbrev option to the diff family, which shortens diff-raw output and diff-tree commit id headers. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-20Remove "octopus".Junio C Hamano
We still advertise "git resolve" as a standalone command, but never "git octopus", so nobody should be using it and it is safe to retire it. The functionality is still available as a strategy backend. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-20Documentation: stdout of update-hook is connected to /dev/nullJunio C Hamano
Mention that update-hook does not emit its stdout to the sender. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-19Documentation/git-archimport: document -o, -a, f, -D optionsEric Wong
Also, ensure usage help switches are in the same order. Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-19howto/using-topic-branches: Recommend public URL git://git.kernel.org/Junio C Hamano
Recommending this means subsystem maintainers do not have to log-in just to resync with upstream. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-18Documentation: typos and small fixes in "everyday".Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-18fetch-pack: -k option to keep downloaded pack.Junio C Hamano
Split out the functions that deal with the socketpair after finishing git protocol handshake to receive the packed data into a separate file, and use it in fetch-pack to keep/explode the received pack data. We earlier had something like that on clone-pack side once, but the list discussion resulted in the decision that it makes sense to always keep the pack for clone-pack, so unpacking option is not enabled on the clone-pack side, but we later still could do so easily if we wanted to with this change. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-17Documentation: HTTP needs update-server-info.Junio C Hamano
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-17Forbid pattern maching characters in refnames.Junio C Hamano
by marking '?', '*', and '[' as bad_ref_char(). Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-17Examples of resetting.Junio C Hamano
Morten Welinder says examples of resetting is really about recovering from botched commit/pulls. I agree that pointers from commands that cause a reset to be needed in the first place would be very helpful. Also reset examples did not mention "pull/merge" cases. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-12-15Documentation: tutorialJunio C Hamano
At the beginning of tutorial, refer the reader to everyday if she has not done so yet. Signed-off-by: Junio C Hamano <junkio@cox.net>