Re: [PATCH] diff-no-index.c: rewrote read_directory() to use is_dot_or_dotdot() function.

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Mar 19, 2014, 09:51 UTC
Message-ID: <CAPig+cQynpEEg6NU08FX1ZHGGwU+xVDyUYEVNx9vogh6L1_QzA@mail.gmail.com>
In-Reply-To: <1395217910-7506-1-git-send-email-mandrei.dinu@gmail.com>

Thanks for the submission. Comments below to give you a taste of the Git review process...

On Wed, Mar 19, 2014 at 4:31 AM, Andrei Dinu <mandrei.dinu@gmail.com> wrote:

> Subject: diff-no-index.c: rewrote read_directory() to use is_dot_or_dotdot() function.

Use imperative tone: "rewrite" instead of "rewrote". The subject is a bit long. Try to keep it to 65-70 characters. You might instead say:

    diff-no-index: replace manual "."/".." check with is_dot_or_dotdot()

> is_dot_or_dotdot() verifies if the name of the directory sent as parameter to this function is the same with '.' or '..' and returns 0 if that is true.

Wrap commit message to 65-70 characters.

> There is unnecessary to iterate each character of the char* argument and verify it with strcmp because if there is a match that is at the beginning of chars.

You may be able to drop most or all of this text. A subject such as the one suggested above probably conveys enough information to explain and justify the patch without having to say anything more.

> Signed-off-by: Andrei Dinu <mandrei.dinu@gmail.com>
>
> I plan on applying to GSoc 2014

This commentary about GSoC won't be interesting to people reading the commit message months or years from now, so place it after the "---" line just below.

Show 20 quoted lines

> ---
>  diff-no-index.c |   11 ++++++++++-
>  1 file changed, 10 insertions(+), 1 deletion(-)
>
> diff --git a/diff-no-index.c b/diff-no-index.c
> index 8e10bff..83cdbf7 100644
> --- a/diff-no-index.c
> +++ b/diff-no-index.c
> @@ -16,6 +16,15 @@
>  #include "builtin.h"
>  #include "string-list.h"
>
> +static int is_dot_or_dotdot(const char *path)
> +{
> +    if (path[0] == '.' && path[1] == '\0')
> +        return 0;
> +    else if (path[0] == '.' && path[1] == '.' && path[2] == '\0')
> +        return 0;
> +    return 1;
> +}

Git already defines an is_dot_or_dotdot() function. Is there a reason you chose to implement your own?

It is very unusual for a function asking "is this true" to return false when the condition is true, and vice versa. It is not a good idea to break expectations in this fashion.

Show 14 quoted lines

>  static int read_directory(const char *path, struct string_list *list)
>  {
>         DIR *dir;
> @@ -25,7 +34,7 @@ static int read_directory(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))
>                         string_list_insert(list, e->d_name);
>
>         closedir(dir);
> --
> 1.7.9.5