Commit Graph

267 Commits

Author SHA1 Message Date
Junio C Hamano
fd25c82a80 git-checkout-index: documentation updates.
Now the behaviour of '-a' has been straightened out, document it.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-17 17:38:09 -07:00
Junio C Hamano
15fad5f4d7 whatchanged: document -m option from git-diff-tree.
The documentation for git-whatchanged is meant to describe only
the most frequently used options from git-diff-tree.  Because "why
doesn't it show merges" was asked more than once, we'd better
describe '-m' option there.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-15 23:49:27 -07:00
Junio C Hamano
5990efb0c4 tutorial: update the initial commit example.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-13 11:57:05 -07:00
Johannes Schindelin
2ae6c70674 Adapt tutorial to cygwin and add test case
Lacking reliable symlinks, the instructions in the tutorial did not work
in a cygwin setup. Also, a few outputs were not correct.

This patch fixes these, and adds a test case which follows the
instructions of the tutorial (except git-clone, -fetch and -push, which I
have not done yet).

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-13 11:36:37 -07:00
Junio C Hamano
fb8024b414 git-tag: update usage string and documentation.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-09 19:13:47 -07:00
Kai Ruemmler
ab1824787d s/checkout-cache/checkout-index/g for Documentation/git-ls-files.txt
This updates last place where checkout-cache gets mentioned wrongly
for checkout-index.

Signed-off-by:  Kai Ruemmler <kai.ruemmler@gmx.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-07 14:05:03 -07:00
Jonas Fonseca
babfaba23d Fix usage of carets in git-rev-parse(1)
... but using a {caret} attribute.

Signed-off-by: Jonas Fonseca <fonseca@diku.dk>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-05 16:56:31 -07:00
Christian Meder
f73ae1fc5d Some typos and light editing of various manpages
Typos, light editing and clarifications.

Signed-off-by: Christian Meder <chris@absolutegiganten.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-05 15:08:26 -07:00
Junio C Hamano
129056370a Add missing documentation.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-04 17:04:03 -07:00
Jonas Fonseca
df8baa42fe [PATCH] Random documentation fixes
The fixes focuses on improving the HTML output. Most noteworthy:

 - Fix the Makefile to also make various *.html files depend on
   included files.

 - Consistently use 'NOTE: ...' instead of '[ ... ]' for additional
   info.

 - Fix ending '::' for description lists in OPTION section etc.

 - Fix paragraphs in description lists ending up as preformated text.

 - Always use listingblocks (preformatted text wrapped in lines with -----)
   for examples that span empty lines, so they are put in only one HTML
   block.

 - Use '1.' instead of '(1)' for numbered lists.

 - Fix linking to other GIT docs.

 - git-rev-list.txt: put option descriptions in an OPTION section.

Signed-off-by: Jonas Fonseca <fonseca@diku.dk>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-03 13:23:47 -07:00
Eric W. Biederman
a2775c2a41 [PATCH] Update git-clone documentation
The documentation for git-clone is behind the actual command.
I have been getting tired of reading the shell script to see
what the arguments are so here is an update of the actual documentation.

Signed-off-by: Eric Biederman <ebiederman@xmission.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-02 16:06:08 -07:00
Fredrik Kuivinen
500b97e4bb [PATCH] Teach git-ls-files about '--' to denote end of options.
Useful if you have a file whose name starts with a dash.

Signed-off-by: Fredrik Kuivinen <freku045@student.liu.se>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-02 10:31:18 -07:00
Junio C Hamano
1f7f99de84 update-index: document --stdin and -z
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-27 16:59:45 -07:00
Junio C Hamano
946f5f7c24 Diff: --name-status output format.
The new output format shows only the status letter and paths.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-24 23:50:44 -07:00
Junio C Hamano
8082d8d305 Diff: -l<num> to limit rename/copy detection.
When many paths are modified, rename detection takes a lot of time.
The new option -l<num> can be used to disable rename detection when
more than <num> paths are possibly created as renames.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-24 23:50:44 -07:00
Daniel Barkalow
7061f5c2c5 [PATCH] Finish documenting trivial merge rules
Fix missing symbol explanations, a few incorrect cases, and add
two-way merge rules.

Signed-off-by: Daniel Barkalow <barkalow@iabervon.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-24 22:05:55 -07:00
Petr Baudis
9048fe1c50 [PATCH] git-daemon --syslog to log through syslog
Well, this makes it even more clear that we need the packet reader and
friends to use the daemon logging code. :/  Therefore, we at least indicate
in the "Disconnect" log message if the child process exitted with an error
code or not.

