Re: [PATCH 2/2][GSoC 2014] diff: used is_dot_or_dotdot() in code

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Mar 19, 2014, 03:45 UTC
Message-ID: <CAPig+cSxu1WAEg7YmnNn-kHZMj4AacRaVPMthgAwFN0GmrrYCg@mail.gmail.com>
In-Reply-To: <1395192636735-7605956.post@n2.nabble.com>

On Tue, Mar 18, 2014 at 9:30 PM, babourn <ba.bourn@gmail.com> wrote:

> Subject: diff: used is_dot_or_dotdot() in code

Use imperative voice: "use" rather than "used"

> in accordance with the GSoC Microproject implemented

This commentary will not have much meaning to someone reading the commit log months or years from now. Place it below the "---" line following your sign-off.

> the call is_dot_or_dotdot() in the code in order to
> further universalize the call to the function and
> increase code continuity.

It should be sufficient to explain the patch by just saying:

    Subject: replace manual "."/".." check with is_dot_or_dotdot()

The rest of the explanatory text can be dropped since it doesn't add anything (meaningful) beyond what the subject says.

Show 16 quoted lines

> Signed-off-by: Brian Bourn <bab2177@columbia.edu>
> ---
>  diff-no-index.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/diff-no-index.c b/diff-no-index.c
> index ba915af..44cce25 100644
> --- a/diff-no-index.c
> +++ b/diff-no-index.c
> @@ -26,7 +26,7 @@ static int read_directory_contents(const char *path,
> struct string_list *list)
>   return error("Could not open directory %s", path);
>
>   while ((e = readdir(dir)))
> - if (strcmp(".", e->d_name) && strcmp("..", e->d_name))
> + if (!is_dot_or_dotdot(e->d_name))

The patch is severely whitespace-damaged. (Did you post it through Nabble?)

Show 12 quoted lines

>   string_list_insert(list, e->d_name);
>
>   closedir(dir);
> --
> 1.9.0
>
>
>
> --
> View this message in context: http://git.661346.n2.nabble.com/PATCH-GSoC-2014-diff-Imported-dir-h-and-renamed-read-directory-tp7605950p7605956.html
> Sent from the git mailing list archive at Nabble.com.
> --