Sun Sep 13 20:38:47 2020 UTC ()

make(1): fix documentation of VarParseErrors

It does not matter whether lint mode is enabled or not, Var_Parse must
reliably return whether an error message has been printed or not.

In the current phase where proper error handling is implemented only in
lint mode, this leads to code that looks a bit bloated since a few extra
branches are added, but that's ok.  Eventually the SILENT constants will
all be removed, and then the number of different cases will shrink
again.


(rillig)

diff -r1.121 -r1.122 src/usr.bin/make/nonints.h

--- src/usr.bin/make/Attic/nonints.h 2020/09/13 19:46:23	1.121
+++ src/usr.bin/make/Attic/nonints.h 2020/09/13 20:38:47	1.122

 @@ -1,14 +1,14 @@
-/*	$NetBSD: nonints.h,v 1.121 2020/09/13 19:46:23 rillig Exp $	*/
+/*	$NetBSD: nonints.h,v 1.122 2020/09/13 20:38:47 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.
 @@ -209,57 +209,54 @@ typedef enum {
  * As of 2020-09-13, this bitset looks quite bloated,
  * with all the constants doubled.
+ *
  * Its purpose is to first document the existing behavior,
  * and then migrate away from the SILENT constants, step by step,
  * as these are not suited for reliable, consistent error handling
  * and reporting. */
 typedef enum {
     /* Both parsing and evaluation succeeded. */
     VPE_OK		= 0x0000,
     /* Parsing failed.
-     * An error message has already been printed.
+     * An error message has already been printed. */
      * (It suffices if the error message is printed in lint mode.) */
     VPE_PARSE_MSG	= 0x0001,
     /* Parsing failed.
      * No error message has been printed yet.
+     *
      * This should never happen since it is impossible to say where
      * the parsing error occurred. */
     VPE_PARSE_SILENT	= 0x0002,
     /* Parsing succeeded.
      * During evaluation, VARE_UNDEFERR was set and there was an undefined
      * variable.
-     * An error message has already been printed.
+     * An error message has already been printed. */
      * (It suffices if the error message is printed in lint mode.) */
     VPE_UNDEF_MSG	= 0x0010,
     /* Parsing succeeded.
      * During evaluation, VARE_UNDEFERR was set and there was an undefined
      * variable.
      * No error message has been printed yet.
+     *
      * This should never happen since it is impossible to say which of
      * the variables was undefined. */
     VPE_UNDEF_SILENT	= 0x0020,
     /* Parsing succeeded.
      * Evaluation failed.
-     * An error message has already been printed.
+     * An error message has already been printed. */
      * (It suffices if the error message is printed in lint mode.) */
     VPE_EVAL_MSG	= 0x0100,
     /* Parsing succeeded.
      * Evaluation failed.
      * No error message has been printed yet.
+     *
      * This should never happen since it is impossible to say where
      * exactly the evaluation error occurred. */
     VPE_EVAL_SILENT	= 0x0200,
     /* See if a message has already been printed for this error. */
     VPE_ANY_MSG		= VPE_PARSE_MSG | VPE_UNDEF_MSG | VPE_EVAL_MSG
 } VarParseErrors;