"Li Linchao via GitGitGadget" <gitgitgadget@xxxxxxxxx> writes: > From: Li Linchao <lilinchao@xxxxxxxxxx> > > Update test style in t/t30[*].sh for uniformity, that's to > keep test title the same line with helper function itself, > and fix some indentions. > > Add a new section "recommended style" in t/README to > encourage people to use more modern style in test. > > Signed-off-by: Li Linchao <lilinchao@xxxxxxxxxx> > --- > ls-files: update test style > > Update test style in t/t30[*].sh for uniformity, that's to keep test > title the same line with helper function itself. > > And update t/README to describe this test style. > > Signed-off-by: Li Linchao lilinchao@xxxxxxxxxx > > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1269%2FCactusinhand%2Fllc%2Ffix-test-title-style-v5 > Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1269/Cactusinhand/llc/fix-test-title-style-v5 > Pull-Request: https://github.com/gitgitgadget/git/pull/1269 > > Range-diff vs v4: > > 1: d0ee9836f23 ! 1: 6cbb4e5fd49 ls-files: update test style > @@ t/README: This test harness library does the following things: > + test_cmp expect actual > + ' > + > ++ - Quote or escape the EOF at the head of a here document when > ++ there is no variable interpolation in it: > ++ > ++ cmd <<-"EOF" > ++ literal here-doc text > ++ EOF > ++ > ++ Or: > ++ > ++ cmd <<-\EOF > ++ literal here-doc text > ++ EOF > ++ I do not htink we need to describe two ways to quote at all. If we absolutely need to have two examples, then: + cmd <<-\EOF + literal here-doc text + EOF + + but not: + + cmd <<-EOF + literal here-doc text + EOF but I'd say the lines are better spent to explain what we have this particular style guide item for. - Quote or escape the EOF delimiter that begins a here-document if there is no parameter and other expansion in it, to signal readers that they can skim it more casually: cmd <<-\EOF literal here-document text without any expansion EOF or something. Other than that, this looks really good. Thanks.
