From: Johannes Schindelin <johannes.schindelin@gmx.de>
Date: Sat, 24 Jul 2021 22:06:51 +0000 (+0000)
Subject: expand_user_path(): clarify the role of the `real_home` parameter
X-Git-Tag: v2.34.0-rc0~244^2~3
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=644e6b2c0f55fa52de88586d375e03ac7f7914b7;p=thirdparty%2Fgit.git

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>
---

diff --git a/path.c b/path.c
index 3318ad2433..bf329e535c 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)
 {