Re: [PATCH] Document "commit --only".
From: Matthieu Moy <hidden>
Date: 2016-06-15 22:43:08
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Possibly related (same subject, not in this thread)
- 2016-06-15 · [PATCH] Document "commit --only". · Matthieu Moy <hidden>
- 2016-06-15 · Re: [PATCH] Document "commit --only". · Nicolas Pitre <hidden>
- 2016-06-15 · Re: [PATCH] Document "commit --only". · Matthieu Moy <hidden>
Matthieu Moy [off-list ref] writes:
Nicolas Pitre [off-list ref] writes:quoted
This looks really confusing. This is the default _only_ if files are specified on the command line. IMHO I'd rather remove the option from the synopsis and flag it as scheduled for removal in the source instead.I'm fine with this proposal. Next email will be a patch to do that (I'm not sure about the standard way to deprecate things in git, so I just added a warning when -o is used, feel free to improve it).
I messed up threading, sorry. Here's the patch again, but it's already in a separate thead. [PATCH] Remove mention of -o|--only in SYNOPSYS of git-commit. This flag is actually useless since it is the default behavior, and was mentionned in the SYNOPSYS, but not actually documented. Better just deprecate it. Signed-off-by: Matthieu Moy <redacted> --- Documentation/git-commit.txt | 4 ++-- git-commit.sh | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 53a7bb0..4324ca0 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt@@ -11,7 +11,7 @@ SYNOPSIS 'git-commit' [-a | --interactive] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg> | --amend] [--no-verify] [-e] [--author <author>] - [--] [[-i | -o ]<file>...] + [--] [[-i] <files>...] DESCRIPTION -----------
@@ -91,7 +91,7 @@ OPTIONS Used to amend the tip of the current branch. Prepare the tree object you would want to replace the latest commit as usual - (this includes the usual -i/-o and explicit paths), and the + (this includes the usual -i and explicit paths), and the commit log editor is seeded with the commit message from the tip of the current branch. The commit you create replaces the current tip -- if it was a merge, it will have the parents of
diff --git a/git-commit.sh b/git-commit.sh
index f28fc24..3913097 100755
--- a/git-commit.sh
+++ b/git-commit.sh@@ -3,7 +3,7 @@ # Copyright (c) 2005 Linus Torvalds # Copyright (c) 2006 Junio C Hamano -USAGE='[-a | --interactive] [-s] [-v] [--no-verify] [-m <message> | -F <logfile> | (-C|-c) <commit> | --amend] [-u] [-e] [--author <author>] [[-i | -o] <path>...]' +USAGE='[-a | --interactive] [-s] [-v] [--no-verify] [-m <message> | -F <logfile> | (-C|-c) <commit> | --amend] [-u] [-e] [--author <author>] [[-i] <path>...]' SUBDIRECTORY_OK=Yes . git-sh-setup require_work_tree
@@ -138,6 +138,8 @@ do shift ;; -o|--o|--on|--onl|--only) + echo >&2 "Warning: --only option is now the default." + echo >&2 "It will be removed in a future version of git." only=t shift ;;
--
1.5.1.1