summaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* some doc updatesNicolas Pitre2007-01-145-49/+29
| | | | | | | | | | | | | | | 1) talk about "git merge" instead of "git pull ." 2) suggest "git repo-config" instead of directly editing config files 3) echo "URL: blah" > .git/remotes/foo is obsolete and should be "git repo-config remote.foo.url blah" 4) support for partial URL prefix has been removed (see commit ea560e6d64374ec1f6c163c276319a3da21a1345) so drop mention of it. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* git log documentation: teach -<n> form.Junio C Hamano2007-01-141-1/+1
| | | | | | | | We say "this shows only the most often used ones"; so instead of teaching --max-number=<n> form, list -<n> form which is much easier to type. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Allow the user to control the verbosity of merge-recursive.Shawn O. Pearce2007-01-141-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Junio C Hamano <junkio@cox.net> writes: > > I think the output from merge-recursive can be categorized into 5 > verbosity levels: > > 1. "CONFLICT", "Rename", "Adding here instead due to D/F conflict" > (outermost) > > 2. "Auto-merged successfully" (outermost) > > 3. The first "Merging X with Y". > > 4. outermost "Merging:\ntitle1\ntitle2". > > 5. outermost "found N common ancestors\nancestor1\nancestor2\n..." > and anything from inner merge. > > I would prefer the default verbosity level to be 2 (that is, show > both 1 and 2). and this change makes it so. I think level 3 is probably pointless as its only one line of output above level 2, but I can see how some users may want to view it but not view the slightly more verbose output of level 4. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* git-commit documentation: -a adds and also removesJunio C Hamano2007-01-131-1/+2
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Make git-prune-packed a bit more chatty.Junio C Hamano2007-01-121-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>
* glossary typofixJunio C Hamano2007-01-121-1/+1
| | | | | | Pointed out by Paul Witt <paul.witt@oxix.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* use 'init' instead of 'init-db' for shipped docs and toolsNicolas Pitre2007-01-1210-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>
* fix documentation for git-commit --no-verifyMichael S. Tsirkin2007-01-121-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>
* Document git-initJunio C Hamano2007-01-112-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>
* Add git-init documentation.Nicolas Pitre2007-01-101-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>
* -u is now default for 'git-mailinfo'.Junio C Hamano2007-01-091-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>
* -u is now default for 'git-applymbox'Junio C Hamano2007-01-091-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>
* Update git-svn manpage to remove the implication that SVN::* is optional.Steven Grimm2007-01-091-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>
* Documentation: add git-remote man pageJ. Bruce Fields2007-01-081-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>
* --prune is now default for 'pack-refs'Junio C Hamano2007-01-081-4/+5
| | | | | | There is no reason not to, really. Signed-off-by: Junio C Hamano <junkio@cox.net>
* --utf8 is now default for 'git-am'Junio C Hamano2007-01-081-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>
* cvsimport: document -S and -L optionsMartin Langhoff2007-01-081-0/+8
| | | | | Signed-off-by: Martin Langhoff <martin@catalyst.net.nz> Signed-off-by: Junio C Hamano <junkio@cox.net>
* cvsimport: skip commits that are too recent (option and documentation)Martin Langhoff2007-01-081-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>
* git-svn: add --prefix= option to multi-initEric Wong2007-01-071-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>
* Documentation: clarify definition of "reachable"J. Bruce Fields2007-01-071-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>
* "init-db" can really be just "init"Nicolas Pitre2007-01-075-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>
* Merge branch 'sp/mmap'Junio C Hamano2007-01-071-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
| * Increase packedGit{Limit,WindowSize} on 64 bit systems.Shawn O. Pearce2007-01-061-6/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | If we have a 64 bit address space we can easily afford to commit a larger amount of virtual address space to pack file access. So on these platforms we should increase the default settings of core.packedGit{Limit,WindowSize} to something that will better handle very large projects. Thanks to Andy Whitcroft for pointing out that we can safely increase these defaults on such systems. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Update packedGit config option documentation.Shawn O. Pearce2006-12-301-2/+6
| | | | | | | | | | | | | | | | | | | | Corrected minor typos and documented the new k/m/g suffix for core.packedGitWindowSize and core.packedGitLimit. [jc: with a minor markup fix.] Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Merge branch 'master' into sp/mmapJunio C Hamano2006-12-3010-20/+122
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * master: Documentation/config.txt (and repo-config manpage): mark-up fix. Teach Git how to parse standard power of 2 suffixes. Use /dev/null for update hook stdin. Redirect update hook stdout to stderr. Remove unnecessary argc parameter from run_command_v. Automatically detect a bare git repository. Replace "GIT_DIR" with GIT_DIR_ENVIRONMENT. Use PATH_MAX constant for --bare. Force core.filemode to false on Cygwin. Fix formatting for urls section of fetch, pull, and push manpages Fix yet another subtle xdl_merge() bug i18n: drop "encoding" header in the output after re-coding. commit-tree: cope with different ways "utf-8" can be spelled. Move commit reencoding parameter parsing to revision.c Documentation: minor rewording for git-log and git-show pages. Documentation: i18n commit log message notes. t3900: test log --encoding=none commit re-encoding: fix confusion between no and default conversion.
| * | Fully activate the sliding window pack access.Shawn O. Pearce2006-12-291-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This finally turns on the sliding window behavior for packfile data access by mapping limited size windows and chaining them under the packed_git->windows list. We consider a given byte offset to be within the window only if there would be at least 20 bytes (one hash worth of data) accessible after the requested offset. This range selection relates to the contract that use_pack() makes with its callers, allowing them to access one hash or one object header without needing to call use_pack() for every byte of data obtained. In the worst case scenario we will map the same page of data twice into memory: once at the end of one window and once again at the start of the next window. This duplicate page mapping will happen only when an object header or a delta base reference is spanned over the end of a window and is always limited to just one page of duplication, as no sane operating system will ever have a page size smaller than a hash. I am assuming that the possible wasted page of virtual address space is going to perform faster than the alternatives, which would be to copy the object header or ref delta into a temporary buffer prior to parsing, or to check the window range on every byte during header parsing. We may decide to revisit this decision in the future since this is just a gut instinct decision and has not actually been proven out by experimental testing. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * | Introduce new config option for mmap limit.Shawn O. Pearce2006-12-291-0/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Rather than hardcoding the maximum number of bytes which can be mmapped from pack files we should make this value configurable, allowing the end user to increase or decrease this limit on a per-repository basis depending on the size of the repository and the capabilities of their operating system. In general users should not need to manually tune such a low-level setting within the core code, but being able to artifically limit the number of bytes which we can mmap at once from pack files will make it easier to craft test cases for the new mmap sliding window implementation. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Documentation: tutorial editingJ. Bruce Fields2007-01-061-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>
* | | Documentation/git-svn: clarify dcommit, rebase vs pull/mergeEric Wong2007-01-061-15/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | Clarify that dcommit creates a revision in SVN for every commit in git. Also, add 'merge' to the rebase vs pull section because git-merge is now a first-class UI. Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | git-svnimport: support for incremental importSasha Khapyorsky2007-01-061-1/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This adds ability to do import "in chunks" (default 1000 revisions), after each chunk git repo will be repacked. The option -R is used to change default value of chunk size (or how often repository will repacked). Signed-off-by: Sasha Khapyorsky <sashak@voltaire.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Describe git-clone's actual behavior in the summarySteven Grimm2007-01-061-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If a branch other than "master" is checked out in the origin repository, git-clone makes a local copy of that branch rather than the origin's "master" branch. This patch describes the actual behavior. Signed-off-by: Steven Grimm <koreth@midwinter.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | git-svn: update documentation for multi-{init|fetch}Eric Wong2007-01-041-17/+37
| | | | | | | | | | | | | | | Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | git-tag: add flag to verify a tagSanti Béjar2007-01-031-1/+6
| | | | | | | | | | | | | | | | | | | | | This way "git tag -v $tag" is the UI for git-verify-tag. Signed-off-by: Santi Béjar <sbejar@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Documentation/tutorial: misc updatesSanti Béjar2007-01-031-4/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | - Teach how to delete a branch with "git branch -d name". - Usually a commit has one parent; merge has more. - Teach "git show" instead of "git cat-file -p". Signed-off-by: Santi Béjar <sbejar@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | tutorial: misc updates.Junio C Hamano2007-01-031-7/+17
| | | | | | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Add documentation for git-branch's color configuration.Brian Gernhardt2007-01-032-7/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Added color.branch and color.branch.<slot> to configuration list. Style copied from color.status and meanings derived from the code. Moved the color meanings from color.diff.<slot> to color.branch.<slot> since the latter comes first alphabetically. Added --color and --no-color to git-branch's usage and documentation. Signed-off-by: Brian Gernhardt <benji@silverinsanity.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Update clone/fetch documentation with --depth (shallow clone) optionJunio C Hamano2007-01-012-1/+16
| | | | | | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Strongly discourage --update-head-ok in fetch-options documentation.Junio C Hamano2007-01-011-2/+4
| | | | | | | | | | | | | | | | | | | | | "Use it with care" is a wrong wording to say "this is purely internal and you are supposed to know what you are doing if you use this". Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Documentation: remove master:origin example from pull-fetch-param.txtJ. Bruce Fields2007-01-011-4/+0
| | | | | | | | | | | | | | | | | | | | | This is no longer a useful example. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Documentation: update git-pull.txt for new clone behaviorJ. Bruce Fields2007-01-011-44/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Update examples, stop using branch named "origin" as an example. Remove large example of use of remotes; that particular case is nicely automated by default, so it's not so pressing to explain, and we can refer to git-repo-config for the details. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Update send-pack pipeline documentation.Junio C Hamano2007-01-011-65/+16
| | | | | | | | | | | | | | | | | | | | | The pipeline was much more complex and needed documentation, but now it is trivial and straightforward. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Fix formatting for urls section of fetch, pull, and push manpagesTheodore Tso2006-12-311-12/+14
| | | | | | | | | | | | | | | | | | | | | Updated to make the nroff'ed man pages look nicer. Signed-off-by: "Theodore Ts'o" <tytso@mit.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Documentation: update tutorial's discussion of originJ. Bruce Fields2006-12-311-10/+15
| | | | | | | | | | | | | | | | | | | | | | | | Update tutorial's discussion of origin branch to reflect new defaults, and include a brief mention of git-repo-config. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Documentation: update glossary entry for "origin"J. Bruce Fields2006-12-311-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Update glossary entry for "origin" to reflect fact that it normally now refers to a remote repository, not a branch. Also, warning not to work on remote-tracking branches is no longer necessary since git doesn't allow that. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Documentation: update git-clone.txt for clone's new default behaviorJ. Bruce Fields2006-12-311-7/+4
| | | | | | | | | | | | | | | | | | | | | Fix a couple remaining references to the origin branch. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Docs: update cvs-migration.txt to reflect clone's new default behaviorJ. Bruce Fields2006-12-311-7/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I couldn't think of a really quick way to give all the details, so just refer readers to the git-repo-config man page instead. I haven't tested recent cvs import behavior--some time presumably it should be updated to do something more similar to clone. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Update documentation for update hook.Junio C Hamano2006-12-311-2/+2
| | | | | | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Merge branch 'jc/send-pack-pipeline'Junio C Hamano2006-12-311-0/+112
|\ \ \ | |_|/ |/| | | | | | | | | | | * jc/send-pack-pipeline: Documentation: illustrate send-pack pipeline. send-pack: fix pipeline.
| * | Documentation: illustrate send-pack pipeline.Junio C Hamano2006-12-291-0/+112
| |/ | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Documentation/config.txt (and repo-config manpage): mark-up fix.Junio C Hamano2006-12-301-7/+7
| | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>