Idea by Linus.

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-24 11:20:45 -07:00
Petr Baudis
b5cf3c8b77 [PATCH] Update git-daemon documentation wrt. the --verbose parameter
Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-24 11:20:43 -07:00
Junio C Hamano
348c4c66da Merge 'fixes' branch.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-23 18:46:34 -07:00
Robert Watson
ff8489cb0a [PATCH] document command to show diff of a commit
Document the best way to show the change introduced by a
commit, based on the suggestion by Linus on the list.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-23 14:28:40 -07:00
Jon Loeliger
d154dcc8b6 [PATCH] Retitle 'inspecting what happened' section.
In the tutorial, there is a section entitled "Checking it out"
that shows how to use diff log and whatchanged to insect some
of the repository state.

As the phrase "checkout" ususally carries some baggage WRT
other revision control mechanism, I suggest that we re-title
this section something like "Inspecting Changes".

Signed-off-by: Jon Loeliger <jdl@freescale.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-22 18:31:14 -07:00
Junio C Hamano
5cfcd07c93 Retire diff-helper.
The textual diff generation with built-in '-p' in diff-* brothers has
proven to be useful enough that git-diff-helper outlived its usefulness.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-22 01:54:13 -07:00
Junio C Hamano
9dcc829fe1 Retire rev-tree.
Some old scripts might still use git-rev-tree, but it really is
clearly inferior in every way to git-rev-list that such scripts should
be fixed anyway. Fixing them should be pretty easy.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-22 01:54:12 -07:00
Junio C Hamano
0fe51391a8 Retire git-export.
git-export was done as a concept example on how easy it is to export
the git data to something else. It's much less powerful than any
number of trivial one-liner scripts now, and real exporters would not
ever use git-export.

It's obviously much less powerful than "git-whatchanged", or just
about any combination of git-rev-list + git-diff-tree.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-22 01:54:12 -07:00
Junio C Hamano
0493a3fd52 Merge branch 'fixes' 2005-09-21 12:31:33 -07:00
Junio C Hamano
b163512d4e Fix documentation dependency.
Randal L. Schwartz noticed that 'make install' does not rebuild what
is installed.  Make the 'install' rule depend on 'man'.

I noticed also 'touch' of the source files were used to express include
dependencies, which is a no-no.  Rewrite it to do dependencies properly,
and add missing include dependencies while we are at it.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-21 12:29:59 -07:00
Junio C Hamano
6f60300b54 Update tutorial with Octopus usage.
Making an Octopus is simply a natural extension of merging just one
branch into the current branch.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-21 00:37:17 -07:00
Junio C Hamano
b0391890d2 Show modified files in git-ls-files
Add -m/--modified to show files that have been modified wrt. the index.

