From: Junio C Hamano <gitster@pobox.com>
To: Rohit Ashiwal <rohit.ashiwal265@gmail.com>
Cc: git@vger.kernel.org, Johannes.Schindelin@gmx.de,
t.gummerer@gmail.com, christian.couder@gmail.com
Subject: Re: [PATCH 2/3] t3600: refactor code according to contemporary guidelines
Date: Sun, 03 Mar 2019 22:30:02 +0900 [thread overview]
Message-ID: <xmqqwolgytk5.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <20190303122842.30380-3-rohit.ashiwal265@gmail.com> (Rohit Ashiwal's message of "Sun, 3 Mar 2019 17:58:41 +0530")
Rohit Ashiwal <rohit.ashiwal265@gmail.com> writes:
> Subject: Re: [PATCH 2/3] t3600: refactor code according to contemporary guidelines
Please do not overuse/abuse the verb "refactor" like this. What the
patch does is only reformat---it does not do common "refactoring"
transformations like factoring out common/duplicated code into
helper functions, etc.
If we are doing this step, let's make sure all tests use the modern
style correctly.
> # Setup some files to be removed, some with funny characters
> test_expect_success \
> - 'Initialize test directory' \
> - "touch -- foo bar baz 'space embedded' -q &&
> - git add -- foo bar baz 'space embedded' -q &&
> - git commit -m 'add normal files'"
> + 'Initialize test directory' "
> + touch -- foo bar baz 'space embedded' -q &&
> + git add -- foo bar baz 'space embedded' -q &&
> + git commit -m 'add normal files'
> +"
In the modern style, we'd write this like so:
test_expect_success 'initialize test directory' '
touch -- foo bar baz "space embedded" -q &&
git add -- foo bar baz "space embedded" -q &&
git commit -m "add normal files"
'
In addition to indenting with HT (not SP), two more points are
- test title comes on the first line;
- test body is enclosed in a single quote pair, opened on the first
line and closed on the last line.
>
> -if test_have_prereq !FUNNYNAMES; then
> +if test_have_prereq !FUNNYNAMES
> +then
This is good.
> say 'Your filesystem does not allow tabs in filenames.'
> fi
>
> test_expect_success FUNNYNAMES 'add files with funny names' "
This has title on the first line, and opening quote of the body as
well, which is the modern style.
> test_expect_success \
> - 'Pre-check that foo exists and is in index before git rm foo' \
> - '[ -f foo ] && git ls-files --error-unmatch foo'
> + 'Pre-check that foo exists and is in index before git rm foo' \
> + '[ -f foo ] && git ls-files --error-unmatch foo'
We prefer "test ..." over "[ ... ]" (Documentation/CodingGuidelines).
Thanks.
next prev parent reply other threads:[~2019-03-03 13:30 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-03 12:28 [GSoC][PATCH 0/3] Use helper functions in test script Rohit Ashiwal
2019-03-03 12:28 ` [PATCH 1/3] test functions: Add new function `test_file_not_empty` Rohit Ashiwal
2019-03-03 13:20 ` Junio C Hamano
2019-03-03 13:29 ` Rohit Ashiwal
2019-03-03 13:33 ` none Junio C Hamano
2019-03-03 14:07 ` Clearing logic Rohit Ashiwal
2019-03-03 16:19 ` Thomas Gummerer
2019-03-03 12:28 ` [PATCH 2/3] t3600: refactor code according to contemporary guidelines Rohit Ashiwal
2019-03-03 13:30 ` Junio C Hamano [this message]
2019-03-03 14:13 ` t3600: refactor code according to comtemporary guidelines Rohit Ashiwal
2019-03-03 12:28 ` [PATCH 3/3] t3600: use helper functions from test-lib-functions Rohit Ashiwal
2019-03-03 13:32 ` Junio C Hamano
2019-03-03 23:37 ` [GSoC][PATCH v2 0/3] Use helper functions in test script Rohit Ashiwal
2019-03-03 23:37 ` [GSoC][PATCH v2 1/3] test functions: add function `test_file_not_empty` Rohit Ashiwal
2019-03-04 3:45 ` Junio C Hamano
2019-03-03 23:37 ` [GSoC][PATCH v2 2/3] t3600: restructure code according to contemporary guidelines Rohit Ashiwal
2019-03-04 4:17 ` Junio C Hamano
2019-03-03 23:37 ` [GSoC][PATCH v2 3/3] t3600: use helpers to replace test -d/f/e/s <path> Rohit Ashiwal
2019-03-04 12:07 ` [GSoC][PATCH v3 0/3] Use helper functions in test script Rohit Ashiwal
2019-03-04 12:07 ` [GSoC][PATCH v3 1/3] test functions: add function `test_file_not_empty` Rohit Ashiwal
2019-03-05 0:17 ` Eric Sunshine
2019-03-05 12:43 ` Junio C Hamano
2019-03-05 13:27 ` [GSoc][PATCH " Rohit Ashiwal
2019-03-04 12:08 ` [GSoC][PATCH v3 2/3] t3600: modernize style Rohit Ashiwal
2019-03-05 0:36 ` Eric Sunshine
2019-03-05 12:44 ` Junio C Hamano
2019-03-04 12:08 ` [GSoC][PATCH v3 3/3] t3600: use helpers to replace test -d/f/e/s <path> Rohit Ashiwal
2019-03-05 0:42 ` Eric Sunshine
2019-03-05 13:42 ` Rohit Ashiwal
2019-03-05 14:03 ` Eric Sunshine
2019-03-05 14:21 ` [GSoC][PATCH v2 " Rohit Ashiwal
2019-03-05 14:57 ` Eric Sunshine
2019-03-05 23:38 ` Rohit Ashiwal
2019-03-08 5:38 ` [GSoC][PATCH v2 3/3] t3600: use helpers to replace test -d/f/e/s <path> Junio C Hamano
2019-03-08 9:51 ` Eric Sunshine
2019-03-11 1:54 ` Junio C Hamano
2019-03-05 0:09 ` [GSoC][PATCH v3 0/3] Use helper functions in test script Eric Sunshine
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqwolgytk5.fsf@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=rohit.ashiwal265@gmail.com \
--cc=t.gummerer@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).