Re: [PATCH] Update git-am documentation

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:43:04

Andrew Ruder [off-list ref] writes:

Documentation/git-am.txt missing several short versions
of options.  Added documentation for --resolvemsg=<msg>
command-line option.

Signed-off-by: Andrew Ruder <redacted>
---
 Sometimes it is a bit difficult to gauge intention by reading the code.
 :)  My initial thought was that it was just to aid in scripting git-am
 and left it at that.  But I'd still much rather have all command-line
 options in the man pages even if they are primarily for internal use as
 sometimes they still will find themself useful in atypical situations.

It is _solely_ (not "primarily") for git-rebase and not even for
"scripting around".  In other words, it is an implementation
detail of git-rebase and I would rather reserve the right to
update that implementation detail by not setting that in stone
for users to abuse.

[PATCH] Update git-am documentation

From: Andrew Ruder <hidden>
Date: 2016-06-15 22:43:04

Documentation/git-am.txt missing several short versions
of options.

Signed-off-by: Andrew Ruder <redacted>
---
 Ah, I misunderstood your first reply.  If this is truly only for
 internal usage, it should definitely not be in the manpage as
 abuse *will* occur. :)  Let's just hope that nobody finds this thread
 via the mailing list archives.

 Documentation/git-am.txt |   18 +++++++++---------
 1 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 148ce40..759e3a5 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt

@@ -26,18 +26,18 @@ OPTIONS
 	The list of mailbox files to read patches from. If you do not
 	supply this argument, reads from the standard input.
 
---signoff::
+-s, --signoff::
 	Add `Signed-off-by:` line to the commit message, using
 	the committer identity of yourself.
 
---dotest=<dir>::
+-d=<dir>, --dotest=<dir>::
 	Instead of `.dotest` directory, use <dir> as a working
 	area to store extracted patches.
 
---keep::
+-k, --keep::
 	Pass `-k` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
 
---utf8::
+-u, --utf8::
 	Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
 	The proposed commit log message taken from the e-mail
 	are re-coded into UTF-8 encoding (configuration variable

@@ -48,14 +48,14 @@ This was optional in prior versions of git, but now it is the
 default.   You could use `--no-utf8` to override this.
 
 --no-utf8::
-	Do not pass `-u` flag to `git-mailinfo` (see
+	Pass `-n` flag to `git-mailinfo` (see
 	gitlink:git-mailinfo[1]).
 
---binary::
+-b, --binary::
 	Pass `--allow-binary-replacement` flag to `git-apply`
 	(see gitlink:git-apply[1]).
 
---3way::
+-3, --3way::
 	When the patch does not apply cleanly, fall back on
 	3-way merge, if the patch records the identity of blobs
 	it is supposed to apply to, and we have those blobs

@@ -73,10 +73,10 @@ default.   You could use `--no-utf8` to override this.
 	These flags are passed to the `git-apply` program that applies
 	the patch.
 
---interactive::
+-i, --interactive::
 	Run interactively, just like git-applymbox.
 
---resolved::
+-r, --resolved::
 	After a patch failure (e.g. attempting to apply
 	conflicting patch), the user has applied it by hand and
 	the index file stores the result of the application.

-- 
1.5.1.1.98.gedb4f-dirty

`h`	back out one level
`j`	next message in thread
`k`	previous message in thread
`l`	drill in
`Esc`	close help / fold thread tree
`?`	toggle this help