@matheusbsbs / matheus-bagliano / commits / af2a651d2e

checkout_entry(): clarify the use of topath[] parameter

The said function has this signature: extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath); At first glance, it might appear that the caller of checkout_entry() can specify to which path the contents are written out by the last parameter, and it is tempting to add "const" in front of its type. In reality, however, topath[] is to point at a buffer to store the temporary path generated by the callchain originating from this function, and the temporary path is always short, much shorter than the buffer prepared by its only caller in builtin/checkout-index.c. Document the code a bit to clarify so that future callers know how to use the function better. Noticed-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Junio C Hamano committed Oct 23, 2013 at 10:52 UTC af2a651d2ecb3967244c9a44a5813a0cf9977df5

3 files changed +10 -1

builtin/checkout-index.c

+1 -1

@@ -14,7 +14,7 @@

14 static int line_termination = '\n';

15 static int checkout_stage; /* default to checkout stage0 */

16 static int to_tempfile;

17 -static char topath[4][PATH_MAX + 1];

17 +static char topath[4][TEMPORARY_FILENAME_LENGTH + 1];

19 static struct checkout state;

cache.h

@@ -975,6 +975,7 @@ struct checkout {

975 refresh_cache:1;

976 };

977

978 +#define TEMPORARY_FILENAME_LENGTH 25

979 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);

980

981 struct cache_def {

entry.c

@@ -234,6 +234,14 @@ static int check_path(const char *path, int len, struct stat *st, int skiplen)

234 return lstat(path, st);

235 }

236

237 +/*

238 + * Write the contents from ce out to the working tree.

239 + *

240 + * When topath[] is not NULL, instead of writing to the working tree

241 + * file named by ce, a temporary file is created by this function and

242 + * its name is returned in topath[], which must be able to hold at

243 + * least TEMPORARY_FILENAME_LENGTH bytes long.

244 + */

245 int checkout_entry(struct cache_entry *ce,

246 const struct checkout *state, char *topath)

247 {