[jc: The original came from Brian Gerst on Sep 1st but it only checked
if the paths were cache dirty without actually checking the files were
modified.  I also added the usage string and a new test.]

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-20 15:07:53 -07:00
Junio C Hamano
f318dd229f Document -i flag to git-read-tree
Somehow I missed it when we updated read-tree to support the recursive
merge strategy.  Also -i should require -m as well, which the command
did not check.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-20 15:07:52 -07:00
Sergey Vlasov
a7154e916c [PATCH] Documentation: Update all files to use the new gitlink: macro
The replacement was performed automatically by these commands:

	perl -pi -e 's/link:(git.+)\.html\[\1\]/gitlink:$1\[1\]/g' \
		README Documentation/*.txt
	perl -pi -e 's/link:git\.html\[git\]/gitlink:git\[7\]/g' \
		README Documentation/*.txt

Signed-off-by: Sergey Vlasov <vsu@altlinux.ru>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-20 15:07:52 -07:00
Sergey Vlasov
d1c2e113c5 [PATCH] Documentation: Add asciidoc.conf file and gitlink: macro
Introduce an asciidoc.conf file with the purpose of adding a gitlink:
macro which will improve the manpage output.

Original cogito patch by Jonas Fonseca <fonseca@diku.dk>;
asciidoc.conf from that patch was further enhanced to use the proper
DocBook tag <citerefentry> for references to man pages.

Signed-off-by: Sergey Vlasov <vsu@altlinux.ru>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-20 15:07:51 -07:00
Junio C Hamano
87c6aeb4ef Arrgh -- another asciidoc caret workaround.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-18 15:45:09 -07:00
Junio C Hamano
3a45f625ae Document extended SHA1 used by git-rev-parse.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-18 14:12:43 -07:00
Peter Hagervall
ed0a84883e [PATCH] PATCH Documentation/git-rev-list.txt typo fix
An earlier commit causes a mismatch in <emphasis> and <superscript>
tags, one way of fixing it is having no more than one caret symbol per
line, which is the only solution I found in the asciidoc
documentation. Ugly, but it works.

[jc: ugly indeed but that is not Peter's fault.]

Signed-off-by: Peter Hagervall <hager@cs.umu.se>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-16 15:16:35 -07:00
jdl@freescale.com
316eee8fe0 [PATCH] Documentation/git-rev-list.txt typo fix
Fix the "superscript" problem on the git-rev-list doc page.

Signed-off-by: Jon Loeliger <jdl@freescale.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-15 17:06:58 -07:00
Sergey Vlasov
61420a2cb4 [PATCH] Document git-fetch options
Add documentation for git-fetch options

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-15 13:16:31 -07:00
Junio C Hamano
0f56479d73 Retire info/rev-cache
It was one of those things that were well intentioned but did not turn
out to be useful in practice.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-15 12:46:31 -07:00
Peter Eriksen
53764ee43d [PATCH] Use '-d' as the first flag to 'install'
... in order to please Solaris 'install'.  GNU install is not harmed
with this.

[jc: Documentation/Makefile also fixed.]

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-15 12:46:31 -07:00
Junio C Hamano
2aba319a52 Document git-grep and link it from the main git(7) page.
Also adjust missing description in the git.txt page while we are at it.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-12 19:39:15 -07:00
martin@catalyst.net.nz
a5c500b76c [PATCH] archimport documentation tidyup
New "merges" headline, clarified some parts that were not easy to understand.

Signed-off-by: Martin Langhoff <martin@catalyst.net.nz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-11 10:51:51 -07:00
martin@catalyst.net.nz
a4c5f9aab7 [PATCH] archimport documentation update
Updated and expanded the command description, and added a reference of the
command line options.

Signed-off-by: Martin Langhoff <martin@catalyst.net.nz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-11 10:51:48 -07:00
Yasushi SHOJI
e1ccf53a60 [PATCH] Escape asciidoc's built-in em-dash replacement
AsciiDoc replace '--' with em-dash (&#8212) by default. em-dash
looks a lot like a single long dash and it's very confusing when
we are talking about command options.

Section 21.2.8 'Replacements' of AsciiDoc's User Guide says that a
backslash in front of double dash prevent the replacement.  This
patch does just that.

Signed-off-by: Yasushi SHOJI <yashi@atmark-techno.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-11 10:51:36 -07:00
Junio C Hamano
0f69be5376 'git-merge': Documentation.
... and add link from git.txt, as usual.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-10 18:30:42 -07:00
Daniel Barkalow
3d89cb4f3f [PATCH] Document the trivial merge rules for 3(+more ancestors)-way merges.
Signed-off-by: Daniel Barkalow
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-10 18:27:41 -07:00
Junio C Hamano
b595ed1478 Add 'git bisect replay/log' documentation.
... lest I get yelled at by a very angry scm ;-).

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-10 15:23:09 -07:00
Sven Verdoolaege
d5e34380af [PATCH] Documentation/repository-layout.txt typo
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-10 03:33:33 -07:00
Junio C Hamano
1f8af483df show-branch: --list and --independent
The --list option is what 'git branch' without parameter should
have been; it shows the one-line commit message for each branch
name.  The --independent option is used to filter out commits
that can be reachable from other commits, to make detection of
fast forward condition in multi-head merge easier.

Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-09 16:35:53 -07:00
jdl@freescale.com
96768e3108 [PATCH] fix tutorial typo
Fix a minor typo in the tutorial.txt.

Signed-off-by: Jon Loeliger <jdl@freescale.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-09 09:59:03 -07:00
jdl@freescale.com
c87d41ebf7 [PATCH] Fix tutorial reference to git-*-scripts.
There was a lingering reference to the git-*-scripts in
the tutorial.  This patch reworks that paragraph a bit.

Signed-off-by: Jon Loeliger <jdl@freescale.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-09 09:58:50 -07:00
Junio C Hamano
922fb98e1c Ignore datestamp-only changes when installing webdoc.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-09 01:17:54 -07:00