mbox series

[00/13] format-patch: clean up tests and documentation

Message ID cover.1566635008.git.liu.denton@gmail.com (mailing list archive)
Headers show
Series format-patch: clean up tests and documentation | expand

Message

Denton Liu Aug. 24, 2019, 8:25 a.m. UTC
*** BLURB HERE ***

As one of the older parts of the Git, the tests and documentation for
format-patch have been needing cleanup for a while. Let's do that in
this patchset!

This patchset is based on v3 of "format-patch: learn
--infer-cover-subject option (also t4014 cleanup)"[1].

Changes since v3 of "format-patch: learn --infer-cover-subject option (also
t4014 cleanup)":

* Squash in Junio's and Hannes' suggestions

* Add 't4014: let sed open its own files'

[1]: https://public-inbox.org/git/xmqqwof3ljcz.fsf@gitster-ct.c.googlers.com/T/#m19570aff4828dfbd65d57cacf231c2938af1dc9f


Denton Liu (13):
  t4014: drop unnecessary blank lines from test cases
  t4014: s/expected/expect/
  t4014: move closing sq onto its own line
  t4014: use sq for test case names
  t4014: remove spaces after redirect operators
  t4014: use indentable here-docs
  t4014: drop redirections to /dev/null
  t4014: let sed open its own files
  t4014: use test_line_count() where possible
  t4014: remove confusing pipe in check_threading()
  t4014: stop losing return codes of git commands
  Doc: add more detail for git-format-patch
  config/format.txt: specify default value of format.coverLetter

 Documentation/config/format.txt    |   1 +
 Documentation/git-format-patch.txt |  23 +-
 t/t4014-format-patch.sh            | 814 ++++++++++++++---------------
 3 files changed, 421 insertions(+), 417 deletions(-)

Range-diff:
 1:  fb000bfca2 =  1:  fb000bfca2 t4014: drop unnecessary blank lines from test cases
 2:  568b3a03a0 !  2:  0a5ce9b95f t4014: s/expected/expect/
    @@ Commit message
         t4014: s/expected/expect/
     
         For test cases, the usual convention is to name expected output files
    -    "expect", not "expected". Replace all instances with "expected" with
    +    "expect", not "expected". Replace all instances of "expected" with
         "expect" except for one case where the "expected" is used as the name
         of a test case.
     
 3:  a205a920bd =  3:  5c49703aa4 t4014: move closing sq onto its own line
 4:  66bf2e3dd4 =  4:  02a11147fd t4014: use sq for test case names
 5:  6f1371275e =  5:  8d9791c061 t4014: remove spaces after redirect operators
 6:  b4295846f5 =  6:  90ad0fcf70 t4014: use indentable here-docs
 7:  34315412c8 =  7:  804b3163f8 t4014: drop redirections to /dev/null
 -:  ---------- >  8:  7d9a24a979 t4014: let sed open its own files
 8:  de08dd886d =  9:  d068d42098 t4014: use test_line_count() where possible
 9:  dec5a62e82 = 10:  6a9409cee0 t4014: remove confusing pipe in check_threading()
