Re: [PATCH v4 05/19] entry: extract a header file for entry.c functions

From: Christian Couder <christian.couder@gmail.com>
Date: Dec 6, 2020, 08:31 UTC
Message-ID: <CAP8UFD1txMfR9KY5U-s+XyROOYGJfrqVRt1DmJn+_7Pa1EXKwQ@mail.gmail.com>
In-Reply-To: <cb3dea224b0776a332c38c6a251406314dfe87ba.1604521275.git.matheus.bernardino@usp.br>

On Wed, Nov 4, 2020 at 9:33 PM Matheus Tavares <matheus.bernardino@usp.br> wrote:

Show 22 quoted lines

> --- a/entry.c
> +++ b/entry.c
> @@ -6,6 +6,7 @@
>  #include "submodule.h"
>  #include "progress.h"
>  #include "fsmonitor.h"
> +#include "entry.h"
>
>  static void create_directories(const char *path, int path_len,
>                                const struct checkout *state)
> @@ -429,14 +430,6 @@ static void mark_colliding_entries(const struct checkout *state,
>         }
>  }
>
> -/*
> - * Write the contents from ce out to the working tree.
> - *
> - * When topath[] is not NULL, instead of writing to the working tree
> - * file named by ce, a temporary file is created by this function and
> - * its name is returned in topath[], which must be able to hold at
> - * least TEMPORARY_FILENAME_LENGTH bytes long.
> - */

About the above change, the commit message might want to say something like:

"While at it let's also move a comment related to checkout_entry() from entry.c to entry.h as it's more useful to describe the function there."