threads / patch / 13046

patchDocument option --only of git commit

Subject: [PATCH] Document option --only of git commit

## tl;dr

3 messages between Apr 10, 2008 and Apr 18, 2008. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Johannes Sixt· Apr 10, 2008, 11:33 UTC · lore

[PATCH] builtin-commit.c: Remove a redundant assignment.

Signed-off-by: Johannes Sixt <johannes.sixt@telecom.at>
---
	I noticed this while looking how --only is implemented.
	-- Hannes
 builtin-commit.c |    4 +---
 1 files changed, 1 insertions(+), 3 deletions(-)
Show changes to builtin-commit.c +1 −3
diff --git a/builtin-commit.c b/builtin-commit.c
index 660a345..e3adfdf 100644
--- a/builtin-commit.c
+++ b/builtin-commit.c
@@ -745,10 +745,8 @@ static int parse_and_validate_options(int argc, const char *argv[],
 		die("No paths with --include/--only does not make sense.");
 	if (argc == 0 && only && amend)
 		only_include_assumed = "Clever... amending the last one with dirty index.";
-	if (argc > 0 && !also && !only) {
+	if (argc > 0 && !also && !only)
 		only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
-		also = 0;
-	}
 	if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
 		cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
 	else if (!strcmp(cleanup_arg, "verbatim"))

-- 
1.5.5.33.g376d1
Johannes Sixt· Apr 10, 2008, 11:33 UTC · re: Johannes Sixt · lore

Its documentation was removed by 6c96753df9db7f790a2ac4d95ec2a868394cd5ff, even though it is referenced from a few places, including builtin-commit.c (as part of the commentary in the commit message template).

Signed-off-by: Johannes Sixt <johannes.sixt@telecom.at>
---
 Documentation/git-commit.txt |   11 +++++++++++
 builtin-commit.c             |    2 +-
 2 files changed, 12 insertions(+), 1 deletions(-)
Show changes to 2 files +12 −1

Documentation/git-commit.txt, builtin-commit.c

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index b4ae61f..4bb51cc 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -139,6 +139,17 @@ but can be used to amend a merge commit.
 	as well.  This is usually not what you want unless you
 	are concluding a conflicted merge.
 
+-o|--only::
+	Make a commit only from the paths specified on the
+	command line, disregarding any contents that have been
+	staged so far. This is the default mode of operation of
+	'git commit' if any paths are given on the command line,
+	in which case this option can be omitted.
+	If this option is specified together with '--amend', then
+	no paths need be specified, which can be used to amend
+	the last commit without committing changes that have
+	already been staged.
+
 -u|--untracked-files::
 	Show all untracked files, also those in uninteresting
 	directories, in the "Untracked files:" section of commit
diff --git a/builtin-commit.c b/builtin-commit.c
index e3adfdf..bcb7aaa 100644
--- a/builtin-commit.c
+++ b/builtin-commit.c
@@ -98,7 +98,7 @@ static struct option builtin_commit_options[] = {
 	OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
 	OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
 	OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
-	OPT_BOOLEAN('o', "only", &only, ""),
+	OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
 	OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
 	OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
 	OPT_BOOLEAN(0, "untracked-files", &untracked_files, "show all untracked files"),

-- 
1.5.5.33.g376d1
Pieter de Bie· Apr 18, 2008, 09:28 UTC · re: Johannes Sixt · lore

Re: [PATCH] Document option --only of git commit

Hi,
On 10 apr 2008, at 13:33, Johannes Sixt wrote:
Show 7 quoted lines
> Its documentation was removed by  
> 6c96753df9db7f790a2ac4d95ec2a868394cd5ff,
> even though it is referenced from a few places, including builtin- 
> commit.c
> (as part of the commentary in the commit message template).
>
> Signed-off-by: Johannes Sixt <johannes.sixt@telecom.at>
Show 11 quoted lines
> +-o|--only::
> +	Make a commit only from the paths specified on the
> +	command line, disregarding any contents that have been
> +	staged so far. This is the default mode of operation of
> +	'git commit' if any paths are given on the command line,
> +	in which case this option can be omitted.
> +	If this option is specified together with '--amend', then
> +	no paths need be specified, which can be used to amend
> +	the last commit without committing changes that have
> +	already been staged.
> +

I find this addition to the manpage very confusing. If -o commits paths only from the command line, and it is also the default operation when run with paths, why is this text at the -o option? This behaviour is already documented in the description of git-commit:

        3. by listing files as arguments to the commit command, in  
which case the commit will
           ignore changes staged in the index, and instead record the  
current content of the
           listed files;

I'd suggest only using the second part (about --amend), or optionally adding something about what happens if you specify -o without --amend and without paths.

- Pieter

← back to recent threads