summaryrefslogtreecommitdiff
path: root/path.c
diff options
context:
space:
mode:
authorJohannes Schindelin <johannes.schindelin@gmx.de>2021-07-24 22:06:51 (GMT)
committerJunio C Hamano <gitster@pobox.com>2021-07-26 19:17:16 (GMT)
commit644e6b2c0f55fa52de88586d375e03ac7f7914b7 (patch)
tree13e50c6f15a0e4c8840400a44384f9b9f9fb7a51 /path.c
parent789f6f226b6c7a5b28468044c1705c62aef5eeb9 (diff)
downloadgit-644e6b2c0f55fa52de88586d375e03ac7f7914b7.zip
git-644e6b2c0f55fa52de88586d375e03ac7f7914b7.tar.gz
git-644e6b2c0f55fa52de88586d375e03ac7f7914b7.tar.bz2
expand_user_path(): clarify the role of the `real_home` parameter
The `real_home` parameter only has an effect when expanding paths starting with `~/`, not when expanding paths starting with `~<user>/`. Let's make that clear. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'path.c')
-rw-r--r--path.c2
1 files changed, 1 insertions, 1 deletions
diff --git a/path.c b/path.c
index 3318ad2..bf329e5 100644
--- a/path.c
+++ b/path.c
@@ -722,7 +722,7 @@ static struct passwd *getpw_str(const char *username, size_t len)
* Return a string with ~ and ~user expanded via getpw*. Returns NULL on getpw
* failure or if path is NULL.
*
- * If real_home is true, strbuf_realpath($HOME) is used in the expansion.
+ * If real_home is true, strbuf_realpath($HOME) is used in the `~/` expansion.
*/
char *expand_user_path(const char *path, int real_home)
{