diff options
| author | Jeff King <peff@peff.net> | 2015-08-10 05:32:07 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2015-08-10 15:15:41 -0700 |
| commit | 69ddd231fe8d4de64990d42b96d34940a7e43aef (patch) | |
| tree | da90cd146fb61ab68f5b70ed8d816582bbc7c33d /path.c | |
| parent | efc8a625e9b03e6f8ceed37ccd4b9167a7447e31 (diff) | |
| download | git-69ddd231fe8d4de64990d42b96d34940a7e43aef.tar.gz git-69ddd231fe8d4de64990d42b96d34940a7e43aef.tar.xz | |
cache.h: clarify documentation for git_path, et al
The comment above these functions actually describes
sha1_file_name, and comes from the very first revision of
git. Commit 723c31f (Add "git_path()" and "head_ref()"
helper functions., 2005-07-05) added git_path, pushing the
comment away from the function it describes; later commits
added more functions in this block.
Let's fix the comment to describe these related functions in
more detail. Let's also make sure to point out their safer
alternatives (and move those alternatives below, which makes
more sense when reading the file).
Note that we do not need to move the existing comment to
sha1_file_name. Commit d40d535 (sha1_file.c: document a
bunch of functions defined in the file, 2014-02-21) already
added a much more descriptive comment to it.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'path.c')
0 files changed, 0 insertions, 0 deletions