 @@ -1,14 +1,14 @@
-/*	$NetBSD: parse.c,v 1.401 2020/10/26 21:34:10 rillig Exp $	*/
+/*	$NetBSD: parse.c,v 1.402 2020/10/28 00:38:37 rillig Exp $	*/
 /*
  * Copyright (c) 1988, 1989, 1990, 1993
  *	The Regents of the University of California.  All rights reserved.
+ *
  * This code is derived from software contributed to Berkeley by
  * Adam de Boor.
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
 @@ -58,90 +58,76 @@
  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  */
-/*-
+/*
- * parse.c --
+ * Parsing of makefiles.
  *	Functions to parse a makefile.
  * Parse_File is the main entry point and controls most of the other
  * functions in this module.
+ *
- *	One function, Parse_Init, must be called before any functions
+ * The directories for the .include "..." directive are kept in
- *	in this module are used. After that, the function Parse_File is the
+ * 'parseIncPath', while those for .include <...> are kept in 'sysIncPath'.
- *	main entry point and controls most of the other functions in this
+ * The targets currently being defined are kept in 'targets'.
  *	module.
  *	Most important structures are kept in Lsts. Directories for
  *	the .include "..." function are kept in the 'parseIncPath' Lst, while
  *	those for the .include <...> are kept in the 'sysIncPath' Lst. The
  *	targets currently being defined are kept in the 'targets' Lst.
  *	The variables 'fname' and 'lineno' are used to track the name
  *	of the current file and the line number in that file so that error
  *	messages can be more meaningful.
+ *
  * Interface:
- *	Parse_Init	Initialization function which must be
+ *	Parse_Init	Initialize the module
  *			called before anything else in this module
  *			is used.
+ *
  *	Parse_End	Clean up the module
+ *
- *	Parse_File	Function used to parse a makefile. It must
+ *	Parse_File	Parse a top-level makefile.  Included files are
- *			be given the name of the file, which should
+ *			handled by Parse_include_file though.
  *			already have been opened, and a function
- *			to call to read a character from the file.
+ *	Parse_IsVar	Return TRUE if the given line is a variable
  *			assignment. Used by MainParseArgs to determine if
- *	Parse_IsVar	Returns TRUE if the given line is a
+ *			an argument is a target or a variable assignment.
- *			variable assignment. Used by MainParseArgs
+ *			Used internally for pretty much the same thing.
  *			to determine if an argument is a target
- *			or a variable assignment. Used internally
+ *	Parse_Error	Report a parse error, a warning or an informational
- *			for pretty much the same thing...
+ *			message.
  *	Parse_Error	Function called when an error occurs in
  *			parsing. Used by the variable and
  *			conditional modules.
+ *
- *	Parse_MainName	Returns a Lst of the main target to create.
+ *	Parse_MainName	Returns a list of the main target to create.
  */
 #include <sys/types.h>
 #include <sys/mman.h>
 #include <sys/stat.h>
 #include <errno.h>
 #include <stdarg.h>
 #include <stdint.h>
 #ifndef MAP_FILE
 #define MAP_FILE 0
 #endif
 #ifndef MAP_COPY
 #define MAP_COPY MAP_PRIVATE
 #endif
 #include "make.h"
 #include "dir.h"
 #include "job.h"
 #include "pathnames.h"
 /*	"@(#)parse.c	8.3 (Berkeley) 3/19/94"	*/
-MAKE_RCSID("$NetBSD: parse.c,v 1.401 2020/10/26 21:34:10 rillig Exp $");
+MAKE_RCSID("$NetBSD: parse.c,v 1.402 2020/10/28 00:38:37 rillig Exp $");
 /* types and constants */
 /*
  * Structure for a file being read ("included file")
  */
 typedef struct IFile {
     char *fname;		/* name of file */
     Boolean fromForLoop;	/* simulated .include by the .for loop */
     int lineno;			/* current line number in file */
     int first_lineno;		/* line number of start of text */
     unsigned int cond_depth;	/* 'if' nesting when file opened */
     Boolean depending;		/* state of doing_depend on EOF */