10:  64069c0c54 ! 11:  c580ce447b t4014: stop losing return codes of git commands
    @@ t/t4014-format-patch.sh: test_expect_success 'format-patch --ignore-if-in-upstre
      
     -git_version="$(git --version | sed "s/.* //")"
     +test_expect_success 'get git version' '
    -+	git_version="$(git --version | sed "s/.* //")"
    ++	git_version=$(git --version) &&
    ++	git_version=${git_version##* }
     +'
      
      signature() {
11:  c12534ab5d = 12:  a97f861e6a Doc: add more detail for git-format-patch
12:  a08273ebcc <  -:  ---------- config/format.txt: specify default value of format.coverLetter
13:  de599f7ca9 <  -:  ---------- format-patch: learn --infer-cover-subject option
 -:  ---------- > 13:  7c8522abf2 config/format.txt: specify default value of format.coverLetter

Comments

Denton Liu Aug. 24, 2019, 8:28 a.m. UTC | #1
On Sat, Aug 24, 2019 at 04:25:17AM -0400, Denton Liu wrote:
> *** BLURB HERE ***

Whoops, perhaps we also need a configuration option for turning this off
as well ;)

> 
> As one of the older parts of the Git, the tests and documentation for
> format-patch have been needing cleanup for a while. Let's do that in
> this patchset!
> 
> This patchset is based on v3 of "format-patch: learn
> --infer-cover-subject option (also t4014 cleanup)"[1].
> 
> Changes since v3 of "format-patch: learn --infer-cover-subject option (also
> t4014 cleanup)":
> 
> * Squash in Junio's and Hannes' suggestions
> 
> * Add 't4014: let sed open its own files'
> 
> [1]: https://public-inbox.org/git/xmqqwof3ljcz.fsf@gitster-ct.c.googlers.com/T/#m19570aff4828dfbd65d57cacf231c2938af1dc9f
> 
> 
> Denton Liu (13):
>   t4014: drop unnecessary blank lines from test cases
>   t4014: s/expected/expect/
>   t4014: move closing sq onto its own line
>   t4014: use sq for test case names
>   t4014: remove spaces after redirect operators
>   t4014: use indentable here-docs
>   t4014: drop redirections to /dev/null
>   t4014: let sed open its own files
>   t4014: use test_line_count() where possible
>   t4014: remove confusing pipe in check_threading()
>   t4014: stop losing return codes of git commands
>   Doc: add more detail for git-format-patch
>   config/format.txt: specify default value of format.coverLetter
> 
>  Documentation/config/format.txt    |   1 +
>  Documentation/git-format-patch.txt |  23 +-
>  t/t4014-format-patch.sh            | 814 ++++++++++++++---------------
>  3 files changed, 421 insertions(+), 417 deletions(-)
> 
> Range-diff:
>  1:  fb000bfca2 =  1:  fb000bfca2 t4014: drop unnecessary blank lines from test cases
>  2:  568b3a03a0 !  2:  0a5ce9b95f t4014: s/expected/expect/
>     @@ Commit message
>          t4014: s/expected/expect/
>      
>          For test cases, the usual convention is to name expected output files
>     -    "expect", not "expected". Replace all instances with "expected" with
>     +    "expect", not "expected". Replace all instances of "expected" with
>          "expect" except for one case where the "expected" is used as the name
>          of a test case.
>      
>  3:  a205a920bd =  3:  5c49703aa4 t4014: move closing sq onto its own line
>  4:  66bf2e3dd4 =  4:  02a11147fd t4014: use sq for test case names
>  5:  6f1371275e =  5:  8d9791c061 t4014: remove spaces after redirect operators
>  6:  b4295846f5 =  6:  90ad0fcf70 t4014: use indentable here-docs
>  7:  34315412c8 =  7:  804b3163f8 t4014: drop redirections to /dev/null
>  -:  ---------- >  8:  7d9a24a979 t4014: let sed open its own files
>  8:  de08dd886d =  9:  d068d42098 t4014: use test_line_count() where possible
>  9:  dec5a62e82 = 10:  6a9409cee0 t4014: remove confusing pipe in check_threading()
> 10:  64069c0c54 ! 11:  c580ce447b t4014: stop losing return codes of git commands
>     @@ t/t4014-format-patch.sh: test_expect_success 'format-patch --ignore-if-in-upstre
>       
>      -git_version="$(git --version | sed "s/.* //")"
>      +test_expect_success 'get git version' '
>     -+	git_version="$(git --version | sed "s/.* //")"
>     ++	git_version=$(git --version) &&
>     ++	git_version=${git_version##* }
>      +'
>       
>       signature() {
> 11:  c12534ab5d = 12:  a97f861e6a Doc: add more detail for git-format-patch
> 12:  a08273ebcc <  -:  ---------- config/format.txt: specify default value of format.coverLetter
> 13:  de599f7ca9 <  -:  ---------- format-patch: learn --infer-cover-subject option
>  -:  ---------- > 13:  7c8522abf2 config/format.txt: specify default value of format.coverLetter
> -- 
> 2.23.0.248.g3a9dd8fb08
>
Junio C Hamano Aug. 26, 2019, 3:21 p.m. UTC | #2
Denton Liu <liu.denton@gmail.com> writes:

> On Sat, Aug 24, 2019 at 04:25:17AM -0400, Denton Liu wrote:
>> *** BLURB HERE ***
>
> Whoops, perhaps we also need a configuration option for turning this off
> as well ;)

Yes.

I think it is OK to just remove it when we are taking anything from
the branch.*.description (and any other stuff that leaves human
readable text in the future) to add to the body.