[src/trunk]: src/usr.bin/make make: fix documentation of VarFreeEnv

[rillig <rillig%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/d52edb48d01f
branches:  trunk
changeset: 953646:d52edb48d01f
user:      rillig <rillig%NetBSD.org@localhost>
date:      Sun Mar 14 20:23:29 2021 +0000

description:
make: fix documentation of VarFreeEnv

No functional change.

diffstat:

 usr.bin/make/var.c |  12 +++---------
 1 files changed, 3 insertions(+), 9 deletions(-)

diffs (33 lines):

diff -r dbf91f4d4749 -r d52edb48d01f usr.bin/make/var.c
--- a/usr.bin/make/var.c        Sun Mar 14 20:18:33 2021 +0000
+++ b/usr.bin/make/var.c        Sun Mar 14 20:23:29 2021 +0000
@@ -1,4 +1,4 @@
-/*     $NetBSD: var.c,v 1.882 2021/03/14 20:18:33 rillig Exp $ */
+/*     $NetBSD: var.c,v 1.883 2021/03/14 20:23:29 rillig Exp $ */
 
 /*
  * Copyright (c) 1988, 1989, 1990, 1993
@@ -140,7 +140,7 @@
 #include "metachar.h"
 
 /*     "@(#)var.c      8.3 (Berkeley) 3/19/94" */
-MAKE_RCSID("$NetBSD: var.c,v 1.882 2021/03/14 20:18:33 rillig Exp $");
+MAKE_RCSID("$NetBSD: var.c,v 1.883 2021/03/14 20:23:29 rillig Exp $");
 
 typedef enum VarFlags {
        VFL_NONE        = 0,
@@ -461,13 +461,7 @@
        return var;
 }
 
-/*
- * If the variable is an environment variable, free it, including its value.
- *
- * Results:
- *     TRUE if it was an environment variable,
- *     FALSE if it is still a regular variable.
- */
+/* If the variable is an environment variable, free it, including its value. */
 static void
 VarFreeEnv(Var *v)
 {