summaryrefslogtreecommitdiff
path: root/Documentation/git.txt
AgeCommit message (Collapse)Author
2008-07-02Documentation formatting and cleanupJonathan Nieder
Following what appears to be the predominant style, format names of commands and commandlines both as `teletype text`. While we're at it, add articles ("a" and "the") in some places, italicize the name of the command in the manual page synopsis line, and add a comma or two where it seems appropriate. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-02Documentation: fix links to tutorials and other new manual pagesJonathan Nieder
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>
2008-06-26GIT 1.5.6.1v1.5.6.1Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-18GIT 1.5.6v1.5.6Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-08Docs: Use "-l::\n--long\n" format in OPTIONS sectionsStephan Beyer
The OPTIONS section of a documentation file contains a list of the options a git command accepts. Currently there are several variants to describe the case that different options (almost) do the same in the OPTIONS section. Some are: -f, --foo:: -f|--foo:: -f | --foo:: But AsciiDoc has the special form: -f:: --foo:: This patch applies this form to the documentation of the whole git suite, and removes useless em-dash prevention, so \--foo becomes --foo. Signed-off-by: Stephan Beyer <s-beyer@gmx.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-07Merge 1.5.5.4 inJunio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-07GIT 1.5.5.4v1.5.5.4Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-06documentation: move git(7) to git(1)Christian Couder
As the "git" man page describes the "git" command at the end-user level, it seems better to move it to man section 1. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-06documentation: convert "diffcore" and "repository-layout" to man pagesChristian Couder
This patch renames the following documents and at the same time converts them to the man format: diffcore.txt -> gitdiffcore.txt (man section 7) repository-layout.txt -> gitrepository-layout.txt (man section 5) Other documents that reference the above ones are changed accordingly. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-02Documentation: convert "glossary" and "core-tutorial" to man pagesChristian Couder
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>
2008-05-28Merge 1.5.5.3 inJunio C Hamano
2008-05-28GIT 1.5.5.3v1.5.5.3Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-05-26Documentation/git.txt: link to 1.5.5.2 documentation.Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-05-25Documentation: convert tutorials to man pagesChristian Couder
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>
2008-05-05Documentation: rename "hooks.txt" to "githooks.txt" and make it a man pageChristian Couder
Also now "gitcli(5)" becomes "gitcli(7)". Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-04-30Documentation on --git-dir and --work-treeLiu Yubao
2008-04-20GIT 1.5.5.1v1.5.5.1Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-04-08GIT 1.5.5v1.5.5Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-03-28GIT 1.5.5-rc2v1.5.5-rc2Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-03-09Merge branch 'maint' to sync with 1.5.4.4Junio C Hamano
* maint: GIT 1.5.4.4 ident.c: reword error message when the user name cannot be determined Fix dcommit, rebase when rewriteRoot is in use Really make the LF after reset in fast-import optional
2008-02-23Sync with 1.5.4.3Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-17Sync with 1.5.4.2 and start 1.5.5 Release NotesJunio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-12Update the main documentation (stale notes section)Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-02-02Update stale documentation links from the main documentation.Junio C Hamano
This could have been part of the 1.5.4 commit, but it isn't. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-08Merge in GIT 1.5.3.8Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-01-07Documentation: rename gitlink macro to linkgitDan McGee
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>
2007-12-18Fix some documentation typos.Ralf Wildenhues
Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-15Start preparing the API documents.Junio C Hamano
Most of them are still stubs, but the procedure to build the HTML documentation, maintaining the index and installing the end product are there. I placed names of people who are likely to know the most about the topic in the stub files, so that volunteers will know whom to ask questions as needed. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-10Merge branch 'master' into cc/helpJunio C Hamano
This is to primarily pull in MANPATH tweak and help.txt formatting fix from the master branch.
2007-12-04Documentation/git.txt: typofixJunio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-04Documentation: describe -i/--info option to "git-help"Christian Couder
Option -i|--info for "git-help" is documented only in the new "git-help.txt" man page, but this new man page is referenced from the "--help" option documentation in the "git.txt" man page. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-04Documentation: add a new man page for "git-help"Christian Couder
Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-01Merge 1.5.3.7 inJunio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-11-18Merge branch 'maint' to synchronize with 1.5.3.6Junio C Hamano
* maint: GIT 1.5.3.6 grep -An -Bm: fix invocation of external grep command Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-10-31Merge branch 'maint' to catch up with 1.5.3.5Junio C Hamano
2007-10-23k.org git toppage: Add link to 1.5.3 release notes.Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-10-16Fix some typos, punctuation, missing words, minor markup.Ralf Wildenhues
Signed-off-by: Lars Hjemli <hjemli@gmail.com> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
2007-10-04Update state documentation link for 1.5.3.4Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-10-01Update stale documentation link in the k.org siteJunio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-19Merge branch 'maint' to sync with 1.5.3.2Junio C Hamano
This is an evil merge that also updates the stale document links in Documentation/git.txt Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-16documentation: replace Discussion section by link to user-manual chapterJ. Bruce Fields
The "Discussion" section has a lot of useful information, but is a little wordy, especially for an already-long man page, and is designed for an audience more of potential git hackers than users, which probably doesn't make as much sense as git matures. Also, I (perhaps foolishly) forked a version in the user manual, which has been significantly rewritten in an attempt to address some of the above problems. So, remove this section and replace it by a (very terse) summary of the original material--my attempt at the World's Shortest Git Overview--and a reference to the appropriate chapter of the user manual. It's unfortunate to remove something that's been in this place for a long time, as some people may still depend on finding it there. But I think we'll want to do this some day anyway. Cc: Andreas Ericsson <ae@op5.se> Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
2007-09-03GIT 1.5.3.1: obsolete git-p4 in RPM spec file.v1.5.3.1Junio C Hamano
HPA noticed that yum does not like the newer git RPM set; it turns out that we do not ship git-p4 anymore but existing installations do not realize the package is gone if we do not tell anything about it. David Kastrup suggests using Obsoletes in the spec file of the new RPM to replace the old package, so here is a try. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-09-01Update my contact address as the maintainer.Junio C Hamano
2007-08-28git --bare cmd: do not unconditionally nuke GIT_DIRJunio C Hamano
"GIT_DIR=some.where git --bare cmd" and worse yet "git --git-dir=some.where --bare cmd" were very confusing. They both ignored git-dir specified, and instead made $cwd as GIT_DIR. This changes --bare not to override existing GIT_DIR. This has been like this for a long time. Let's hope nobody sane relied on this insane behaviour. Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-19Add and document a global --no-pager option for git.Matthieu Moy
To keep the change small, this is done by setting GIT_PAGER to "cat". Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Acked-by: Linus Torvalds <torvalds@linux-foundation.org> Acked-by: Brian Gernhardt <benji@silverinsanity.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-16Update documentation links for older releases.Junio C Hamano
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-04Document GIT_SSH environment variable alongside other variablesShawn O. Pearce
The GIT_SSH environment variable has survived for quite a while without being documented, but has been mentioned on list and on my day-job repositories can only be accessed via magic supplied through the wonderous hack that is GIT_SSH. Advertising it alongside other "low level magic" such as GIT_PAGER and GIT_MERGE_VERBOSITY will certainly help others who need to spread their own pixie dust to make things work. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-07-20Document how to tell git to not launch a pagerSteven Grimm
Signed-off-by: Steven Grimm <koreth@midwinter.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-07-13Update git-merge documentation.Jakub Narebski
Add "Configuration" section to describe merge.summary configuration variable (which is mentioned in git-fmt-merge-msg(1) man page, but it is a plumbing command), and merge.verbosity configuration variable (so there is a place to make reference from "Environment Variables" section of git(7) man page) to the git-merge(1) man page. Also describe GIT_MERGE_VERBOSITY environment. The configuration variable merge.verbosity and environment variable GIT_MERGE_VERBOSITY were introduced in commit 8c3275ab, which also documented configuration variable but not environment variable. Signed-off-by: Jakub Narebski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-07-12Update list of older git docsJunio C Hamano