Git development
 help / color / mirror / Atom feed
* [PATCH] Documentation: let asciidoc align related options
@ 2009-01-16 21:42 Markus Heidelberg
  0 siblings, 0 replies; only message in thread
From: Markus Heidelberg @ 2009-01-16 21:42 UTC (permalink / raw)
  To: gitster; +Cc: git

Command line options can share the same paragraph of description, if
they are related or synonymous. In these cases they should be written
among each other, so that asciidoc can format them itself.

This also fixes the description of the -t option in git-mergetool.

Signed-off-by: Markus Heidelberg <markus.heidelberg@web.de>
---

	I'm not quite sure about the options in git-diff-files, maybe
	there is a better solution. But at least I think, additional
	words between the options should be avoided, because they add
	confusion.

 Documentation/git-diff-files.txt |    5 ++++-
 Documentation/git-mergetool.txt  |    6 ++++--
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt
index 5c8c1d9..c526141 100644
--- a/Documentation/git-diff-files.txt
+++ b/Documentation/git-diff-files.txt
@@ -21,7 +21,10 @@ OPTIONS
 -------
 include::diff-options.txt[]
 
--1 -2 -3 or --base --ours --theirs, and -0::
+-1 --base::
+-2 --ours::
+-3 --theirs::
+-0::
 	Diff against the "base" version, "our branch" or "their
 	branch" respectively.  With these options, diffs for
 	merged entries are not shown.
diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt
index 4c0ffec..5d3c632 100644
--- a/Documentation/git-mergetool.txt
+++ b/Documentation/git-mergetool.txt
@@ -22,7 +22,8 @@ with merge conflicts.
 
 OPTIONS
 -------
--t or --tool=<tool>::
+-t <tool>::
+--tool=<tool>::
 	Use the merge resolution program specified by <tool>.
 	Valid merge tools are:
 	kdiff3, tkdiff, meld, xxdiff, emerge, vimdiff, gvimdiff, ecmerge, and opendiff
@@ -60,7 +61,8 @@ variable `mergetool.<tool>.trustExitCode` can be set to `true`.
 Otherwise, 'git-mergetool' will prompt the user to indicate the
 success of the resolution after the custom tool has exited.
 
--y or --no-prompt::
+-y::
+--no-prompt::
 	Don't prompt before each invocation of the merge resolution
 	program.
 
-- 
1.6.1.35.g0c23

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2009-01-16 21:43 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-01-16 21:42 [PATCH] Documentation: let asciidoc align related options Markus Heidelberg

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox