# [PATCH 1/3] format-patch: document and exercise that -o does only create the trailing directory 7 messages from 2019-10-02 to 2019-10-03. Participants: Bert Wesarg, Denton Liu, Junio C Hamano. Thread: https://gitlist.dev/t/51960 ## Bert Wesarg, 2019-10-02 21:26 Subject: [PATCH 1/3] format-patch: document and exercise that -o does only create the trailing directory Message-ID: <1aeacd8af4b83142f160c63be4746554e823cfc3.1570051490.git.bert.wesarg@googlemail.com> URL: https://gitlist.dev/e/1aeacd8af4b83142f160c63be4746554e823cfc3.1570051490.git.bert.wesarg%40googlemail.com ``` Signed-off-by: Bert Wesarg --- Documentation/config/format.txt | 3 ++- Documentation/git-format-patch.txt | 4 +++- t/t4014-format-patch.sh | 16 ++++++++++++++++ 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt index 414a5a8a9d..e17c5d6b0f 100644 --- a/Documentation/config/format.txt +++ b/Documentation/config/format.txt @@ -80,7 +80,8 @@ format.coverLetter:: format.outputDirectory:: Set a custom directory to store the resulting files instead of the - current working directory. + current working directory. Only the trailing directory will be created + though. 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 b9b97e63ae..fe7492353e 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -66,7 +66,9 @@ 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 .`. Note that only +the trailing directory will be created by Git, leading directories must +already exists. 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/t/t4014-format-patch.sh b/t/t4014-format-patch.sh index ca7debf1d4..bf2715a503 100755 --- a/t/t4014-format-patch.sh +++ b/t/t4014-format-patch.sh @@ -1632,6 +1632,22 @@ 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 && + test $(git rev-list master..side | wc -l) -eq $(ls patches | wc -l) +' + +test_expect_success 'format-patch -o with leading existing directories' ' + git format-patch -o patches/side master..side && + test $(git rev-list master..side | wc -l) -eq $(ls patches/side | wc -l) +' + +test_expect_failure 'format-patch -o with leading non-existing directories' ' + rm -fr patches && + git format-patch -o patches/side master..side +' + test_expect_success 'format-patch format.outputDirectory option' ' test_config format.outputDirectory patches && rm -fr patches && -- 2.23.0.11.g242cf7f110 ``` ## Bert Wesarg, 2019-10-02 21:26 Subject: [PATCH 2/3] format-patch: create output directory including leading components Message-ID: URL: https://gitlist.dev/e/d959e78af1cb7ef49bca970643b2136c436cd57d.1570051490.git.bert.wesarg%40googlemail.com In-Reply-To: <1aeacd8af4b83142f160c63be4746554e823cfc3.1570051490.git.bert.wesarg@googlemail.com> ``` Signed-off-by: Bert Wesarg --- Documentation/config/format.txt | 3 +-- Documentation/git-format-patch.txt | 5 ++--- builtin/log.c | 8 ++++++++ t/t4014-format-patch.sh | 5 +++-- 4 files changed, 14 insertions(+), 7 deletions(-) diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt index e17c5d6b0f..b6c96ece04 100644 --- a/Documentation/config/format.txt +++ b/Documentation/config/format.txt @@ -80,8 +80,7 @@ format.coverLetter:: format.outputDirectory:: Set a custom directory to store the resulting files instead of the - current working directory. Only the trailing directory will be created - though. + 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 fe7492353e..f418f490aa 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -66,9 +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 .`. Note that only -the trailing directory will be created by Git, leading directories must -already exists. +`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..1ab9eb6b78 100644 --- a/builtin/log.c +++ b/builtin/log.c @@ -1769,6 +1769,14 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix) rev.diffopt.use_color = GIT_COLOR_NEVER; if (use_stdout) die(_("standard output, or directory, which one?")); + 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); + } 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 bf2715a503..43d608aa94 100755 --- a/t/t4014-format-patch.sh +++ b/t/t4014-format-patch.sh @@ -1643,9 +1643,10 @@ test_expect_success 'format-patch -o with leading existing directories' ' test $(git rev-list master..side | wc -l) -eq $(ls patches/side | wc -l) ' -test_expect_failure 'format-patch -o with leading non-existing directories' ' +test_expect_success 'format-patch -o with leading non-existing directories' ' rm -fr patches && - git format-patch -o patches/side master..side + git format-patch -o patches/side master..side && + test $(git rev-list master..side | wc -l) -eq $(ls patches/side | wc -l) ' test_expect_success 'format-patch format.outputDirectory option' ' -- 2.23.0.11.g242cf7f110 ``` ## Bert Wesarg, 2019-10-02 21:26 Subject: [RFC PATCH 3/3] format-patch: use a command to generate the output directory name Message-ID: <431f8a4e372feccf240b9c66c91248a6f53eab47.1570051490.git.bert.wesarg@googlemail.com> URL: https://gitlist.dev/e/431f8a4e372feccf240b9c66c91248a6f53eab47.1570051490.git.bert.wesarg%40googlemail.com In-Reply-To: <1aeacd8af4b83142f160c63be4746554e823cfc3.1570051490.git.bert.wesarg@googlemail.com> ``` Having 'format.outputDirectory' is convenient, but being able to process all produced patches via a wildcard command is even more so. I.e., using an argument like '/*'. Neither '-o' nor 'format.outputDirectory' can be parameterized to produce a new unique directory. Thus provide the new 'format.outputDirectoryCmd' configuration to specify a command which does the job and puts the name to standard output. Signed-off-by: Bert Wesarg --- Cc: Alexander Kuleshov Cc: Eric Sunshine --- Documentation/config/format.txt | 5 +++++ Documentation/git-format-patch.txt | 6 +++++- builtin/log.c | 24 +++++++++++++++++++++++- t/t4014-format-patch.sh | 24 ++++++++++++++++++++++++ 4 files changed, 57 insertions(+), 2 deletions(-) diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt index b6c96ece04..dcce2c67ef 100644 --- a/Documentation/config/format.txt +++ b/Documentation/config/format.txt @@ -82,6 +82,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 f418f490aa..0da904255b 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 1ab9eb6b78..b102e86bea 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 43d608aa94..bf2547ce87 100755 --- a/t/t4014-format-patch.sh +++ b/t/t4014-format-patch.sh @@ -1664,6 +1664,30 @@ 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 && + test $(git rev-list master..side | wc -l) -eq $(ls patches | wc -l) +' + +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 && git format-patch --stdout --base=HEAD~3 -1 | tail -n 7 >actual1 && -- 2.23.0.11.g242cf7f110 ``` ## Denton Liu, 2019-10-02 21:47 Subject: Re: [PATCH 1/3] format-patch: document and exercise that -o does only create the trailing directory Message-ID: <20191002214709.GA51809@generichostname> URL: https://gitlist.dev/e/20191002214709.GA51809%40generichostname In-Reply-To: <1aeacd8af4b83142f160c63be4746554e823cfc3.1570051490.git.bert.wesarg@googlemail.com> ``` Hi Bert, > Subject: format-patch: document and exercise that -o does only create the trailing directory s/does only create/only creates/ ? Anyway, as a prepatory patch, I don't think that it's necessary. Maybe it's just me but I assume that most tools create at most one directory deep. Even mkdir won't created nested dirs unless you pass `-p`. I dunno. On Wed, Oct 02, 2019 at 11:26:11PM +0200, Bert Wesarg wrote: > Signed-off-by: Bert Wesarg > --- > Documentation/config/format.txt | 3 ++- > Documentation/git-format-patch.txt | 4 +++- > t/t4014-format-patch.sh | 16 ++++++++++++++++ > 3 files changed, 21 insertions(+), 2 deletions(-) > > diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt > index 414a5a8a9d..e17c5d6b0f 100644 > --- a/Documentation/config/format.txt > +++ b/Documentation/config/format.txt > @@ -80,7 +80,8 @@ format.coverLetter:: > > format.outputDirectory:: > Set a custom directory to store the resulting files instead of the > - current working directory. > + current working directory. Only the trailing directory will be created > + though. > > 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 b9b97e63ae..fe7492353e 100644 > --- a/Documentation/git-format-patch.txt > +++ b/Documentation/git-format-patch.txt > @@ -66,7 +66,9 @@ 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 .`. Note that only > +the trailing directory will be created by Git, leading directories must > +already exists. > > 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/t/t4014-format-patch.sh b/t/t4014-format-patch.sh > index ca7debf1d4..bf2715a503 100755 > --- a/t/t4014-format-patch.sh > +++ b/t/t4014-format-patch.sh > @@ -1632,6 +1632,22 @@ 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 && > + test $(git rev-list master..side | wc -l) -eq $(ls patches | wc -l) For test case you write, please use the following pattern: git rev-list master..side >list && test_line_count = $(ls patches | wc -l) list The first benefit is that we get to take advantage of the test_line_count function that's already written for us. The second is that when we write tests, we shouldn't put Git commands in the upstream of a pipe because if they fail, their return codes will be lost and we won't be able to fail the test properly. > +' > + > +test_expect_success 'format-patch -o with leading existing directories' ' > + git format-patch -o patches/side master..side && > + test $(git rev-list master..side | wc -l) -eq $(ls patches/side | wc -l) > +' > + > +test_expect_failure 'format-patch -o with leading non-existing directories' ' > + rm -fr patches && > + git format-patch -o patches/side master..side > +' As above, I wouldn't really call this a bug in Git. I think we should leave this test case off until the next patch. > + > test_expect_success 'format-patch format.outputDirectory option' ' > test_config format.outputDirectory patches && > rm -fr patches && > -- > 2.23.0.11.g242cf7f110 > ``` ## Junio C Hamano, 2019-10-03 00:54 Subject: Re: [PATCH 2/3] format-patch: create output directory including leading components Message-ID: URL: https://gitlist.dev/e/xmqqimp6d4xv.fsf%40gitster-ct.c.googlers.com In-Reply-To: ``` Bert Wesarg writes: > Signed-off-by: Bert Wesarg > --- Squash these two into a single step. If "-o " forgets to create necessary leading directories, it is just a bug. Thanks. ``` ## Junio C Hamano, 2019-10-03 00:57 Subject: Re: [RFC PATCH 3/3] format-patch: use a command to generate the output directory name Message-ID: URL: https://gitlist.dev/e/xmqqeezud4ss.fsf%40gitster-ct.c.googlers.com In-Reply-To: <431f8a4e372feccf240b9c66c91248a6f53eab47.1570051490.git.bert.wesarg@googlemail.com> ``` Bert Wesarg writes: > Having 'format.outputDirectory' is convenient, but being able to process > all produced patches via a wildcard command is even more so. I.e., > using an argument like '/*'. Neither '-o' nor > 'format.outputDirectory' can be parameterized to produce a new unique > directory. Thus provide the new 'format.outputDirectoryCmd' configuration > to specify a command which does the job and puts the name to standard > output. > The above does not interest me (a reader) enough, without the log message explaining why git format-patch -o "$(outdircmd)" is not sufficient. Thanks. ``` ## Bert Wesarg, 2019-10-03 16:34 Subject: Re: [PATCH 1/3] format-patch: document and exercise that -o does only create the trailing directory Message-ID: URL: https://gitlist.dev/e/CAKPyHN0xqis9_Apwi4LmNuhO9aGQdZ4qRs_hcm2YUVLK391W_Q%40mail.gmail.com In-Reply-To: <20191002214709.GA51809@generichostname> ``` Denton, On Wed, Oct 2, 2019 at 11:47 PM Denton Liu wrote: > > Hi Bert, > > > Subject: format-patch: document and exercise that -o does only create the trailing directory > > s/does only create/only creates/ ? > > Anyway, as a prepatory patch, I don't think that it's necessary. Maybe > it's just me but I assume that most tools create at most one directory > deep. Even mkdir won't created nested dirs unless you pass `-p`. I > dunno. > > On Wed, Oct 02, 2019 at 11:26:11PM +0200, Bert Wesarg wrote: > > Signed-off-by: Bert Wesarg > > --- > > Documentation/config/format.txt | 3 ++- > > Documentation/git-format-patch.txt | 4 +++- > > t/t4014-format-patch.sh | 16 ++++++++++++++++ > > 3 files changed, 21 insertions(+), 2 deletions(-) > > > > diff --git a/Documentation/config/format.txt b/Documentation/config/format.txt > > index 414a5a8a9d..e17c5d6b0f 100644 > > --- a/Documentation/config/format.txt > > +++ b/Documentation/config/format.txt > > @@ -80,7 +80,8 @@ format.coverLetter:: > > > > format.outputDirectory:: > > Set a custom directory to store the resulting files instead of the > > - current working directory. > > + current working directory. Only the trailing directory will be created > > + though. > > > > 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 b9b97e63ae..fe7492353e 100644 > > --- a/Documentation/git-format-patch.txt > > +++ b/Documentation/git-format-patch.txt > > @@ -66,7 +66,9 @@ 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 .`. Note that only > > +the trailing directory will be created by Git, leading directories must > > +already exists. > > > > 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/t/t4014-format-patch.sh b/t/t4014-format-patch.sh > > index ca7debf1d4..bf2715a503 100755 > > --- a/t/t4014-format-patch.sh > > +++ b/t/t4014-format-patch.sh > > @@ -1632,6 +1632,22 @@ 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 && > > + test $(git rev-list master..side | wc -l) -eq $(ls patches | wc -l) > > For test case you write, please use the following pattern: > > git rev-list master..side >list && > test_line_count = $(ls patches | wc -l) list > > The first benefit is that we get to take advantage of the > test_line_count function that's already written for us. The second is > that when we write tests, we shouldn't put Git commands in the upstream > of a pipe because if they fail, their return codes will be lost and we > won't be able to fail the test properly. thanks. I will ensure, that this follows your dl/format-patch-doc-test-cleanup topic. Bert > > > +' > > + > > +test_expect_success 'format-patch -o with leading existing directories' ' > > + git format-patch -o patches/side master..side && > > + test $(git rev-list master..side | wc -l) -eq $(ls patches/side | wc -l) > > +' > > + > > +test_expect_failure 'format-patch -o with leading non-existing directories' ' > > + rm -fr patches && > > + git format-patch -o patches/side master..side > > +' > > As above, I wouldn't really call this a bug in Git. I think we should > leave this test case off until the next patch. > > > + > > test_expect_success 'format-patch format.outputDirectory option' ' > > test_config format.outputDirectory patches && > > rm -fr patches && > > -- > > 2.23.0.11.g242cf7f110 > > ```