aboutsummaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAge
* Show an example of deleting commits with git-rebase.Shawn O. Pearce2007-02-05
| | | | | | | | | | | | | | | This particular use of git-rebase to remove a single commit or a range of commits from the history of a branch recently came up on the mailing list. Documenting the example should help other users arrive at the same solution on their own. It also was not obvious to the newcomer that git-rebase is able to accept any commit for --onto <newbase> and <upstream>. We should at least minimally document this, as much of the language in git-rebase's manpage refers to 'branch' rather than 'committish'. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* git-for-each-ref doesn't return "the bit after $GIT_DIR/refs"Andy Parkins2007-02-05
| | | | | | | | The documentation for git-for-each-ref said that the refname variable would return "the part after $GIT_DIR/refs/", which isn't true. Signed-off-by: Andy Parkins <andyparkins@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge branch 'np/dreflog'Junio C Hamano2007-02-04
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * np/dreflog: show-branch -g: default to the current branch. Let git-checkout always drop any detached head Enable HEAD@{...} and make it independent from the current branch scan reflogs independently from refs add reflog when moving HEAD to a new branch create_symref(): do not assume pathname from git_path() persists long enough add logref support to git-symbolic-ref move create_symref() past log_ref_write() add reflog entries for HEAD when detached enable separate reflog for HEAD lock_ref_sha1_basic(): remember the original name of a ref when resolving it make reflog filename independent from struct ref_lock
| * show-branch -g: default to the current branch.Junio C Hamano2007-02-03
| | | | | | | | | | | | | | | | Now we have a separate reflog on HEAD, show-branch -g without an explicit parameter defaults to the current branch, or HEAD when it is detached from branches. Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Merge branch 'master' into np/dreflogJunio C Hamano2007-02-03
| |\ | | | | | | | | | | | | | | | | | | | | | | | | This is to resolve conflicts early in preparation for possible inclusion of "reflog on detached HEAD" series by Nico, as having it in 1.5.0 would really help us remove confusion between detached and attached states. Signed-off-by: Junio C Hamano <junkio@cox.net>
| * | add logref support to git-symbolic-refNicolas Pitre2007-01-28
| | | | | | | | | | | | | | | Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | | Why is it bad to rewind a branch that has already been pushed out?Robin Rosenberg2007-02-04
| |/ |/| | | | | | | | | | | Mention git-revert as an alternative to git-reset to revert changes. Signed-off-by: Robin Rosenberg <robin.rosenberg@dewire.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Assorted typo fixesPavel Roskin2007-02-03
| | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Cleanup subcommand documentation for git-remote.Shawn O. Pearce2007-02-03
| | | | | | | | | | | | | | | | | | | | Jakub Narebski pointed out the positional notation in git-remote's documentation was very confusing, especially now that we have 3 supported subcommands. Instead of referring to subcommands by position, refer to them by name. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Why is it bad to rewind a branch that has already been pushed out?Junio C Hamano2007-02-03
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I was reading the tutorial and noticed that we say this: Also, don't use "git reset" on a publicly-visible branch that other developers pull from, as git will be confused by history that disappears in this way. I do not think this is a good explanation. For example, if we do this: (1) I build a series and push it out. ---o---o---o---j (2) Alice clones from me, and builds two commits on top of it. ---o---o---o---j---a---a (3) I rewind one and build a few, and push them out. ---o---o---o...j \ h---h---h---h (4) Alice pulls from me again: ---o---o---o---j---a---a---* \ / h---h---h---h Contrary to the description, git will happily have Alice merge between the two branches, and never gets confused. Maybe I did not want to have 'j' because it was an incomplete solution to some problem, and Alice may have fixed it up with her changes, while I abandoned that approach I started with 'j', and worked on something completely unrelated in the four 'h' commits. In such a case, the merge Alice would make would be very sensible, and after she makes the merge if I pull from her, the world will be perfect. I started something with 'j' and dropped the ball, Alice picked it up and perfected it while I went on to work on something else with 'h'. This would be a perfect example of distributed parallel collaboration. There is nothing confused about it. The case the rewinding becomes problematic is if the work done in 'h' tries to solve the same problem as 'j' tried to solve in a different way. Then the merge forced on Alice would make her pick between my previous attempt with her fixups (j+a) and my second attempt (h). If 'a' commits were to fix up what 'j' started, presumably Alice already studied and knows enough about the problem so she should be able to make an informed decision to pick between what 'j+a' and 'h' do. A lot worse case is if Alice's work is not at all related to what 'j' wanted to do (she did not mean to pick up from where I left off -- she just wanted to work on something different). Then she would not be familiar enough with what 'j' and 'h' tried to achieve, and I'd be forcing her to pick between the two. Of course if she can make the right decision, then again that is a perfect example of distributed collaboration, but that does not change the fact that I'd be forcing her to clean up my mess. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | core-tutorial: http reference link fixJunio C Hamano2007-02-02
| | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Tutorial-2: Adjust git-status output to recent reality.Junio C Hamano2007-02-02
| | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Tutorial: fix asciidoc formatting of "git add" section.Junio C Hamano2007-02-02
| | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | doc: hooks.txt said post-commit default sends an email, it doesn'tAndy Parkins2007-02-02
| | | | | | | | | | | | | | | | The default post-commit hook is actually empty; it is the update hook that sends an email. This patch corrects hooks.txt to reflect that. Signed-off-by: Andy Parkins <andyparkins@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Fix some documentation typos and grammarMike Coleman2007-02-01
| | | | | | | | | | | | | | Also suggest user manual mention .gitignore. Signed-off-by: Michael Coleman <tutufan@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Teach 'git remote' how to cleanup stale tracking branches.Shawn O. Pearce2007-02-01
| | | | | | | | | | | | | | | | | | | | Since it can be annoying to manually cleanup 40 tracking branches which were removed by the remote system, 'git remote prune <n>' can now be used to delete any tracking branches under <n> which are no longer available on the remote system. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Update the documentation for the new '@{...}' syntaxJohannes Schindelin2007-02-01
| | | | | | | | | | Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | add a quiet option to git-checkoutNicolas Pitre2007-02-01
| | | | | | | | | | | | | | | | Those new messages are certainly nice, but there might be cases where they are simply unwelcome, like when git-commit is used within scripts. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Do not use hardcoded path to xhmtl.xsl to generate user's manualJunio C Hamano2007-01-31
| | | | | | | | | | | | | | | | It does not seem to need it either and gives an error on FC5 I use at kernel.org to cut documentation tarballs, so remove it in the meantime. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | git main documentation: point at the user's manual.Junio C Hamano2007-01-31
| | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Merge branch 'master' of git://linux-nfs.org/~bfields/gitJunio C Hamano2007-01-31
|\ \ | | | | | | | | | | | | | | | | | | | | | This is in the hope of giving JBF's user-manual wider exposure. I am not very happy with trailing whitespaces in the new document, but let's not worry too much about the formatting issues for now, but concentrate more on the structure and the contents.
| * | user-manual: todo'sJ. Bruce Fields2007-01-30
| | | | | | | | | | | | | | | | | | Update todo's. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | user-manual: point to README for gitweb informationJ. Bruce Fields2007-01-30
| | | | | | | | | | | | | | | | | | | | | I'd like complete gitweb setup instructions some day, but for now just refer to the gitweb README. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | Two small typofixes.Junio C Hamano2007-01-29
| | | | | | | | | | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
| * | user-manual: SHA1 -> object nameJ. Bruce Fields2007-01-29
| | | | | | | | | | | | | | | | | | Prefer "object name" to SHA1, at least in higher level documentation. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | user-manual: document git-show-branch exampleJ. Bruce Fields2007-01-29
| | | | | | | | | | | | | | | | | | | | | 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>
| * | user-manual: minor "TODO" updatesJ. Bruce Fields2007-01-29
| | | | | | | | | | | | | | | | | | | | | | | | 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>
| * | user-manual: rewrap a few long linesJ. Bruce Fields2007-01-29
| | | | | | | | | | | | | | | | | | Rewrap some long lines. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | user-manual: reflogs, other recoveryJ. Bruce Fields2007-01-29
| | | | | | | | | | | | | | | | | | | | | | | | 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>
| * | user-manual: fix a header levelJ. Bruce Fields2007-01-29
| | | | | | | | | | | | | | | | | | Oops. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | user-manual: typo fixJ. Bruce Fields2007-01-29
| | | | | | | | | | | | | | | | | | Oops Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | user-manual: add references to git-config man pageJ. Bruce Fields2007-01-29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| * | user-manual: repo-config -> configJ. Bruce Fields2007-01-28
| | | | | | | | | | | | | | | | | | | | | 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>
| * | user-manual: fsck-objects -> fsckJ. Bruce Fields2007-01-28
| | | | | | | | | | | | | | | | | | There seems to be an agreement to rename fsck-objects to fsck. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | user-manual: git-fsck, dangling objectsJ. Bruce Fields2007-01-28
| | | | | | | | | | | | | | | | | | | | | 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>
| * | user-manual: reorganize fetch discussion, add internals, etc.J. Bruce Fields2007-01-27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| * | user-manual: stub discussion of fsck and reflogJ. Bruce Fields2007-01-26
| | | | | | | | | | | | | | | | | | | | | Have some sort of recovery/reliability section that deals with reflog and fsck. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | user-manual: update git-gc discussionJ. Bruce Fields2007-01-21
| | | | | | | | | | | | | | | | | | | | | 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>
| * | user-manual: update references discussionJ. Bruce Fields2007-01-21
| | | | | | | | | | | | | | | | | | | | | 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>
| * | user-manual: clarify difference between tag and branchJ. Bruce Fields2007-01-21
| | | | | | | | | | | | | | | | | | | | | Explain the difference (well, one of the differences) between a tag and a branch. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | user-manual: minor quickstart reorganizationJ. Bruce Fields2007-01-21
| | | | | | | | | | | | | | | | | | Move around some stuff in the quickstart, add "push" examples. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | user-manual: add "quick start" as chapter 1J. Bruce Fields2007-01-20
| | | | | | | | | | | | | | | | | | | | | Add a "quick start" guide, modelled after Mercurial's, as the first chapter. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | user-manual: rewrap, fix heading levelsJ. Bruce Fields2007-01-14
| | | | | | | | | | | | | | | | | | Fix some heading levels that prevented compile; rewrap some stuff. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | Merge branch 'master' of git://git.kernel.org/pub/scm/git/gitJ. Bruce Fields2007-01-14
| |\ \
| * | | user-manual: reindentJ. Bruce Fields2007-01-14
| | | | | | | | | | | | | | | | | | | | | | | | Just some minor reindenting Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * | | user-manual: replace init-db by initJ. Bruce Fields2007-01-11
| | | | | | | | | | | | | | | | | | | | | | | | Replace mentions of init-db by mentions of init. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * | | user manual: answer some comments from JunioJ. Bruce Fields2007-01-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>
| * | | User manual: fix typos in examplesJunio C Hamano2007-01-10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| * | | Documentation: rev-list -> rev-parse, other typos, start examplesJ. Bruce Fields2007-01-10
| | | | | | | | | | | | | | | | | | | | | | | | Fix some typos, start adding some more simple examples. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * | | Documentation: begin discussion of git-remote in user manualJ. Bruce Fields2007-01-09
| | | | | | | | | | | | | | | | | | | | | | | | Start discussion of git-remote. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>