Skip to contentSkip to conversation

commit-tree: utilize parse-options api

PATCH Superseded Brandon Richardson 2 participants 3 messages Mar 3, 2019 – Mar 4, 2019 Documentation

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 commit-tree: utilize parse-options api

Rather than parse options manually, which is both difficult to read and error prone, parse options supplied to commit-tree using the parse-options api.

It was discovered that the --no-gpg-sign option was documented but not implemented in commit 70ddbd7767 (commit-tree: add missing --gpg-sign flag, 2019-01-19), and the existing implementation would attempt to translate the option as a tree oid. It was also suggested earlier in commit 55ca3f99ae (commit-tree: add and document --no-gpg-sign, 2013-12-13) that commit-tree should be migrated to utilize the parse-options api, which could help prevent mistakes like this in the future. Hence this change.

---

Notes:
GitHub Pull Request: https://github.com/brandon1024/git/pull/3
Travis CI Build: https://travis-ci.com/brandon1024/git/builds/102953064

 Documentation/git-commit-tree.txt |   8 +-
 builtin/commit-tree.c             | 159 ++++++++++++++++--------------
 parse-options.h                   |  11 +++
 3 files changed, 104 insertions(+), 74 deletions(-)
Documentation/git-commit-tree.txt +6 -2
index 002dae625e..f4e20b62a0 100644
@@ -23,6 +23,9 @@ Creates a new commit object based on the provided tree object and
 emits the new commit object id on stdout. The log message is read
 from the standard input, unless `-m` or `-F` options are given.
 
+When mixing `-m` and `-F` options, the commit log message will be
+composed in the order in which the options are given.
+
 A commit object may have any number of parents. With exactly one
 parent, it is an ordinary commit. Having more than one parent makes
 the commit a merge between several lines of history. Initial (root)
@@ -41,7 +44,7 @@ state was.
 OPTIONS
 -------
 <tree>::
-	An existing tree object
+	An existing tree object.
 
 -p <parent>::
 	Each `-p` indicates the id of a parent commit object.
@@ -52,7 +55,8 @@ OPTIONS
 
 -F <file>::
 	Read the commit log message from the given file. Use `-` to read
-	from the standard input.
+	from the standard input. This can be given more than once and the
+	content of each file becomes its own paragraph.
 
 -S[<keyid>]::
 --gpg-sign[=<keyid>]::
builtin/commit-tree.c +87 -72

193 lines not on this page · raw message

parse-options.h +11 -0
index 14fe32428e..3a442eee26 100644
@@ -202,6 +202,17 @@ const char *optname(const struct option *opt, int flags);
 		BUG("option callback does not expect an argument"); \
 } while (0)
 
+/*
+ * Similar to the assertions above, but checks that "arg" is always non-NULL.
+ * This assertion also implies BUG_ON_OPT_NEG(), letting you declare both
+ * assertions in a single line.
+ */
+#define BUG_ON_OPT_NEG_NOARG(unset, arg) do { \
+	BUG_ON_OPT_NEG(unset); \
+	if(!(arg)) \
+		BUG("option callback expects an argument"); \
+} while(0)
+
 /*----- incremental advanced APIs -----*/
 
 enum {
Signature · 1 line
2.21.0
#1 lore raw
Quoted 5 lines · Brandon Richardson

Rather than parse options manually, which is both difficult to read and error prone, parse options supplied to commit-tree using the parse-options api.

Quoted 8 lines

It was discovered that the --no-gpg-sign option was documented but not implemented in commit 70ddbd7767 (commit-tree: add missing --gpg-sign flag, 2019-01-19), and the existing implementation would attempt to translate the option as a tree oid. It was also suggested earlier in commit 55ca3f99ae (commit-tree: add and document --no-gpg-sign, 2013-12-13) that commit-tree should be migrated to utilize the parse-options api, which could help prevent mistakes like this in the future. Hence this change.

You probably should mention about the extra _() too (e.g. "while at there, mark more strings for translation") just to be clear it's intentional.

builtin/commit-tree.c line 16

Quoted 10 lines
builtin/commit-tree.c +2 -0
index 12cc403bd7..d4a911acf5 100644
@@ -12,8 +12,14 @@
 #include "builtin.h"
 #include "utf8.h"
 #include "gpg-interface.h"
+#include "parse-options.h"
+#include "string-list.h"

Everything looks good, except that I can't find where this string-list.h is needed. Maybe just try to remove it and build to be sure.

Signature · 1 line
Duy
#2 lore raw
Quoted 3 lines · Duy Nguyen

You probably should mention about the extra _() too (e.g. "while at there, mark more strings for translation") just to be clear it's intentional.

Good call. Will update.

Quoted 6 lines

builtin/commit-tree.c line 16

Quoted 2 lines
builtin/commit-tree.c +2 -0
+#include "parse-options.h"
+#include "string-list.h"

Everything looks good, except that I can't find where this string-list.h is needed. Maybe just try to remove it and build to be sure.

You're right, string-list.h was not used. Removed.

Brandon