git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] git-am/git-mailsplit: correct synopsis for reading from stdin

From
Stephan Beyer <s-beyer@gmx.net>
Date
Jul 12, 2008, 15:47 UTC
Message-ID
<1215877636-16982-1-git-send-email-s-beyer@gmx.net>

Invoking git-am or git-mailsplit without mbox or Maildir results in reading an mbox from stdin. This should be mentioned in the synopsis and usage strings.

Signed-off-by: Stephan Beyer <s-beyer@gmx.net>
---
 Documentation/git-am.txt |    4 ++--
 builtin-mailsplit.c      |    2 +-
 git-am.sh                |    2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 3863eeb..2842880 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -12,8 +12,8 @@ SYNOPSIS
 'git am' [--signoff] [--keep] [--utf8 | --no-utf8]
          [--3way] [--interactive] [--binary]
          [--whitespace=<option>] [-C<n>] [-p<n>]
-         <mbox>|<Maildir>...
-'git am' [--skip | --resolved]
+         [<mbox> | <Maildir>...]
+'git am' (--skip | --resolved)
 
 DESCRIPTION
 -----------
diff --git a/builtin-mailsplit.c b/builtin-mailsplit.c
index ae2b4cb..e8cbe67 100644
--- a/builtin-mailsplit.c
+++ b/builtin-mailsplit.c
@@ -9,7 +9,7 @@
 #include "path-list.h"
 
 static const char git_mailsplit_usage[] =
-"git-mailsplit [-d<prec>] [-f<n>] [-b] -o<directory> <mbox>|<Maildir>...";
+"git-mailsplit [-d<prec>] [-f<n>] [-b] -o<directory> [<mbox>|<Maildir>...]";
 
 static int is_from_line(const char *line, int len)
 {
diff --git a/git-am.sh b/git-am.sh
index 83b277a..4e73f93 100755
--- a/git-am.sh
+++ b/git-am.sh
@@ -5,7 +5,7 @@
 SUBDIRECTORY_OK=Yes
 OPTIONS_KEEPDASHDASH=
 OPTIONS_SPEC="\
-git-am [options] <mbox>|<Maildir>...
+git-am [options] [<mbox>|<Maildir>...]
 git-am [options] --resolved
 git-am [options] --skip
 --
-- 
1.5.6.2.303.g79662
Message 1 of 1 in “git-am/git-mailsplit: correct synopsis for reading from stdin”
  1. git-am/git-mailsplit: correct synopsis for reading from stdinStephan Beyer, Jul 12, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.