[src/trunk]: src/usr.bin/make make(1): clean up documentation of Main_ParseAr...

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

details:   https://anonhg.NetBSD.org/src/rev/b820434d125a
branches:  trunk
changeset: 976728:b820434d125a
user:      rillig <rillig%NetBSD.org@localhost>
date:      Thu Oct 01 23:52:51 2020 +0000

description:
make(1): clean up documentation of Main_ParseArgLine

The previous documentation contained lots of irrelevant implementation
details.

diffstat:

 usr.bin/make/main.c |  24 +++++-------------------
 1 files changed, 5 insertions(+), 19 deletions(-)

diffs (46 lines):

diff -r 26191c3db764 -r b820434d125a usr.bin/make/main.c
--- a/usr.bin/make/main.c       Thu Oct 01 23:44:36 2020 +0000
+++ b/usr.bin/make/main.c       Thu Oct 01 23:52:51 2020 +0000
@@ -1,4 +1,4 @@
-/*     $NetBSD: main.c,v 1.360 2020/10/01 23:44:36 rillig Exp $        */
+/*     $NetBSD: main.c,v 1.361 2020/10/01 23:52:51 rillig Exp $        */
 
 /*
  * Copyright (c) 1988, 1989, 1990, 1993
@@ -126,7 +126,7 @@
 #endif
 
 /*     "@(#)main.c     8.3 (Berkeley) 3/19/94" */
-MAKE_RCSID("$NetBSD: main.c,v 1.360 2020/10/01 23:44:36 rillig Exp $");
+MAKE_RCSID("$NetBSD: main.c,v 1.361 2020/10/01 23:52:51 rillig Exp $");
 #if defined(MAKE_NATIVE) && !defined(lint)
 __COPYRIGHT("@(#) Copyright (c) 1988, 1989, 1990, 1993\
  The Regents of the University of California.  All rights reserved.");
@@ -691,24 +691,10 @@
        usage();
 }
 
-/*-
- * Main_ParseArgLine --
- *     Used by the parse module when a .MFLAGS or .MAKEFLAGS target
- *     is encountered and by main() when reading the .MAKEFLAGS envariable.
- *     Takes a line of arguments and breaks it into its
- *     component words and passes those words and the number of them to the
- *     MainParseArgs function.
- *     The line should have all its leading whitespace removed.
+/* Break a line of arguments into words and parse them.
  *
- * Input:
- *     line            Line to fracture
- *
- * Results:
- *     None
- *
- * Side Effects:
- *     Only those that come from the various arguments.
- */
+ * Used when a .MFLAGS or .MAKEFLAGS target is encountered during parsing and
+ * by main() when reading the MAKEFLAGS environment variable. */
 void
 Main_ParseArgLine(const char *line)
 {