summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)AuthorFilesLines
2007-01-29user-manual: document git-show-branch exampleLibravatar J. Bruce Fields1-2/+28
Document Junio's show-branch trick for finding out which tags are descendents of a given comit. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-29user-manual: minor "TODO" updatesLibravatar J. Bruce Fields1-9/+6
I still really want a section on interoperability with CVS, subversion, etc., but I'm not getting around to it very fast, so just add this to the TODO section for now. And a few other minor todo updates. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-29user-manual: rewrap a few long linesLibravatar J. Bruce Fields1-56/+59
Rewrap some long lines. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-29user-manual: reflogs, other recoveryLibravatar J. Bruce Fields1-15/+78
Add a brief discussion of reflogs. Also recovery of dangling commits seems to fit in here, so move some of the discussion out of Linus's email to here. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-29user-manual: fix a header levelLibravatar J. Bruce Fields1-1/+1
Oops. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-29user-manual: typo fixLibravatar J. Bruce Fields1-1/+1
Oops Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-29user-manual: add references to git-config man pageLibravatar J. Bruce Fields1-3/+7
Direct editing of config files may be more natural for users than using the git-config commandline; but we should still reference the git-config man page when we describe such editing, so people know where to go for details on the config file syntax and meanings of the variables. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-28user-manual: repo-config -> configLibravatar J. Bruce Fields1-9/+9
Looks like we're going to allow git-config as the preferred alias to git-repo-config, so let's document that instead. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-28user-manual: fsck-objects -> fsckLibravatar J. Bruce Fields1-8/+8
There seems to be an agreement to rename fsck-objects to fsck. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-28user-manual: git-fsck, dangling objectsLibravatar J. Bruce Fields1-6/+118
Initial import of fsck and dangling objects discussion, mostly lifted from an email from Linus. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-27user-manual: reorganize fetch discussion, add internals, etc.Libravatar J. Bruce Fields1-204/+954
Keep git remote discussion in the first chapter, but postpone lower-level git fetch usage (to fetch individual branches) till later. Import a bunch of slightly modified text from the readme to give an architectural overview at the end. Add more discussion of history rewriting. And a bunch of other miscellaneous changes.... Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-26user-manual: stub discussion of fsck and reflogLibravatar J. Bruce Fields1-0/+21
Have some sort of recovery/reliability section that deals with reflog and fsck. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-21user-manual: update git-gc discussionLibravatar J. Bruce Fields1-5/+3
It appears git-gc will no longer prune automatically, so we don't need to tell people not to do other stuff while running it. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-21user-manual: update references discussionLibravatar J. Bruce Fields1-27/+19
Since references may be packed, it's no longer as helpful to introduce references as paths relative to .git. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-21user-manual: clarify difference between tag and branchLibravatar J. Bruce Fields1-0/+3
Explain the difference (well, one of the differences) between a tag and a branch. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-21user-manual: minor quickstart reorganizationLibravatar J. Bruce Fields1-8/+22
Move around some stuff in the quickstart, add "push" examples. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-20user-manual: add "quick start" as chapter 1Libravatar J. Bruce Fields1-2/+200
Add a "quick start" guide, modelled after Mercurial's, as the first chapter. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-14user-manual: rewrap, fix heading levelsLibravatar J. Bruce Fields1-17/+23
Fix some heading levels that prevented compile; rewrap some stuff. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-14Merge branch 'master' of git://git.kernel.org/pub/scm/git/gitLibravatar J. Bruce Fields23-202/+324
2007-01-14user-manual: reindentLibravatar J. Bruce Fields1-9/+22
Just some minor reindenting Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-13git-commit documentation: -a adds and also removesLibravatar Junio C Hamano1-1/+2
Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-12Make git-prune-packed a bit more chatty.Libravatar Junio C Hamano1-1/+4
Steven Grimm noticed that git-repack's verbosity is inconsistent because pack-objects is chatty and prune-packed is not. This makes the latter a bit more chatty and gives -q option to squelch it. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-12glossary typofixLibravatar Junio C Hamano1-1/+1
Pointed out by Paul Witt <paul.witt@oxix.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-12use 'init' instead of 'init-db' for shipped docs and toolsLibravatar Nicolas Pitre10-19/+16
While 'init-db' still is and probably will always remain a valid git command for obvious backward compatibility reasons, it would be a good idea to move shipped tools and docs to using 'init' instead. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-12fix documentation for git-commit --no-verifyLibravatar Michael S. Tsirkin1-6/+2
Despite what the documentation claims, git-commit does not check commit for suspicious lines: all hooks are disabled by default, and the pre-comit hook could be changed to do something else. Signed-off-by: Michael S. Tsirkin <mst@mellanox.co.il> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-11Document git-initLibravatar Junio C Hamano2-90/+115
These days, the command does a lot more than just initialise the object database (such as setting default config-variables, installing template hooks...), and "git init" is actually a more sensible name nowadays. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-11user-manual: replace init-db by initLibravatar J. Bruce Fields1-2/+2
Replace mentions of init-db by mentions of init. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-01-10user manual: answer some comments from JunioLibravatar J. Bruce Fields1-23/+10
Junio left a few comments in his previous patch; deal with each of them. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-01-10User manual: fix typos in examplesLibravatar Junio C Hamano1-10/+26
Correct command line examples of repo-config, format-patch and am. A full object name is 40-hexdigit; it may be 20-byte but 20-digit is misleading. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-10Documentation: rev-list -> rev-parse, other typos, start examplesLibravatar J. Bruce Fields1-2/+57
Fix some typos, start adding some more simple examples. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-01-10Add git-init documentation.Libravatar Nicolas Pitre1-0/+1
Oops. Commit 515377ea9ec6192f82a2fa5c5b5b7651d9d6cf6c missed one file, git-init documentation. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-09-u is now default for 'git-mailinfo'.Libravatar Junio C Hamano1-9/+7
Originally from David Woodhouse, but also adjusts the callers of mailinfo to the new default. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-09-u is now default for 'git-applymbox'Libravatar Junio C Hamano1-7/+7
It has '-n' to disable it just in case, but do not even bother documenting it. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-09Update git-svn manpage to remove the implication that SVN::* is optional.Libravatar Steven Grimm1-59/+6
Now that git-svn requires the SVN::* Perl library, the manpage doesn't need to describe what happens when you don't have it. Signed-off-by: Steven Grimm <koreth@midwinter.com> Acked-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-08Documentation: add git-remote man pageLibravatar J. Bruce Fields1-0/+76
Add a preliminary man page for git-remote. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-09Documentation: begin discussion of git-remote in user manualLibravatar J. Bruce Fields1-14/+54
Start discussion of git-remote. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-08Documentation: reorder development section, todo'sLibravatar J. Bruce Fields1-120/+123
Update todo's. Split out "sharing development" section into a separate chapter, reorder. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-08Documentation: more user-manual todo'sLibravatar J. Bruce Fields1-1/+16
Add some more todo's for the user manual. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-08--prune is now default for 'pack-refs'Libravatar Junio C Hamano1-4/+5
There is no reason not to, really. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-08--utf8 is now default for 'git-am'Libravatar Junio C Hamano1-3/+16
Since we are talking about allowing potentially incompatible UI changes in v1.5.0 iff the change improves the general situation, I would say why not. There is --no-utf8 flag to avoid re-coding from botching the log message just in case, but we may not even need it. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-08cvsimport: document -S and -L optionsLibravatar Martin Langhoff1-0/+8
Signed-off-by: Martin Langhoff <martin@catalyst.net.nz> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-08cvsimport: skip commits that are too recent (option and documentation)Libravatar Martin Langhoff1-1/+6
This makes the earlier "wait for 10 minutes before importing" safety overridable with "-a(ll)" flag, and adds necessary documentation. Signed-off-by: Martin Langhoff <martin@catalyst.net.nz> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-07git-svn: add --prefix= option to multi-initLibravatar Eric Wong1-0/+18
Also, document --{trunk,branches,tags} options while we're documenting multi-init options. Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-07Documentation: clarify definition of "reachable"Libravatar J. Bruce Fields1-2/+5
Clarify definition of "reachable" (what chain?) Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-07Documentation: git-rebase discussion, miscellaneous user-manual updatesLibravatar J. Bruce Fields1-4/+157
Add discussion of git-rebase, patch series, history rewriting. Mention "pull ." as a synonym for "merge". Remind myself of another case I want to cover in the other-vcs's chapter. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-07Documentation: expand preface and todo'sLibravatar J. Bruce Fields1-3/+28
Add a brief description of the organization to the preface, expand the final notes/todo's section, in hopes maybe some others will want to contribute. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-07"init-db" can really be just "init"Libravatar Nicolas Pitre5-4/+6
Make "init" the equivalent of "init-db". This should make first GIT impression a little more friendly. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-07Documentation: add git user's manualLibravatar J. Bruce Fields4-1/+1774
The goals are: - Readable from beginning to end in order without having read any other git documentation beforehand. - Helpful section names and cross-references, so it's not too hard to skip around some if you need to. - Organized to allow it to grow much larger (unlike the tutorials) It's more liesurely than tutorial.txt, but tries to stay focused on practical how-to stuff. It adds a discussion of how to resolve merge conflicts, and partial instructions on setting up and dealing with a public repository. I've lifted a little bit from "branching and merging" (e.g., some of the discussion of history diagrams), and could probably steal more if that's OK. (Similarly anyone should of course feel free to reuse bits of this if any parts seem more useful than the whole.) There's a lot of detail on managing branches and using git-fetch, just because those are essential even to people needing read-only access (e.g., kernel testers). I think those sections will be much shorter once the new "git remote" command and the disconnected checkouts are taken into account. I do feel bad about adding yet another piece of documentation, but I we need something that goes through all the basics in a logical order, and I wasn't seeing how to grow the tutorials into that. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
2007-01-07Merge branch 'sp/mmap'Libravatar Junio C Hamano1-0/+28
* sp/mmap: (27 commits) Spell default packedgitlimit slightly differently Increase packedGit{Limit,WindowSize} on 64 bit systems. Update packedGit config option documentation. mmap: set FD_CLOEXEC for file descriptors we keep open for mmap() pack-objects: fix use of use_pack(). Fix random segfaults in pack-objects. Cleanup read_cache_from error handling. Replace mmap with xmmap, better handling MAP_FAILED. Release pack windows before reporting out of memory. Default core.packdGitWindowSize to 1 MiB if NO_MMAP. Test suite for sliding window mmap implementation. Create pack_report() as a debugging aid. Support unmapping windows on 'temporary' packfiles. Improve error message when packfile mmap fails. Ensure core.packedGitWindowSize cannot be less than 2 pages. Load core configuration in git-verify-pack. Fully activate the sliding window pack access. Unmap individual windows rather than entire files. Document why header parsing won't exceed a window. Loop over pack_windows when inflating/accessing data. ... Conflicts: cache.h pack-check.c
2007-01-06Documentation: tutorial editingLibravatar J. Bruce Fields1-6/+10
Edit for conciseness. Add a "Making changes" section header. When possible, make sure that stuff in text boxes could be entered literally. (Don't use "..." unless we want a user to type that.) Move 'commit -a' example into a literal code section, clarify that it finds modified files automatically. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>