summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)AuthorFilesLines
2007-09-25gitattributes.txt: Remove a duplicated paragraph about 'ident' and 'crlf' ↵Libravatar Johannes Sixt1-11/+0
interaction. The order in which 'ident' and 'crlf' are carried out is documented a few paragraphs later again, after 'filter' was introduced. Signed-off-by: Johannes Sixt <johannes.sixt@telecom.at> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-25user-manual: Explain what submodules are good for.Libravatar Michael Smith1-12/+42
Rework the introduction to the Submodules section to explain why someone would use them, and fix up submodule references from the tree-object and todo sections. Signed-off-by: Michael Smith <msmith@cbnco.com> Acked-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-23Merge branch 'maint' of git://linux-nfs.org/~bfields/git into maintLibravatar Junio C Hamano1-7/+213
* 'maint' of git://linux-nfs.org/~bfields/git: User Manual: add a chapter for submodules user-manual: don't assume refs are stored under .git/refs
2007-09-23User Manual: add a chapter for submodulesLibravatar Miklos Vajna1-0/+202
Signed-off-by: Michael Smith <msmith@cbnco.com> Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-23user-manual: don't assume refs are stored under .git/refsLibravatar J. Bruce Fields1-7/+11
The scripts taken from Tony Luck's howto assume all refs can be found under .git/refs, but this is not necessarily true, especially since git-gc runs git-pack-refs. Also add a note warning of this in the chapter that introduces refs, and fix the same incorrect assumption in one other spot. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-21Conjugate "search" correctly in the git-prune-packed man page.Libravatar Matt Kraai1-1/+1
Signed-off-by: Matt Kraai <kraai@ftbfs.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-21Move the paragraph specifying where the .idx and .pack files should beLibravatar Matt Kraai1-4/+4
Signed-off-by: Matt Kraai <kraai@ftbfs.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-21Documentation/git-lost-found.txt: drop unnecessarily duplicated name.Libravatar Junio C Hamano1-1/+1
I only did this back when I wanted to make sure git-log and gitk work properly with non Occidental characters. There is really no reason to keep it around. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-19GIT 1.5.3.2Libravatar Junio C Hamano1-0/+58
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-18Fixed update-hook example allow-users format.Libravatar Väinö Järvelä1-4/+4
The example provided with the update-hook-example does not work on either bash 2.05b.0(1)-release nor 3.1.17(1)-release. The matcher did not match the lines that it advertised to match, such as: refs/heads/bw/ linus refs/heads/tmp/* * In POSIX 1003.2 regular expressions, the star (*), is not an wildcard meaning "match everything", it matches 0 or more matches of the atom preceding it. So to match "refs/heads/bw/topic-branch", the matcher should be written as "refs/heads/bw/.*" to match "refs/heads/bw/" and everything after it. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-18Documentation/git-svn: updated design philosophy notesLibravatar Eric Wong1-5/+6
This section has not been updated in a while and --branches/--tags/--trunk options are commonly used nowadays. Noticed-by: Lars Hjemli <hjemli@gmail.com> Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-18git-push: documentation and tests for pushing only branchesLibravatar Jeff King2-4/+4
Commit 098e711e caused git-push to match only branches when considering which refs to push. This patch updates the documentation accordingly and adds a test for this behavior. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-17Document ls-files --with-tree=<tree-ish>Libravatar Junio C Hamano1-1/+8
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-15core-tutorial: minor cleanupLibravatar J. Bruce Fields1-22/+10
Revise the introduction for concision, add pointers to the tutorial and user manual as appropriate, delete cvsimport note from the end, as that work's been done elsewhere already. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-15documentation: replace Discussion section by link to user-manual chapterLibravatar J. Bruce Fields3-597/+54
The "Discussion" section has a lot of useful information, but is a little wordy, especially for an already-long man page, and is designed for an audience more of potential git hackers than users, which probably doesn't make as much sense as git matures. Also, I (perhaps foolishly) forked a version in the user manual, which has been significantly rewritten in an attempt to address some of the above problems. So, remove this section and replace it by a (very terse) summary of the original material--my attempt at the World's Shortest Git Overview--and a reference to the appropriate chapter of the user manual. It's unfortunate to remove something that's been in this place for a long time, as some people may still depend on finding it there. But I think we'll want to do this some day anyway. Cc: Andreas Ericsson <ae@op5.se> Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-15user-manual: todo updates and cleanupLibravatar J. Bruce Fields1-13/+16
Format a couple lists. Reminder that we may want to add submodule documentation some day.
2007-09-15user-manual: fix introduction to packfilesLibravatar J. Bruce Fields1-2/+2
Actually I don't think we've previously mentioned .git/objects, so we need a different introduction here. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-15user-manual: move packfile and dangling object discussionLibravatar J. Bruce Fields1-148/+147
The discussions of packfiles and dangling objects both belong in the object database section. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-15user-manual: rewrite object database discussionLibravatar J. Bruce Fields1-139/+196
Rewrite the introduction. Rewrite each section completely to make them work in the new order, to add some examples, and to move plumbing commands (like git-commit-tree) to the following chapter. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-15user-manual: reorder commit, blob, tree discussionLibravatar J. Bruce Fields1-41/+41
The bottom-up blog, tree, commit order makes sense unless you want to give explicit examples--it's easier to discover objects to examine if you go in the other order...., Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-15user-manual: rewrite index discussionLibravatar J. Bruce Fields1-49/+55
Add an example using git-ls-files, standardize on the new "index" terminology (as opposed to "cache"), attempt to clarify discussion and make it a little shorter, avoid some unnecessary jargon ("write-back cache"). Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-15user-manual: create new "low-level git operations" chapterLibravatar J. Bruce Fields1-9/+24
The low-level index operations aren't as important to regular users as the rest of this "git concepts" chapter; so move it into a separate chapter, and do some minor cleanup. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-15user-manual: rename "git internals" to "git concepts"Libravatar J. Bruce Fields1-6/+10
"git internals" sounds like something only git developers must know about, but this stuff should be of wider interest. Rename the chapter and give it a slightly friendlier introduction. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-15user-manual: move object format details to hacking-git chapterLibravatar J. Bruce Fields1-23/+32
Most of this is probably only of interest to git developers. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-15user-manual: adjust section levels in "git internals"Libravatar J. Bruce Fields1-5/+12
The descriptions of the various object types should all be a subsection of the "Object Database" section. I cribbed most of this chapter from the README (now core-intro.txt and git(7)), because there's stuff in there people need to know and I was too lazy to rewrite it. The audience isn't quite right, though--the chapter is a mixture of user- and developer- level documentation that isn't as appropriate now as it was originally. So, reserve this chapter for stuff users need to know, and move the source code introduction into a new "git hacking" chapter where we'll also move any hacker-only technical details. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-14Documentation/git-config.txt: AsciiDoc tweak to avoid leading dotLibravatar Junio C Hamano1-1/+1
Bram Schoenmakers noticed that git-config document was formatted incorrectly. Depending on the version of AsciiDoc and docbook toolchain, it is sometimes taken as a numbered example by AsciiDoc, some other times passed intact to roff format to confuse "man". Since we refer to the repository metadata directory as $GIT_DIR elsewhere, work it around by using that symbolic name. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-14Documentation/git-archive.txt: a couple of clarifications.Libravatar Jari Aalto1-2/+3
The description of the option gave impression that there were several formats available by using three dots. There are no other formats than tar and gzip currently supported. Clarify that the archive goes to the standard output. Signed-off-by: Jari Aalto <jari.aalto@cante.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-13Remove duplicate note about removing commits with git-filter-branchLibravatar Ulrik Sverdrup1-5/+0
A duplicate of an already existing section in the documentation of git-filter-branch was added in commit f95eef15f2f8a336b9a42749f5458c841a5a5d63. This patch removes that redundant section. Signed-off-by: Ulrik Sverdrup <ulrik.sverdrup@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-09fix doc for --compression argument to pack-objectsLibravatar Nicolas Pitre1-6/+2
Remove obsolete details (core.legacyheaders is always true now). Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-07Documentation / grammer nitLibravatar Mike Ralphson1-1/+1
If we're counting, a smaller number is 'fewer' not 'less' Signed-off-by: Mike Ralphson <mike@abacus.co.uk> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-05Include a git-push example for creating a remote branchLibravatar Shawn O. Pearce1-0/+6
Many users get confused when `git push origin master:foo` works when foo already exists on the remote repository but are confused when foo doesn't exist as a branch and this form does not create the branch foo. This new example highlights the trick of including refs/heads/ in front of the desired branch name to create a branch. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-03GIT 1.5.3.1: obsolete git-p4 in RPM spec file.Libravatar Junio C Hamano2-1/+14
HPA noticed that yum does not like the newer git RPM set; it turns out that we do not ship git-p4 anymore but existing installations do not realize the package is gone if we do not tell anything about it. David Kastrup suggests using Obsoletes in the spec file of the new RPM to replace the old package, so here is a try. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-02Typofix: 1.5.3 release notesLibravatar Junio C Hamano1-1/+1
2007-09-02GIT 1.5.3Libravatar Junio C Hamano1-7/+21
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-01Merge branch 'jp/send-email-cc'Libravatar Junio C Hamano1-0/+9
* jp/send-email-cc: git-send-email --cc-cmd
2007-09-01Mention -m as an abbreviation for --mergeLibravatar Robin Rosenberg1-2/+2
Signed-off-by: Robin Rosenberg <robin.rosenberg@dewire.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-01Update my contact address as the maintainer.Libravatar Junio C Hamano2-2/+3
2007-09-01Documentation: minor AsciiDoc mark-up fixes.Libravatar Junio C Hamano2-14/+14
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-01URL: allow port specification in ssh:// URLsLibravatar Luben Tuikov1-1/+3
Allow port specification in ssh:// URLs in the usual notation: ssh://[user@]host.domain[:<port>]/<path> This allows git to be used over ssh-tunneling networks. Signed-off-by: Luben Tuikov <ltuikov@yahoo.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-31git-diff: resurrect the traditional empty "diff --git" behaviourLibravatar Junio C Hamano1-0/+10
The warning message to suggest "Consider running git-status" from "git-diff" that we experimented with during the 1.5.3 cycle turns out to be a bad idea. It robbed cache-dirty information from people who valued it, while still asking users to run "update-index --refresh". It was hoped that the new behaviour would at least have some educational value, but not showing the cache-dirty paths like before meant that the user would not even know easily which paths were cache-dirty, and it made the need to refresh the index look like even more unnecessary chore. This commit reinstates the traditional behaviour, but with a twist. By default, the empty "diff --git" output is totally squelched out from "git diff" output. At the end of the command, it automatically runs "update-index --refresh" as needed, without even bothering the user. In other words, people who do not care about the cache-dirtyness do not even have to see the warning. The traditional behaviour to see the stat-dirty output and to bypassing the overhead of content comparison can be specified by setting the configuration variable diff.autorefreshindex to false. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-31filter-branch: introduce convenience function "skip_commit"Libravatar Johannes Schindelin1-7/+27
With this function, a commit filter can leave out unwanted commits (such as temporary commits). It does _not_ undo the changeset corresponding to that commit, but it _skips_ the revision. IOW no tree object is changed by this. If you like to commit early and often, but want to filter out all intermediate commits, marked by "@@@" in the commit message, you can now do this with git filter-branch --commit-filter ' if git cat-file commit $GIT_COMMIT | grep '@@@' > /dev/null; then skip_commit "$@"; else git commit-tree "$@"; fi' newbranch Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-31filter-branch: provide the convenience functions also for commit filtersLibravatar Johannes Schindelin1-3/+0
Move the convenience functions to the top of git-filter-branch.sh, and return from the script when the environment variable SOURCE_FUNCTIONS is set. By sourcing git-filter-branch with that variable set automatically, all commit filters may access the convenience functions like "map". Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-31rebase -i: mention the option to split commits in the man pageLibravatar Johannes Schindelin1-1/+38
The interactive mode of rebase can be used to split commits. Tell the interested parties about it, with a dedicated section in the man page. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-31filter-branch: fix remnants of old syntax in documentationLibravatar Johannes Schindelin1-14/+18
Some time ago, filter-branch's syntax changed so that more than one ref can be rewritten at the same time. This involved the removal of the ref name for the result; instead, the refs are rewritten in-place. This updates the last leftovers in the documentation to reflect the new behavior. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-31Hopefully the final update to draft release notes for 1.5.3.Libravatar Junio C Hamano1-1/+13
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-30git-filter-branch: document --original optionLibravatar Giuseppe Bilotta1-1/+6
Signed-off-by: Giuseppe Bilotta <giuseppe.bilotta@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-29git-daemon(1): assorted improvements.Libravatar Junio C Hamano1-2/+34
Jari Aalto noticed a handful places in git-daemon documentation that need to be improved. * --inetd makes --pid-file to be ignored, in addition to --user and --group * receive-pack service was not described at all. We should, if only to warn about the security implications of it. * There was no example of per repository configuration. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-29GIT 1.5.3-rc7Libravatar Junio C Hamano1-3/+15
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-29git-svn.txt: fix an obvious misspelling.Libravatar David Kastrup1-1/+1
Signed-off-by: David Kastrup <dak@gnu.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-28format-patch documentation: reword to hint "--root <one-commit>" more clearlyLibravatar Junio C Hamano1-7/+10
Signed-off-by: Junio C Hamano <gitster@pobox.com>