expand_user_path(): clarify the role of the real_home parameter

dscho · gitster · commit 644e6b2c0f55 · 2021-07-26T12:17:16.000-07:00
The `real_home` parameter only has an effect when expanding paths
starting with `~/`, not when expanding paths starting with `~&lt;user&gt;/`.
Let's make that clear.

Signed-off-by: Johannes Schindelin &lt;johannes.schindelin@gmx.de&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git 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)
 {

Original file line number	Diff line number	Diff line change
`@@ -722,7 +722,7 @@ static struct passwd getpw_str(const char username, size_t len)`
`722`	`722`	`* Return a string with ~ and ~user expanded via getpw*. Returns NULL on getpw`
`723`	`723`	`* failure or if path is NULL.`
`724`	`724`	`*`
`725`		`- * If real_home is true, strbuf_realpath($HOME) is used in the expansion.`
	`725`	+ * If real_home is true, strbuf_realpath($HOME) is used in the `~/` expansion.
`726`	`726`	`*/`
`727`	`727`	`char expand_user_path(const char path, int real_home)`
`728`	`728`	`{`