* [PATCH v4 1/2] format-patch: create leading components of output directory
@ 2019-10-11 8:36 ` Bert Wesarg
2019-10-11 8:36 ` [PATCH v4 2/2] format-patch: configure a command to generate the output directory name Bert Wesarg
2019-10-11 14:46 ` [PATCH v4 1/2] format-patch: create leading components of output directory SZEDER Gábor
0 siblings, 2 replies; 10+ messages in thread
From: Bert Wesarg @ 2019-10-11 8:36 UTC (permalink / raw)
To: git; +Cc: Bert Wesarg, Denton Liu, Junio C Hamano, SZEDER Gábor
'git format-patch -o <outdir>' did an equivalent of 'mkdir <outdir>'
not 'mkdir -p <outdir>', which is being corrected.
Avoid the usage of 'adjust_shared_perm' on the leading directories which
may have security implications. Achieved by temporarily disabling of
'config.sharedRepository' like 'git init' does.
Signed-off-by: Bert Wesarg <bert.wesarg@googlemail.com>
---
Changes in v2:
* squashed and base new tests on 'dl/format-patch-doc-test-cleanup'
Changes in v3:
* avoid applying adjust_shared_perm
Changes in v4:
* based on dl/format-patch-doc-test-cleanup and adopt it
Cc: Denton Liu <liu.denton@gmail.com>
Cc: Junio C Hamano <gitster@pobox.com>
Cc: SZEDER Gábor <szeder.dev@gmail.com>
---
Documentation/config/format.txt | 2 +-
Documentation/git-format-patch.txt | 3 ++-
builtin/log.c | 16 ++++++++++++++++
t/t4014-format-patch.sh | 23 +++++++++++++++++++++++
4 files changed, 42 insertions(+), 2 deletions(-)
diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt
index cb629fa769..40cad9278f 100644
--- a/Documentation/config/format.txt
+++ b/Documentation/config/format.txt
@@ -81,7 +81,7 @@ format.coverLetter::
format.outputDirectory::
Set a custom directory to store the resulting files instead of the
- current working directory.
+ current working directory. All directory components will be created.
format.useAutoBase::
A boolean value which lets you enable the `--base=auto` option of
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 0ac56f4b70..2035d4d5d5 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -66,7 +66,8 @@ they are created in the current working directory. The default path
can be set with the `format.outputDirectory` configuration option.
The `-o` option takes precedence over `format.outputDirectory`.
To store patches in the current working directory even when
-`format.outputDirectory` points elsewhere, use `-o .`.
+`format.outputDirectory` points elsewhere, use `-o .`. All directory
+components will be created.
By default, the subject of a single patch is "[PATCH] " followed by
the concatenation of lines from the commit message up to the first blank
diff --git a/builtin/log.c b/builtin/log.c
index 44b10b3415..8d08632858 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -1765,10 +1765,26 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
setup_pager();
if (output_directory) {
+ int saved;
if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
rev.diffopt.use_color = GIT_COLOR_NEVER;
if (use_stdout)
die(_("standard output, or directory, which one?"));
+ /*
+ * We consider <outdir> as 'outside of gitdir', therefore avoid
+ * applying adjust_shared_perm in s-c-l-d.
+ */
+ saved = get_shared_repository();
+ set_shared_repository(0);
+ switch (safe_create_leading_directories_const(output_directory)) {
+ case SCLD_OK:
+ case SCLD_EXISTS:
+ break;
+ default:
+ die(_("could not create leading directories "
+ "of '%s'"), output_directory);
+ }
+ set_shared_repository(saved);
if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
die_errno(_("could not create directory '%s'"),
output_directory);
diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
index 72b09896cf..9facc3a79e 100755
--- a/t/t4014-format-patch.sh
+++ b/t/t4014-format-patch.sh
@@ -1606,6 +1606,29 @@ test_expect_success 'From line has expected format' '
test_cmp from filtered
'
+test_expect_success 'format-patch -o with no leading directories' '
+ rm -fr patches &&
+ git format-patch -o patches master..side &&
+ count=$(git rev-list --count master..side) &&
+ ls patches >list &&
+ test_line_count = $count list
+'
+
+test_expect_success 'format-patch -o with leading existing directories' '
+ git format-patch -o patches/side master..side &&
+ count=$(git rev-list --count master..side) &&
+ ls patches/side >list &&
+ test_line_count = $count list
+'
+
+test_expect_success 'format-patch -o with leading non-existing directories' '
+ rm -fr patches &&
+ git format-patch -o patches/side master..side &&
+ count=$(git rev-list --count master..side) &&
+ ls patches/side >list &&
+ test_line_count = $count list
+'
+
test_expect_success 'format-patch format.outputDirectory option' '
test_config format.outputDirectory patches &&
rm -fr patches &&
--
2.23.0.13.g28bc381d7c
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH v4 2/2] format-patch: configure a command to generate the output directory name
2019-10-11 8:36 ` [PATCH v4 1/2] format-patch: create leading components of output directory Bert Wesarg
@ 2019-10-11 8:36 ` Bert Wesarg
2019-10-11 14:46 ` [PATCH v4 1/2] format-patch: create leading components of output directory SZEDER Gábor
1 sibling, 0 replies; 10+ messages in thread
From: Bert Wesarg @ 2019-10-11 8:36 UTC (permalink / raw)
To: git
Cc: Bert Wesarg, Alexander Kuleshov, Eric Sunshine, Denton Liu,
Junio C Hamano
The 'format.outputDirectory' configuration is only able to store constant
directory names. Though some may use
$ git format-patch -o $(createdir) …
to name the directory dynamically. Provide a new configuration to be able
to store such a command too.
Signed-off-by: Bert Wesarg <bert.wesarg@googlemail.com>
---
Changes in v2:
* rephrase motivation
Changes in v3:
* remove RFC
Changes in v4:
* based on dl/format-patch-doc-test-cleanup and adopt it
Cc: Alexander Kuleshov <kuleshovmail@gmail.com>
Cc: Eric Sunshine <sunshine@sunshineco.com>
Cc: Denton Liu <liu.denton@gmail.com>
Cc: Junio C Hamano <gitster@pobox.com>
---
Documentation/config/format.txt | 5 +++++
Documentation/git-format-patch.txt | 6 +++++-
builtin/log.c | 24 +++++++++++++++++++++++-
t/t4014-format-patch.sh | 26 ++++++++++++++++++++++++++
4 files changed, 59 insertions(+), 2 deletions(-)
diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt
index 40cad9278f..420188a1c6 100644
--- a/Documentation/config/format.txt
+++ b/Documentation/config/format.txt
@@ -83,6 +83,11 @@ format.outputDirectory::
Set a custom directory to store the resulting files instead of the
current working directory. All directory components will be created.
+format.outputDirectoryCmd::
+ The command which is used to name a custom directory to store the
+ resulting files instead of the current working directory. All directory
+ components will be created.
+
format.useAutoBase::
A boolean value which lets you enable the `--base=auto` option of
format-patch by default.
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 2035d4d5d5..4936b9f91d 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -67,7 +67,11 @@ can be set with the `format.outputDirectory` configuration option.
The `-o` option takes precedence over `format.outputDirectory`.
To store patches in the current working directory even when
`format.outputDirectory` points elsewhere, use `-o .`. All directory
-components will be created.
+components will be created. The 'format.outputDirectoryCmd' configuration can
+be used to name a command to produce the directory name programmatically. The
+command should produce the name to its standard output. The
+`format.outputDirectory` configuration takes precedence over
+`format.outputDirectoryCmd`.
By default, the subject of a single patch is "[PATCH] " followed by
the concatenation of lines from the commit message up to the first blank
diff --git a/builtin/log.c b/builtin/log.c
index 8d08632858..3eb507c02f 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -774,6 +774,7 @@ static const char *signature = git_version_string;
static const char *signature_file;
static int config_cover_letter;
static const char *config_output_directory;
+static const char *config_output_directory_cmd;
enum {
COVER_UNSET,
@@ -856,6 +857,8 @@ static int git_format_config(const char *var, const char *value, void *cb)
}
if (!strcmp(var, "format.outputdirectory"))
return git_config_string(&config_output_directory, var, value);
+ if (!strcmp(var, "format.outputdirectorycmd"))
+ return git_config_string(&config_output_directory_cmd, var, value);
if (!strcmp(var, "format.useautobase")) {
base_auto = git_config_bool(var, value);
return 0;
@@ -1756,8 +1759,27 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
if (rev.show_notes)
init_display_notes(&rev.notes_opt);
- if (!output_directory && !use_stdout)
+ if (!output_directory && !use_stdout) {
+ // outputDirectoryCmd can be preceeded by outputDirectory
+ if (!config_output_directory && config_output_directory_cmd) {
+ struct child_process cp = CHILD_PROCESS_INIT;
+ const char *argv[1];
+ struct strbuf buf = STRBUF_INIT;
+ int rc;
+
+ argv[0] = config_output_directory_cmd;
+ cp.argv = argv;
+ cp.use_shell = 1;
+ rc = capture_command(&cp, &buf, PATH_MAX);
+ if (rc)
+ die(_("outputDirectoryCmd command failed: "
+ "'%s'"), config_output_directory_cmd);
+ strbuf_setlen(&buf, strcspn(buf.buf, "\r\n"));
+ config_output_directory = strbuf_detach(&buf, NULL);
+ }
+
output_directory = config_output_directory;
+ }
if (!use_stdout)
output_directory = set_outdir(prefix, output_directory);
diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
index 9facc3a79e..14c8f5e854 100755
--- a/t/t4014-format-patch.sh
+++ b/t/t4014-format-patch.sh
@@ -1646,6 +1646,32 @@ test_expect_success 'format-patch -o overrides format.outputDirectory' '
test_path_is_dir patchset
'
+test_expect_success 'format-patch format.outputDirectoryCmd option' '
+ test_config format.outputDirectoryCmd "echo patches" &&
+ rm -fr patches &&
+ git format-patch master..side &&
+ count=$(git rev-list --count master..side) &&
+ ls patches >list &&
+ test_line_count = $count list
+'
+
+test_expect_success 'format-patch format.outputDirectory overrides format.outputDirectoryCmd' '
+ test_config format.outputDirectoryCmd "echo patches" &&
+ test_config format.outputDirectory patchset &&
+ rm -fr patches patchset &&
+ git format-patch master..side &&
+ test_path_is_missing patches &&
+ test_path_is_dir patchset
+'
+
+test_expect_success 'format-patch -o overrides format.outputDirectoryCmd' '
+ test_config format.outputDirectoryCmd "echo patches" &&
+ rm -fr patches patchset &&
+ git format-patch -o patchset master..side &&
+ test_path_is_missing patches &&
+ test_path_is_dir patchset
+'
+
test_expect_success 'format-patch --base' '
git checkout patchid &&
--
2.23.0.13.g28bc381d7c
^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [PATCH v4 1/2] format-patch: create leading components of output directory
2019-10-11 8:36 ` [PATCH v4 1/2] format-patch: create leading components of output directory Bert Wesarg
2019-10-11 8:36 ` [PATCH v4 2/2] format-patch: configure a command to generate the output directory name Bert Wesarg
@ 2019-10-11 14:46 ` SZEDER Gábor
2019-10-11 15:45 ` Bert Wesarg
1 sibling, 1 reply; 10+ messages in thread
From: SZEDER Gábor @ 2019-10-11 14:46 UTC (permalink / raw)
To: Bert Wesarg; +Cc: git, Denton Liu, Junio C Hamano
On Fri, Oct 11, 2019 at 10:36:41AM +0200, Bert Wesarg wrote:
> Changes in v4:
> * based on dl/format-patch-doc-test-cleanup and adopt it
Thanks... but here I am nitpicking again, sorry :)
> diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
> index 72b09896cf..9facc3a79e 100755
> --- a/t/t4014-format-patch.sh
> +++ b/t/t4014-format-patch.sh
> @@ -1606,6 +1606,29 @@ test_expect_success 'From line has expected format' '
> test_cmp from filtered
> '
>
> +test_expect_success 'format-patch -o with no leading directories' '
> + rm -fr patches &&
> + git format-patch -o patches master..side &&
> + count=$(git rev-list --count master..side) &&
> + ls patches >list &&
> + test_line_count = $count list
> +'
> +
> +test_expect_success 'format-patch -o with leading existing directories' '
> + git format-patch -o patches/side master..side &&
The previous test case creates the 'patches' directory and leaves it
behind, and this test implicitly relies on that directory to check
that 'format-patch -o' can deal with already existing directories. So
if the previous test case were to fail early or were not run at all
(e.g. './t4014-format-patch.sh -r 1,137'), then that directory
wouldn't exist, and, consequently, this test case would not check what
it was supposed to.
I think it would be better to be more explicit and self-contained
about it, and create a leading directory in this test case:
mkdir existing-dir &&
git format-patch -o existing-dir/side master..size &&
ls existing-dir/side >list &&
> + count=$(git rev-list --count master..side) &&
> + ls patches/side >list &&
> + test_line_count = $count list
> +'
> +
> +test_expect_success 'format-patch -o with leading non-existing directories' '
> + rm -fr patches &&
> + git format-patch -o patches/side master..side &&
> + count=$(git rev-list --count master..side) &&
> + ls patches/side >list &&
> + test_line_count = $count list
> +'
> +
> test_expect_success 'format-patch format.outputDirectory option' '
> test_config format.outputDirectory patches &&
> rm -fr patches &&
> --
> 2.23.0.13.g28bc381d7c
>
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH v4 1/2] format-patch: create leading components of output directory
2019-10-11 14:46 ` [PATCH v4 1/2] format-patch: create leading components of output directory SZEDER Gábor
@ 2019-10-11 15:45 ` Bert Wesarg
2019-10-11 15:47 ` Bert Wesarg
0 siblings, 1 reply; 10+ messages in thread
From: Bert Wesarg @ 2019-10-11 15:45 UTC (permalink / raw)
To: SZEDER Gábor; +Cc: Git Mailing List, Denton Liu, Junio C Hamano
On Fri, Oct 11, 2019 at 4:46 PM SZEDER Gábor <szeder.dev@gmail.com> wrote:
>
> On Fri, Oct 11, 2019 at 10:36:41AM +0200, Bert Wesarg wrote:
> > Changes in v4:
> > * based on dl/format-patch-doc-test-cleanup and adopt it
>
> Thanks... but here I am nitpicking again, sorry :)
>
> > diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
> > index 72b09896cf..9facc3a79e 100755
> > --- a/t/t4014-format-patch.sh
> > +++ b/t/t4014-format-patch.sh
> > @@ -1606,6 +1606,29 @@ test_expect_success 'From line has expected format' '
> > test_cmp from filtered
> > '
> >
> > +test_expect_success 'format-patch -o with no leading directories' '
> > + rm -fr patches &&
> > + git format-patch -o patches master..side &&
> > + count=$(git rev-list --count master..side) &&
> > + ls patches >list &&
> > + test_line_count = $count list
> > +'
> > +
> > +test_expect_success 'format-patch -o with leading existing directories' '
> > + git format-patch -o patches/side master..side &&
>
> The previous test case creates the 'patches' directory and leaves it
> behind, and this test implicitly relies on that directory to check
> that 'format-patch -o' can deal with already existing directories. So
> if the previous test case were to fail early or were not run at all
> (e.g. './t4014-format-patch.sh -r 1,137'), then that directory
> wouldn't exist, and, consequently, this test case would not check what
> it was supposed to.
>
> I think it would be better to be more explicit and self-contained
> about it, and create a leading directory in this test case:
>
> mkdir existing-dir &&
> git format-patch -o existing-dir/side master..size &&
> ls existing-dir/side >list &&
>
thanks. Your nitpicking is always appreciated.
Bert
> > + count=$(git rev-list --count master..side) &&
> > + ls patches/side >list &&
> > + test_line_count = $count list
> > +'
> > +
> > +test_expect_success 'format-patch -o with leading non-existing directories' '
> > + rm -fr patches &&
> > + git format-patch -o patches/side master..side &&
> > + count=$(git rev-list --count master..side) &&
> > + ls patches/side >list &&
> > + test_line_count = $count list
> > +'
> > +
> > test_expect_success 'format-patch format.outputDirectory option' '
> > test_config format.outputDirectory patches &&
> > rm -fr patches &&
> > --
> > 2.23.0.13.g28bc381d7c
> >
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH v4 1/2] format-patch: create leading components of output directory
2019-10-11 15:45 ` Bert Wesarg
@ 2019-10-11 15:47 ` Bert Wesarg
2019-10-11 16:17 ` SZEDER Gábor
0 siblings, 1 reply; 10+ messages in thread
From: Bert Wesarg @ 2019-10-11 15:47 UTC (permalink / raw)
To: SZEDER Gábor; +Cc: Git Mailing List, Denton Liu, Junio C Hamano
On Fri, Oct 11, 2019 at 5:45 PM Bert Wesarg <bert.wesarg@googlemail.com> wrote:
>
> On Fri, Oct 11, 2019 at 4:46 PM SZEDER Gábor <szeder.dev@gmail.com> wrote:
> >
> > On Fri, Oct 11, 2019 at 10:36:41AM +0200, Bert Wesarg wrote:
> > > Changes in v4:
> > > * based on dl/format-patch-doc-test-cleanup and adopt it
> >
> > Thanks... but here I am nitpicking again, sorry :)
> >
> > > diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
> > > index 72b09896cf..9facc3a79e 100755
> > > --- a/t/t4014-format-patch.sh
> > > +++ b/t/t4014-format-patch.sh
> > > @@ -1606,6 +1606,29 @@ test_expect_success 'From line has expected format' '
> > > test_cmp from filtered
> > > '
> > >
> > > +test_expect_success 'format-patch -o with no leading directories' '
> > > + rm -fr patches &&
> > > + git format-patch -o patches master..side &&
> > > + count=$(git rev-list --count master..side) &&
> > > + ls patches >list &&
> > > + test_line_count = $count list
> > > +'
> > > +
> > > +test_expect_success 'format-patch -o with leading existing directories' '
> > > + git format-patch -o patches/side master..side &&
> >
> > The previous test case creates the 'patches' directory and leaves it
> > behind, and this test implicitly relies on that directory to check
> > that 'format-patch -o' can deal with already existing directories. So
> > if the previous test case were to fail early or were not run at all
> > (e.g. './t4014-format-patch.sh -r 1,137'), then that directory
> > wouldn't exist, and, consequently, this test case would not check what
> > it was supposed to.
> >
> > I think it would be better to be more explicit and self-contained
> > about it, and create a leading directory in this test case:
> >
> > mkdir existing-dir &&
> > git format-patch -o existing-dir/side master..size &&
> > ls existing-dir/side >list &&
one question: How about removing this directory first, just to be
sure, that mkdir does create a directory?
Bert
> >
>
> thanks. Your nitpicking is always appreciated.
>
> Bert
>
> > > + count=$(git rev-list --count master..side) &&
> > > + ls patches/side >list &&
> > > + test_line_count = $count list
> > > +'
> > > +
> > > +test_expect_success 'format-patch -o with leading non-existing directories' '
> > > + rm -fr patches &&
> > > + git format-patch -o patches/side master..side &&
> > > + count=$(git rev-list --count master..side) &&
> > > + ls patches/side >list &&
> > > + test_line_count = $count list
> > > +'
> > > +
> > > test_expect_success 'format-patch format.outputDirectory option' '
> > > test_config format.outputDirectory patches &&
> > > rm -fr patches &&
> > > --
> > > 2.23.0.13.g28bc381d7c
> > >
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH v4 1/2] format-patch: create leading components of output directory
2019-10-11 15:47 ` Bert Wesarg
@ 2019-10-11 16:17 ` SZEDER Gábor
0 siblings, 0 replies; 10+ messages in thread
From: SZEDER Gábor @ 2019-10-11 16:17 UTC (permalink / raw)
To: Bert Wesarg; +Cc: Git Mailing List, Denton Liu, Junio C Hamano
On Fri, Oct 11, 2019 at 05:47:44PM +0200, Bert Wesarg wrote:
> > > > +test_expect_success 'format-patch -o with no leading directories' '
> > > > + rm -fr patches &&
> > > > + git format-patch -o patches master..side &&
> > > > + count=$(git rev-list --count master..side) &&
> > > > + ls patches >list &&
> > > > + test_line_count = $count list
> > > > +'
> > > > +
> > > > +test_expect_success 'format-patch -o with leading existing directories' '
> > > > + git format-patch -o patches/side master..side &&
> > >
> > > The previous test case creates the 'patches' directory and leaves it
> > > behind, and this test implicitly relies on that directory to check
> > > that 'format-patch -o' can deal with already existing directories. So
> > > if the previous test case were to fail early or were not run at all
> > > (e.g. './t4014-format-patch.sh -r 1,137'), then that directory
> > > wouldn't exist, and, consequently, this test case would not check what
> > > it was supposed to.
> > >
> > > I think it would be better to be more explicit and self-contained
> > > about it, and create a leading directory in this test case:
> > >
> > > mkdir existing-dir &&
> > > git format-patch -o existing-dir/side master..size &&
> > > ls existing-dir/side >list &&
>
> one question: How about removing this directory first, just to be
> sure, that mkdir does create a directory?
I'm not sure I understand...
Do you mean that a previous test might have already created and left a
directory with the same name behind, and then this 'mkdir' would error
out and thus fail the test? If yes, then you're right with your
nitpicking on my nitpicking ;) Though instead of 'rm -rf'ing that
directory I would suggest 'mkdir -p' to simply ignore it if it were to
exist.
^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH v5 1/2] format-patch: create leading components of output directory
@ 2019-10-21 10:25 ` Bert Wesarg
2019-10-21 10:25 ` [PATCH v5 2/2] format-patch: configure a command to generate the output directory name Bert Wesarg
2019-10-21 13:20 ` [PATCH v5 1/2] format-patch: create leading components of output directory Bert Wesarg
0 siblings, 2 replies; 10+ messages in thread
From: Bert Wesarg @ 2019-10-21 10:25 UTC (permalink / raw)
To: git; +Cc: Bert Wesarg, Denton Liu, Junio C Hamano, SZEDER Gábor
'git format-patch -o <outdir>' did an equivalent of 'mkdir <outdir>'
not 'mkdir -p <outdir>', which is being corrected.
Avoid the usage of 'adjust_shared_perm' on the leading directories which
may have security implications. Achieved by temporarily disabling of
'config.sharedRepository' like 'git init' does.
Signed-off-by: Bert Wesarg <bert.wesarg@googlemail.com>
---
Changes in v2:
* squashed and base new tests on 'dl/format-patch-doc-test-cleanup'
Changes in v3:
* avoid applying adjust_shared_perm
Changes in v4:
* based on dl/format-patch-doc-test-cleanup and adopt it
Changes in v5:
* make tests self-contained
Cc: Denton Liu <liu.denton@gmail.com>
Cc: Junio C Hamano <gitster@pobox.com>
Cc: SZEDER Gábor <szeder.dev@gmail.com>
---
Documentation/config/format.txt | 2 +-
Documentation/git-format-patch.txt | 3 ++-
builtin/log.c | 16 ++++++++++++++++
t/t4014-format-patch.sh | 26 ++++++++++++++++++++++++++
4 files changed, 45 insertions(+), 2 deletions(-)
diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt
index cb629fa769..40cad9278f 100644
--- a/Documentation/config/format.txt
+++ b/Documentation/config/format.txt
@@ -81,7 +81,7 @@ format.coverLetter::
format.outputDirectory::
Set a custom directory to store the resulting files instead of the
- current working directory.
+ current working directory. All directory components will be created.
format.useAutoBase::
A boolean value which lets you enable the `--base=auto` option of
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 0ac56f4b70..2035d4d5d5 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -66,7 +66,8 @@ they are created in the current working directory. The default path
can be set with the `format.outputDirectory` configuration option.
The `-o` option takes precedence over `format.outputDirectory`.
To store patches in the current working directory even when
-`format.outputDirectory` points elsewhere, use `-o .`.
+`format.outputDirectory` points elsewhere, use `-o .`. All directory
+components will be created.
By default, the subject of a single patch is "[PATCH] " followed by
the concatenation of lines from the commit message up to the first blank
diff --git a/builtin/log.c b/builtin/log.c
index 44b10b3415..8d08632858 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -1765,10 +1765,26 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
setup_pager();
if (output_directory) {
+ int saved;
if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
rev.diffopt.use_color = GIT_COLOR_NEVER;
if (use_stdout)
die(_("standard output, or directory, which one?"));
+ /*
+ * We consider <outdir> as 'outside of gitdir', therefore avoid
+ * applying adjust_shared_perm in s-c-l-d.
+ */
+ saved = get_shared_repository();
+ set_shared_repository(0);
+ switch (safe_create_leading_directories_const(output_directory)) {
+ case SCLD_OK:
+ case SCLD_EXISTS:
+ break;
+ default:
+ die(_("could not create leading directories "
+ "of '%s'"), output_directory);
+ }
+ set_shared_repository(saved);
if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
die_errno(_("could not create directory '%s'"),
output_directory);
diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
index 72b09896cf..3aab25da76 100755
--- a/t/t4014-format-patch.sh
+++ b/t/t4014-format-patch.sh
@@ -1606,6 +1606,32 @@ test_expect_success 'From line has expected format' '
test_cmp from filtered
'
+test_expect_success 'format-patch -o with no leading directories' '
+ rm -fr patches &&
+ git format-patch -o patches master..side &&
+ count=$(git rev-list --count master..side) &&
+ ls patches >list &&
+ test_line_count = $count list
+'
+
+test_expect_success 'format-patch -o with leading existing directories' '
+ rm -rf existing-dir &&
+ mkdir existing-dir &&
+ git format-patch -o existing-dir/patches master..side &&
+ count=$(git rev-list --count master..side) &&
+ ls existing-dir/patches >list &&
+ test_line_count = $count list
+'
+
+test_expect_success 'format-patch -o with leading non-existing directories' '
+ rm -rf non-existing-dir &&
+ git format-patch -o non-existing-dir/patches master..side &&
+ count=$(git rev-list --count master..side) &&
+ test_path_is_dir non-existing-dir
+ ls non-existing-dir/patches >list &&
+ test_line_count = $count list
+'
+
test_expect_success 'format-patch format.outputDirectory option' '
test_config format.outputDirectory patches &&
rm -fr patches &&
--
2.23.0.13.g28bc381d7c
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH v5 2/2] format-patch: configure a command to generate the output directory name
2019-10-21 10:25 ` [PATCH v5 " Bert Wesarg
@ 2019-10-21 10:25 ` Bert Wesarg
2019-10-21 13:20 ` [PATCH v5 1/2] format-patch: create leading components of output directory Bert Wesarg
1 sibling, 0 replies; 10+ messages in thread
From: Bert Wesarg @ 2019-10-21 10:25 UTC (permalink / raw)
To: git
Cc: Bert Wesarg, Alexander Kuleshov, Eric Sunshine, Denton Liu,
Junio C Hamano
The 'format.outputDirectory' configuration is only able to store constant
directory names. Though some may use
$ git format-patch -o $(createdir) …
to name the directory dynamically. Provide a new configuration to be able
to store such a command too.
Signed-off-by: Bert Wesarg <bert.wesarg@googlemail.com>
---
Changes in v2:
* rephrase motivation
Changes in v3:
* remove RFC
Changes in v4:
* based on dl/format-patch-doc-test-cleanup and adopt it
Changes in v5:
* none
Cc: Alexander Kuleshov <kuleshovmail@gmail.com>
Cc: Eric Sunshine <sunshine@sunshineco.com>
Cc: Denton Liu <liu.denton@gmail.com>
Cc: Junio C Hamano <gitster@pobox.com>
---
Documentation/config/format.txt | 5 +++++
Documentation/git-format-patch.txt | 6 +++++-
builtin/log.c | 24 +++++++++++++++++++++++-
t/t4014-format-patch.sh | 26 ++++++++++++++++++++++++++
4 files changed, 59 insertions(+), 2 deletions(-)
diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt
index 40cad9278f..420188a1c6 100644
--- a/Documentation/config/format.txt
+++ b/Documentation/config/format.txt
@@ -83,6 +83,11 @@ format.outputDirectory::
Set a custom directory to store the resulting files instead of the
current working directory. All directory components will be created.
+format.outputDirectoryCmd::
+ The command which is used to name a custom directory to store the
+ resulting files instead of the current working directory. All directory
+ components will be created.
+
format.useAutoBase::
A boolean value which lets you enable the `--base=auto` option of
format-patch by default.
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 2035d4d5d5..4936b9f91d 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -67,7 +67,11 @@ can be set with the `format.outputDirectory` configuration option.
The `-o` option takes precedence over `format.outputDirectory`.
To store patches in the current working directory even when
`format.outputDirectory` points elsewhere, use `-o .`. All directory
-components will be created.
+components will be created. The 'format.outputDirectoryCmd' configuration can
+be used to name a command to produce the directory name programmatically. The
+command should produce the name to its standard output. The
+`format.outputDirectory` configuration takes precedence over
+`format.outputDirectoryCmd`.
By default, the subject of a single patch is "[PATCH] " followed by
the concatenation of lines from the commit message up to the first blank
diff --git a/builtin/log.c b/builtin/log.c
index 8d08632858..3eb507c02f 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -774,6 +774,7 @@ static const char *signature = git_version_string;
static const char *signature_file;
static int config_cover_letter;
static const char *config_output_directory;
+static const char *config_output_directory_cmd;
enum {
COVER_UNSET,
@@ -856,6 +857,8 @@ static int git_format_config(const char *var, const char *value, void *cb)
}
if (!strcmp(var, "format.outputdirectory"))
return git_config_string(&config_output_directory, var, value);
+ if (!strcmp(var, "format.outputdirectorycmd"))
+ return git_config_string(&config_output_directory_cmd, var, value);
if (!strcmp(var, "format.useautobase")) {
base_auto = git_config_bool(var, value);
return 0;
@@ -1756,8 +1759,27 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
if (rev.show_notes)
init_display_notes(&rev.notes_opt);
- if (!output_directory && !use_stdout)
+ if (!output_directory && !use_stdout) {
+ // outputDirectoryCmd can be preceeded by outputDirectory
+ if (!config_output_directory && config_output_directory_cmd) {
+ struct child_process cp = CHILD_PROCESS_INIT;
+ const char *argv[1];
+ struct strbuf buf = STRBUF_INIT;
+ int rc;
+
+ argv[0] = config_output_directory_cmd;
+ cp.argv = argv;
+ cp.use_shell = 1;
+ rc = capture_command(&cp, &buf, PATH_MAX);
+ if (rc)
+ die(_("outputDirectoryCmd command failed: "
+ "'%s'"), config_output_directory_cmd);
+ strbuf_setlen(&buf, strcspn(buf.buf, "\r\n"));
+ config_output_directory = strbuf_detach(&buf, NULL);
+ }
+
output_directory = config_output_directory;
+ }
if (!use_stdout)
output_directory = set_outdir(prefix, output_directory);
diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
index 3aab25da76..725706ded5 100755
--- a/t/t4014-format-patch.sh
+++ b/t/t4014-format-patch.sh
@@ -1649,6 +1649,32 @@ test_expect_success 'format-patch -o overrides format.outputDirectory' '
test_path_is_dir patchset
'
+test_expect_success 'format-patch format.outputDirectoryCmd option' '
+ test_config format.outputDirectoryCmd "echo patches" &&
+ rm -fr patches &&
+ git format-patch master..side &&
+ count=$(git rev-list --count master..side) &&
+ ls patches >list &&
+ test_line_count = $count list
+'
+
+test_expect_success 'format-patch format.outputDirectory overrides format.outputDirectoryCmd' '
+ test_config format.outputDirectoryCmd "echo patches" &&
+ test_config format.outputDirectory patchset &&
+ rm -fr patches patchset &&
+ git format-patch master..side &&
+ test_path_is_missing patches &&
+ test_path_is_dir patchset
+'
+
+test_expect_success 'format-patch -o overrides format.outputDirectoryCmd' '
+ test_config format.outputDirectoryCmd "echo patches" &&
+ rm -fr patches patchset &&
+ git format-patch -o patchset master..side &&
+ test_path_is_missing patches &&
+ test_path_is_dir patchset
+'
+
test_expect_success 'format-patch --base' '
git checkout patchid &&
--
2.23.0.13.g28bc381d7c
^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [PATCH v5 1/2] format-patch: create leading components of output directory
2019-10-21 10:25 ` [PATCH v5 " Bert Wesarg
2019-10-21 10:25 ` [PATCH v5 2/2] format-patch: configure a command to generate the output directory name Bert Wesarg
@ 2019-10-21 13:20 ` Bert Wesarg
2019-10-23 2:08 ` Junio C Hamano
1 sibling, 1 reply; 10+ messages in thread
From: Bert Wesarg @ 2019-10-21 13:20 UTC (permalink / raw)
To: Junio C Hamano; +Cc: Denton Liu, SZEDER Gábor, Git Mailing List
Please ignore this. Will rebase on 2.24-rc0 and will only include the
test changes.
Bert
On Mon, Oct 21, 2019 at 12:25 PM Bert Wesarg <bert.wesarg@googlemail.com> wrote:
>
> 'git format-patch -o <outdir>' did an equivalent of 'mkdir <outdir>'
> not 'mkdir -p <outdir>', which is being corrected.
>
> Avoid the usage of 'adjust_shared_perm' on the leading directories which
> may have security implications. Achieved by temporarily disabling of
> 'config.sharedRepository' like 'git init' does.
>
> Signed-off-by: Bert Wesarg <bert.wesarg@googlemail.com>
>
> ---
> Changes in v2:
> * squashed and base new tests on 'dl/format-patch-doc-test-cleanup'
>
> Changes in v3:
> * avoid applying adjust_shared_perm
>
> Changes in v4:
> * based on dl/format-patch-doc-test-cleanup and adopt it
>
> Changes in v5:
> * make tests self-contained
>
> Cc: Denton Liu <liu.denton@gmail.com>
> Cc: Junio C Hamano <gitster@pobox.com>
> Cc: SZEDER Gábor <szeder.dev@gmail.com>
> ---
> Documentation/config/format.txt | 2 +-
> Documentation/git-format-patch.txt | 3 ++-
> builtin/log.c | 16 ++++++++++++++++
> t/t4014-format-patch.sh | 26 ++++++++++++++++++++++++++
> 4 files changed, 45 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt
> index cb629fa769..40cad9278f 100644
> --- a/Documentation/config/format.txt
> +++ b/Documentation/config/format.txt
> @@ -81,7 +81,7 @@ format.coverLetter::
>
> format.outputDirectory::
> Set a custom directory to store the resulting files instead of the
> - current working directory.
> + current working directory. All directory components will be created.
>
> format.useAutoBase::
> A boolean value which lets you enable the `--base=auto` option of
> diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
> index 0ac56f4b70..2035d4d5d5 100644
> --- a/Documentation/git-format-patch.txt
> +++ b/Documentation/git-format-patch.txt
> @@ -66,7 +66,8 @@ they are created in the current working directory. The default path
> can be set with the `format.outputDirectory` configuration option.
> The `-o` option takes precedence over `format.outputDirectory`.
> To store patches in the current working directory even when
> -`format.outputDirectory` points elsewhere, use `-o .`.
> +`format.outputDirectory` points elsewhere, use `-o .`. All directory
> +components will be created.
>
> By default, the subject of a single patch is "[PATCH] " followed by
> the concatenation of lines from the commit message up to the first blank
> diff --git a/builtin/log.c b/builtin/log.c
> index 44b10b3415..8d08632858 100644
> --- a/builtin/log.c
> +++ b/builtin/log.c
> @@ -1765,10 +1765,26 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
> setup_pager();
>
> if (output_directory) {
> + int saved;
> if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
> rev.diffopt.use_color = GIT_COLOR_NEVER;
> if (use_stdout)
> die(_("standard output, or directory, which one?"));
> + /*
> + * We consider <outdir> as 'outside of gitdir', therefore avoid
> + * applying adjust_shared_perm in s-c-l-d.
> + */
> + saved = get_shared_repository();
> + set_shared_repository(0);
> + switch (safe_create_leading_directories_const(output_directory)) {
> + case SCLD_OK:
> + case SCLD_EXISTS:
> + break;
> + default:
> + die(_("could not create leading directories "
> + "of '%s'"), output_directory);
> + }
> + set_shared_repository(saved);
> if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
> die_errno(_("could not create directory '%s'"),
> output_directory);
> diff --git a/t/t4014-format-patch.sh b/t/t4014-format-patch.sh
> index 72b09896cf..3aab25da76 100755
> --- a/t/t4014-format-patch.sh
> +++ b/t/t4014-format-patch.sh
> @@ -1606,6 +1606,32 @@ test_expect_success 'From line has expected format' '
> test_cmp from filtered
> '
>
> +test_expect_success 'format-patch -o with no leading directories' '
> + rm -fr patches &&
> + git format-patch -o patches master..side &&
> + count=$(git rev-list --count master..side) &&
> + ls patches >list &&
> + test_line_count = $count list
> +'
> +
> +test_expect_success 'format-patch -o with leading existing directories' '
> + rm -rf existing-dir &&
> + mkdir existing-dir &&
> + git format-patch -o existing-dir/patches master..side &&
> + count=$(git rev-list --count master..side) &&
> + ls existing-dir/patches >list &&
> + test_line_count = $count list
> +'
> +
> +test_expect_success 'format-patch -o with leading non-existing directories' '
> + rm -rf non-existing-dir &&
> + git format-patch -o non-existing-dir/patches master..side &&
> + count=$(git rev-list --count master..side) &&
> + test_path_is_dir non-existing-dir
> + ls non-existing-dir/patches >list &&
> + test_line_count = $count list
> +'
> +
> test_expect_success 'format-patch format.outputDirectory option' '
> test_config format.outputDirectory patches &&
> rm -fr patches &&
> --
> 2.23.0.13.g28bc381d7c
>
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH v5 1/2] format-patch: create leading components of output directory
2019-10-21 13:20 ` [PATCH v5 1/2] format-patch: create leading components of output directory Bert Wesarg
@ 2019-10-23 2:08 ` Junio C Hamano
0 siblings, 0 replies; 10+ messages in thread
From: Junio C Hamano @ 2019-10-23 2:08 UTC (permalink / raw)
To: Bert Wesarg; +Cc: Denton Liu, SZEDER Gábor, Git Mailing List
Bert Wesarg <bert.wesarg@googlemail.com> writes:
> Please ignore this. Will rebase on 2.24-rc0 and will only include the
> test changes.
Thanks.
^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2019-10-23 2:08 UTC | newest]
Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <30278644805925935d05ae877c4b14843e37e40c.1570469582.git.bert.wesarg@googlemail.com>
2019-10-11 8:36 ` [PATCH v4 1/2] format-patch: create leading components of output directory Bert Wesarg
2019-10-11 8:36 ` [PATCH v4 2/2] format-patch: configure a command to generate the output directory name Bert Wesarg
2019-10-11 14:46 ` [PATCH v4 1/2] format-patch: create leading components of output directory SZEDER Gábor
2019-10-11 15:45 ` Bert Wesarg
2019-10-11 15:47 ` Bert Wesarg
2019-10-11 16:17 ` SZEDER Gábor
2019-10-21 10:25 ` [PATCH v5 " Bert Wesarg
2019-10-21 10:25 ` [PATCH v5 2/2] format-patch: configure a command to generate the output directory name Bert Wesarg
2019-10-21 13:20 ` [PATCH v5 1/2] format-patch: create leading components of output directory Bert Wesarg
2019-10-23 2:08 ` Junio C Hamano
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).