[PATCH v3 2/5] expand_user_path(): remove stale part of the comment

From: Johannes Schindelin via GitGitGadget <gitgitgadget@gmail.com>
Date: Jul 24, 2021, 22:06 UTC
Message-ID: <a4ff3a461bc42d11e5ef9e40deeb90d17919943d.1627164413.git.gitgitgadget@gmail.com>
In-Reply-To: <pull.66.v3.git.1627164413.gitgitgadget@gmail.com>

From: Johannes Schindelin <johannes.schindelin@gmx.de>

In 395de250d9d (Expand ~ and ~user in core.excludesfile, commit.template, 2009-11-17), the `user_path()` function was refactored into the `expand_user_path()`. During that refactoring, the `buf` parameter was lost, but the code comment above said function still talks about it. Let's remove that stale part of the comment.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
 path.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/path.c b/path.c
index 7bccd830e95..3318ad24336 100644
--- a/path.c
+++ b/path.c
@@ -719,9 +719,8 @@ static struct passwd *getpw_str(const char *username, size_t len)
 }
 
 /*
- * Return a string with ~ and ~user expanded via getpw*.  If buf != NULL,
- * then it is a newly allocated string. Returns NULL on getpw failure or
- * if path is NULL.
+ * 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.
  */

-- 
gitgitgadget