aboutsummaryrefslogtreecommitdiff
path: root/Documentation/user-manual.txt
Commit message (Collapse)AuthorAge
* 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>
* user-manual: todo updates and cleanupJ. Bruce Fields2007-09-15
| | | | | Format a couple lists. Reminder that we may want to add submodule documentation some day.
* user-manual: fix introduction to packfilesJ. Bruce Fields2007-09-15
| | | | | | | 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>
* user-manual: move packfile and dangling object discussionJ. Bruce Fields2007-09-15
| | | | | | | The discussions of packfiles and dangling objects both belong in the object database section. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* user-manual: rewrite object database discussionJ. Bruce Fields2007-09-15
| | | | | | | | 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>
* user-manual: reorder commit, blob, tree discussionJ. Bruce Fields2007-09-15
| | | | | | | | 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>
* user-manual: rewrite index discussionJ. Bruce Fields2007-09-15
| | | | | | | | | 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>
* user-manual: create new "low-level git operations" chapterJ. Bruce Fields2007-09-15
| | | | | | | | 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>
* user-manual: rename "git internals" to "git concepts"J. Bruce Fields2007-09-15
| | | | | | | | "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>
* user-manual: move object format details to hacking-git chapterJ. Bruce Fields2007-09-15
| | | | | | Most of this is probably only of interest to git developers. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* user-manual: adjust section levels in "git internals"J. Bruce Fields2007-09-15
| | | | | | | | | | | | | | | | | 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>
* Porcelain level "log" family should recurse when diffing.Junio C Hamano2007-08-28
| | | | | | | Most notably, "git log --name-status" stopped at top level directory changes without "-r" option. Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'maint'J. Bruce Fields2007-08-26
|\ | | | | | | | | | | Conflicts: Documentation/user-manual.txt
| * Documentation/user-manual.txt: fix a few omissions of gitlink commands.David Kastrup2007-08-26
| | | | | | | | Signed-off-by: David Kastrup <dak@gnu.org>
| * user-manual: fix incorrect header levelJ. Bruce Fields2007-08-26
| | | | | | | | | | | | This section is a subsection of the "Examples" section. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * user-manual: use pithier example commitJ. Bruce Fields2007-08-26
| | | | | | | | | | | | | | | | | | | | | | | | Actually, we should have a competition for the favorite example commit. Criteria: - length: one-line changes with one-line comments preferred, and no long lines - significance/memorability - comic value Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * user-manual: introduce the word "commit" earlierJ. Bruce Fields2007-08-26
| | | | | | | | | | | | Use the word "commit" as a synonym for "version" from the start. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * user-manual: minor editing for concisenessJ. Bruce Fields2007-08-26
| | | | | | | | | | | | Just cutting out a few unnecessary words. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
| * user-manual: edit "ignoring files" for concisenessJ. Bruce Fields2007-08-26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The immediate motivation for writing this section was to explain the various places ignore patterns could be used. However, I still think .gitignore is the case most people will want to learn about first. It also makes it a bit more concrete to introduce ignore patterns in the context of .gitignore first. And the existance of gitignore(5) relieves the pressure to explain it all here. So, stick to the .gitignore example, with only a brief mention of the others, explain the syntax only by example, and leave the rest to gitignore(5). Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Cc: Johan Herland <johan@herland.net>
* | Documentation/user-manual.txt: fix a few omissions of gitlink commands.David Kastrup2007-08-26
| | | | | | | | Signed-off-by: David Kastrup <dak@gnu.org>
* | Documentation: Correct various misspellings and typos.Brian Hetro2007-08-24
| | | | | | | | | | | | | | Fix minor typos throughout the documentation. Signed-off-by: Brian Hetro <whee@smaertness.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | user-manual: mention git-guiJ. Bruce Fields2007-08-05
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The git gui project seems to be still in early stages, but at a point where it's worth mentioning as an alternative way of creating commits. One feature of interest is the ability to manipulate individual diff hunks. However, people have found that feature not to be easily discoverable from the user-interface. Pending some ui improvements, a parenthetical hint here may help. (Thanks to Steffen Prohask and Junio Hamano for suggesting the language.) Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* | user-manual: mention git stashJunio C Hamano2007-08-05
| | | | | | | | | | | | | | Mention the git-stash command as a way to temporarily set aside work in progress. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* | user-manual: update for new default --track behaviorJ. Bruce Fields2007-08-05
| | | | | | | | | | | | | | | | | | Update documentation to reflect the --track default. That change seems to have happened in the 1.5.3 -rc's, so bump the "for version x.y.z or newer" warning as well. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
* | user-manual: fix typolets.Junio C Hamano2007-07-24
| | | | | | | | Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Merge branch 'maint'Junio C Hamano2007-07-08
|\ \ | |/ | | | | | | | | | | | | * maint: user-manual: fix directory name in git-archive example user-manual: more explanation of push and pull usage tutorial: Fix typo user-manual: grammar and style fixes
generated by cgit v1.2.1 (git 2.18.0) at 2024-10-01 02:35:06 +0000