aboutsummaryrefslogtreecommitdiff
path: root/Documentation/user-manual.txt
Commit message (Collapse)AuthorAge
* User-manual: "git stash <comment>" form is long goneWilliam Pursell2009-02-03
| | | | | | | These days you must explicitly say "git stash save <comment>". Signed-off-by: William Pursell <bill.pursell@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* work around Python warnings from AsciiDocJunio C Hamano2008-12-09
| | | | | | | | | | | | | | | | | | | | It appears that a reference to an anchor defined as [[anchor-name]] from another place using <<anchor-name>> syntax, when the anchor name contains a string "-with-" in its name, triggers these warnings from Python interpreter. asciidoc -b docbook -d book user-manual.txt <string>:1: Warning: 'with' will become a reserved keyword in Python 2.6 <string>:1: Warning: 'with' will become a reserved keyword in Python 2.6 <string>:1: Warning: 'with' will become a reserved keyword in Python 2.6 <string>:1: Warning: 'with' will become a reserved keyword in Python 2.6 There currently is no reference to "Finding comments with given content", but for consistency and for futureproofing, the anchor is also updated as the other ones that are actually used and trigger these warnings. Signed-off-by: Junio C Hamano <junio@pobox.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* User's Manual: remove duplicated url at the end of Appendix BMiklos Vajna2008-12-02
| | | | | Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Fix typos in the documentation.Ralf Wildenhues2008-11-27
| | | | | Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Adjust for the new way of enabling the default post-update hookPetr Baudis2008-08-11
| | | | | | | | | | | | | | | The post-update hook, which is required to be enabled in order for the repository to be accessible over HTTP, is not enabled by chmod a+x anymore, but instead by dropping the .sample suffix. This patch emphasizes this change in the release notes (since I believe this is rather noticeable backwards-incompatible change). It also adjusts the documentation which still described the old way and fixes t/t5540-http-push.sh, which was broken for 1.5 month but apparently noone ever runs this test. Signed-off-by: Petr Baudis <pasky@suse.cz> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'maint'Junio C Hamano2008-08-11
|\ | | | | | | | | | | | | | | | | | | | | * maint: Documentation: fix invalid reference to 'mybranch' in user manual Fix deleting reflog entries from HEAD reflog reflog test: add more tests for 'reflog delete' Documentation: rev-list-options: Fix -g paragraph formatting Conflicts: Documentation/user-manual.txt
| * Documentation: fix invalid reference to 'mybranch' in user manualIvan Stankovic2008-08-10
| | | | | | | | | | Signed-off-by: Ivan Stankovic <pokemon@fly.srk.fer.hr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: user-manual: "git commit -a" doesn't motivate .gitignoreJonathan Nieder2008-08-08
| | | | | | | | | | | | | | | | | | | | "git commit -a" ignores untracked files and follows all tracked files, regardless of whether they are listed in .gitignore. So don't use it to motivate gitignore. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Acked-by: J. Bruce Fields <bfields@fieldses.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | documentation: user-manual: update "using-bisect" sectionChristian Couder2008-07-30
| | | | | | | | | | | | | | | | | | | | | | | | Since version 1.5.6 "git bisect" doesn't use a "bisect" branch any more, but the user manual had not been updated to reflect this. So this patch does that and while at it also adds a few words about "git bisect skip" and points user to the "git bisect" man page for more information. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | `git submodule add` now requires a <path>Abhijit Menon-Sen2008-07-29
| | | | | | | | | | Signed-off-by: Abhijit Menon-Sen <ams@toroid.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Rename .git/rebase to .git/rebase-applyJohannes Schindelin2008-07-21
| | | | | | | | | | | | | | | | | | | | With git-am, it sounds awkward to have the patches in ".git/rebase/", but for technical reasons, we have to keep the same directory name for git-am and git-rebase. ".git/rebase-apply" seems to be a good compromise. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Rename ".dotest/" to ".git/rebase" and ".dotest-merge" to "rebase-merge"Johannes Schindelin2008-07-15
| | | | | | | | | | | | | | | | | | | | | | Since the files generated and used during a rebase are never to be tracked, they should live in $GIT_DIR. While at it, avoid the rather meaningless term "dotest" to "rebase", and unhide ".dotest-merge". This was wished for on the mailing list, but so far unimplemented. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | user-manual: typo and grammar fixesEric Hanchrow2008-07-08
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: more "git-" versus "git " changesJonathan Nieder2008-07-05
| | | | | | | | | | | | | | | | | | | | | | | | | | With git-commands moving out of $(bindir), it is useful to make a clearer distinction between the git subcommand 'git-whatever' and the command you type, `git whatever <options>`. So we use a dash after "git" when referring to the former and not the latter. I already sent a patch doing this same thing, but I missed some spots. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: rewrap to prepare for "git-" vs "git " changeJonathan Nieder2008-07-05
| | | | | | | | | | | | | | Rewrap lines in preparation for added dashes. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: fix gitlinksJonathan Nieder2008-07-05
| | | | | | | | | | Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: be consistent about "git-" versus "git "Jonathan Nieder2008-07-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since the git-* commands are not installed in $(bindir), using "git-command <parameters>" in examples in the documentation is not a good idea. On the other hand, it is nice to be able to refer to each command using one hyphenated word. (There is no escaping it, anyway: man page names cannot have spaces in them.) This patch retains the dash in naming an operation, command, program, process, or action. Complete command lines that can be entered at a shell (i.e., without options omitted) are made to use the dashless form. The changes consist only of replacing some spaces with hyphens and vice versa. After a "s/ /-/g", the unpatched and patched versions are identical. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: complicate example of "man git-command"Jonathan Nieder2008-07-01
| | | | | | | | | | | | | | | | | | | | | | | | The manual page for the command invoked as "git clone" is named git-clone(1), and similarly for the rest of the git commands. Make sure our first example of this in tutorials makes it clear that it is the first two words of a command line that make up the command's name (that is: for example, the effect of "git svn dcommit" is described in git-svn(1)). Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Documentation: fix links to tutorials and other new manual pagesJonathan Nieder2008-07-01
|/ | | | | | | | | | | | | | | | | | | With the conversion of HTML documentation to man pages tutorial.html -> gittutorial (7) tutorial-2.html -> gittutorial-2 (7) cvs-migration.html -> gitcvs-migration (7) diffcore.html -> gitdiffcore (7) repository-layout.html -> gitrepository-layout (5) hooks.html -> githooks (5) glossary.html -> gitglossary (7) core-tutorial.html -> gitcore-tutorial (7) and the automatic update of references to these pages, a little debris was left behind. We clear it away. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* user-manual: describe how higher stages are set during a mergeJunio C Hamano2008-06-12
| | | | | | | | Higher stages store the blobs involved from their side verbatim. Removal of uninteresting hunks are done by "diff --cc" upon demand and not stored in the index. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: convert "glossary" and "core-tutorial" to man pagesChristian Couder2008-06-01
| | | | | | | | | | | | | | | | | | | | This patch renames the following documents and at the same time converts them to the man format: core-tutorial.txt -> gitcore-tutorial.txt glossary.txt -> gitglossary.txt But as the glossary is included in the user manual and as the new gitglossary man page cannot be included as a whole in the user manual, the actual glossary content is now in its own "glossary-content.txt" new file. And this file is included by both the user manual and the gitglossary man page. Other documents that reference the above ones are changed accordingly and sometimes improved a little too. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: convert tutorials to man pagesChristian Couder2008-05-24
| | | | | | | | | | | | | | | | | This patch renames the following documents and at the same time converts them to the man page format: cvs-migration.txt -> gitcvs-migration.txt tutorial.txt -> gittutorial.txt tutorial-2.txt -> gittutorial-2.txt These new man pages are put in section 7, and other documents that reference the above ones are change accordingly. [jc: with help from Nanako to clean things up] Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: rename "hooks.txt" to "githooks.txt" and make it a man pageChristian Couder2008-05-04
| | | | | | | Also now "gitcli(5)" becomes "gitcli(7)". Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* git-gc --prune is deprecatedDmitry Potapov2008-04-22
| | | | | | | | | 25ee9731c137d0a24b0f4879eb0b0cce9b77d5b0 made the '--prune' option deprecated and removed its description from the git-gc man page. This patch removes all references to this option from the rest of the Git documentation. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Fix the wrong output of `git-show v1.3.0~155^2~4` in documentation.Guanqun Lu2008-03-23
| | | | | | | Texts between ~ and ~ will be subscripted during the asciidoc translation. Signed-off-by: Guanqun Lu <Guanqun.Lu@Gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Documentation: rename gitlink macro to linkgitDan McGee2008-01-06
| | | | | | | | | | | | | | | | | | | | | | | | | | Between AsciiDoc 8.2.2 and 8.2.3, the following change was made to the stock Asciidoc configuration: @@ -149,7 +153,10 @@ # Inline macros. # Backslash prefix required for escape processing. # (?s) re flag for line spanning. -(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])= + +# Explicit so they can be nested. +(?su)[\\]?(?P<name>(http|https|ftp|file|mailto|callto|image|link)):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])= + # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P<attrlist>[\w][\w-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] This default regex now matches explicit values, and unfortunately in this case gitlink was being matched by just 'link', causing the wrong inline macro template to be applied. By renaming the macro, we can avoid being matched by the wrong regex. Signed-off-by: Dan McGee <dpmcgee@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'maint' of git://linux-nfs.org/~bfields/gitJunio C Hamano2007-12-31
|\ | | | | | | | | | | * 'maint' of git://linux-nfs.org/~bfields/git: Documentation/user-manual.txt: fix typo Documentation: fix remote.<name>.skipDefaultUpdate description
| * Documentation/user-manual.txt: fix typoGustaf Hendeby2007-12-31
| | | | | | | | | | Signed-off-by: Gustaf Hendeby <hendeby@isy.liu.se> Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* | Fix spelling mistakes in user manualShawn Bohrer2007-12-13
| | | | | | | | | | | | Signed-off-by: Shawn Bohrer <shawn.bohrer@gmail.com> Acked-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'maint'Junio C Hamano2007-11-30
|\ \ | |/ | | | | | | | | | | | | | | | | * maint: Replace the word 'update-cache' by 'update-index' everywhere cvsimport: fix usage of cvsimport.module t7003-filter-branch: Fix test of a failing --msg-filter. cvsimport: miscellaneous packed-ref fixes cvsimport: use rev-parse to support packed refs Add basic cvsimport tests
| * Replace the word 'update-cache' by 'update-index' everywhereJohannes Schindelin2007-11-30
| | | | | | | | | | Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'maint'Junio C Hamano2007-11-25
|\ \ | |/ | | | | | | | | | | | | | | * maint: user-manual: recovering from corruption user-manual: clarify language about "modifying" old commits user-manual: failed push to public repository user-manual: define "branch" and "working tree" at start git-checkout: describe detached head correctly
| * user-manual: recovering from corruptionJ. Bruce Fields2007-11-25
| | | | | | | | | | | | | | | | | | Some instructions on dealing with corruption of the object database. Most of this text is from an example by Linus, identified by Nicolas Pitre <nico@cam.org> with a little further editing by me. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
| * user-manual: clarify language about "modifying" old commitsJ. Bruce Fields2007-11-25
| | | | | | | | | | | | | | | | It's important to remember that git doesn't really allowing "editing" or "modifying" commits, only replacing them by new commits. Redo some of the language to make this clearer. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * user-manual: failed push to public repositoryJ. Bruce Fields2007-11-25
| | | | | | | | | | | | | | More details on the case of a failed push to a public (non-shared) repository. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * user-manual: define "branch" and "working tree" at startJ. Bruce Fields2007-11-25
| | | | | | | | | | | | Some explanation here might help. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* | Merge branch 'maint'Junio C Hamano2007-11-19
|\ \ | |/ | | | | | | | | | | | | * maint: Documentation: Fix references to deprecated commands user-manual: mention "..." in "Generating diffs", etc. user-manual: Add section "Why bisecting merge commits can be harder ..." git-remote.txt: fix example url
| * user-manual: mention "..." in "Generating diffs", etc.J. Bruce Fields2007-11-18
| | | | | | | | | | | | | | | | | | We should mention the use of the "..." syntax for git-diff here. The note about the difference between diff and the combined output of git-format-patch then no longer fits so well, so remove it. Add a reference to the git-format-patch[1] manpage. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * user-manual: Add section "Why bisecting merge commits can be harder ..."Steffen Prohaska2007-11-18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit adds a discussion of the challenge of bisecting merge commits to the user manual. The original author is Junio C Hamano <gitster@pobox.com>, who posted the text to the mailing list <http://marc.info/?l=git&m=119403257315527&w=2>. His email was adapted for the manual. The discussion is added to "Rewriting history and maintainig patch series". The text added requires good understanding of merging and rebasing. Therefore it should not be placed too early in the manual. Right after the section on "Problems with rewriting history", the discussion of bisect gives another reason for linearizing as much of the history as possible. The text includes suggestions and fixes by Ralf Wildenhues <Ralf.Wildenhues@gmx.de> and Benoit Sigoure <tsuna@lrde.epita.fr>. Signed-off-by: Steffen Prohaska <prohaska@zib.de> Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* | user-manual.txt: minor clarification.Sergei Organov2007-11-17
| | | | | | | | | | Signed-off-by: Sergei Organov <osv@javad.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | user-manual: minor rewording for clarity.Sergei Organov2007-11-14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Junio screwed up when applying the previous round of the patch; rewording from "previous" to "old" does make the description clearer. Also revert the rewording from head to branch. The description is talking about the branch's tip commit and using the word head is clearer. Based on input from Sergei and Bruce. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | user-manual.txt: fix a few mistakesSergei Organov2007-11-14
| | | | | | | | | | Signed-off-by: Sergei Organov <osv@javad.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | manual: use 'URL' instead of 'url'.Ralf Wildenhues2007-10-15
| | | | | | | | | | | | | | Just for consistency, use the spelling URL everywhere. Signed-off-by: Lars Hjemli <hjemli@gmail.com> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
* | manual: add some markup.Ralf Wildenhues2007-10-15
| | | | | | | | | | Signed-off-by: Lars Hjemli <hjemli@gmail.com> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
* | manual: Fix example finding commits referencing given content.Ralf Wildenhues2007-10-15
| | | | | | | | | | | | | | | | | | | | | | If I'm handed a file, then it typically lives outside the working directory. git-log only operates on in-tree files, so the first 'filename' should be an in-tree one, or it should look at all files. This patch does the latter, so it would also find renamed files. However, it is also slower. Signed-off-by: Lars Hjemli <hjemli@gmail.com> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
* | Fix some typos, punctuation, missing words, minor markup.Ralf Wildenhues2007-10-15
| | | | | | | | | | Signed-off-by: Lars Hjemli <hjemli@gmail.com> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
* | manual: Fix or remove em dashes.Ralf Wildenhues2007-10-15
|/ | | | | | | | em dashes were used inconsistently in the manual. This changes them to the way they are used in US English. Signed-off-by: Lars Hjemli <hjemli@gmail.com> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
* user-manual: Explain what submodules are good for.Michael Smith2007-09-25
| | | | | | | | | | 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>
* User Manual: add a chapter for submodulesMiklos Vajna2007-09-23
| | | | | | 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>
* user-manual: don't assume refs are stored under .git/refsJ. Bruce Fields2007-09-23
| | | | | | | | | | | 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>
generated by cgit v1.2.1 (git 2.18.0) at 2024-11-15 09:09:19 +0000