mbox series

[v4,0/2] t/lib-read-tree-m-3way: modernize a test script

Message ID 20220208032450.46604-1-shaoxuan.yuan02@gmail.com (mailing list archive)
Headers show
Series t/lib-read-tree-m-3way: modernize a test script | expand

Message

Shaoxuan Yuan Feb. 8, 2022, 3:24 a.m. UTC
== Basic Summary ==

Modernize the test script t/lib-read-tree-m-3way.

Shaoxuan Yuan (2):
  t/lib-read-tree-m-3way: modernize style
  t/lib-read-tree-m-3way: indent with tabs

 t/lib-read-tree-m-3way.sh | 168 +++++++++++++++++++-------------------
 1 file changed, 84 insertions(+), 84 deletions(-)

Range-diff against v3:
1:  72323a7a57 ! 1:  6cbca771e5 t/lib-read-tree-m-3way: modernize style
    @@ Metadata
      ## Commit message ##
         t/lib-read-tree-m-3way: modernize style
     
    -    Many invocations of the test_expect_success command in this
    +    Many invocations of the test commands (e.g. test_expect_success
    +    or test_expect_failure) in this
         file are written in old style where the command, an optional
    -    prerequisite, and the test title are written on separate
    -    lines, and the executable script string begins on its own
    -    line, and these lines are pasted together with backslashes
    -    as necessary.
    +    prerequisite, the test title, and the executable script string
    +    are written on separate lines, with the executable script string
    +    begins on its own line, and these lines are pasted together
    +    with backslashes as necessary.
     
    -    An invocation of the test_expect_success command in modern
    +    An invocation of the test command in modern
         test scripts however writes the prerequisite and the title
    -    on the same line as the test_expect_success command itself,
    +    on the same line as the test command itself,
         and ends the line with a single quote that begins the
         executable script string.
     
    +    It is worth notice that albeit all executable script strings
    +    are changed to use single quotes (for modern style uniformity),
    +    some of the test titles are kept untouched, e.g.
    +
    +    -       test_expect_success \
    +    -           "adding test file $p and Z/$p" \
    +    -           'git update-index --add $p &&
    +    -           git update-index --add Z/$p'
    +    +       test_expect_success "adding test file $p and Z/$p" '
    +    +           git update-index --add $p &&
    +    +           git update-index --add Z/$p
    +    +    '
    +
    +    see the "adding test file $p and Z/$p" part.
    +
    +    This is because the test title is simply echo'd/print'd, and
    +    double quotes are necessary for "$p" interpolation; however,
    +    the test body (executable script string) gets eval'd, and
    +    single quotes are acceptable in this case.
    +
         Update the style for uniformity.
     
         Signed-off-by: Shaoxuan Yuan <shaoxuan.yuan02@gmail.com>
2:  477b71497f ! 2:  e5d89ca1de t/lib-read-tree-m-3way: indent with tabs
    @@ Commit message
         t/lib-read-tree-m-3way: indent with tabs
     
         As Documentation/CodingGuidelines says, our shell scripts
    -    (including tests) are to use HT for indentation, but this script
    -    uses 4-column indent with SP. Fix this.
    +    (including tests) are to use tabs for indentation, but this script
    +    uses 4-column indent with space. Fix this.
     
         Signed-off-by: Shaoxuan Yuan <shaoxuan.yuan02@gmail.com>