Module Name: src
Committed By: rillig
Date: Mon Oct 26 23:28:53 UTC 2020
Modified Files:
src/usr.bin/make: dir.c job.c main.c
Log Message:
make(1): remove "Results: none" from the documentation of void functions
To generate a diff of this commit:
cvs rdiff -u -r1.189 -r1.190 src/usr.bin/make/dir.c
cvs rdiff -u -r1.292 -r1.293 src/usr.bin/make/job.c
cvs rdiff -u -r1.391 -r1.392 src/usr.bin/make/main.c
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.bin/make/dir.c
diff -u src/usr.bin/make/dir.c:1.189 src/usr.bin/make/dir.c:1.190
--- src/usr.bin/make/dir.c:1.189 Sun Oct 25 21:51:48 2020
+++ src/usr.bin/make/dir.c Mon Oct 26 23:28:52 2020
@@ -1,4 +1,4 @@
-/* $NetBSD: dir.c,v 1.189 2020/10/25 21:51:48 rillig Exp $ */
+/* $NetBSD: dir.c,v 1.190 2020/10/26 23:28:52 rillig Exp $ */
/*
* Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
@@ -135,7 +135,7 @@
#include "job.h"
/* "@(#)dir.c 8.2 (Berkeley) 1/2/94" */
-MAKE_RCSID("$NetBSD: dir.c,v 1.189 2020/10/25 21:51:48 rillig Exp $");
+MAKE_RCSID("$NetBSD: dir.c,v 1.190 2020/10/26 23:28:52 rillig Exp $");
#define DIR_DEBUG0(text) DEBUG0(DIR, text)
#define DIR_DEBUG1(fmt, arg1) DEBUG1(DIR, fmt, arg1)
@@ -1503,23 +1503,11 @@ Dir_MakeFlags(const char *flag, SearchPa
return Buf_Destroy(&buf, FALSE);
}
-/*-
- *-----------------------------------------------------------------------
- * Dir_Destroy --
- * Nuke a directory descriptor, if possible. Callback procedure
- * for the suffixes module when destroying a search path.
+/* Nuke a directory descriptor, if possible. Callback procedure for the
+ * suffixes module when destroying a search path.
*
* Input:
* dirp The directory descriptor to nuke
- *
- * Results:
- * None.
- *
- * Side Effects:
- * If no other path references this directory (refCount == 0),
- * the CachedDir and all its data are freed.
- *
- *-----------------------------------------------------------------------
*/
void
Dir_Destroy(void *dirp)
@@ -1536,23 +1524,8 @@ Dir_Destroy(void *dirp)
}
}
-/*-
- *-----------------------------------------------------------------------
- * Dir_ClearPath --
- * Clear out all elements of the given search path. This is different
- * from destroying the list, notice.
- *
- * Input:
- * path Path to clear
- *
- * Results:
- * None.
- *
- * Side Effects:
- * The path is set to the empty list.
- *
- *-----------------------------------------------------------------------
- */
+/* Clear out all elements from the given search path.
+ * The path is set to the empty list but is not destroyed. */
void
Dir_ClearPath(SearchPath *path)
{
@@ -1563,34 +1536,18 @@ Dir_ClearPath(SearchPath *path)
}
-/*-
- *-----------------------------------------------------------------------
- * Dir_Concat --
- * Concatenate two paths, adding the second to the end of the first.
- * Makes sure to avoid duplicates.
- *
- * Input:
- * path1 Dest
- * path2 Source
- *
- * Results:
- * None
- *
- * Side Effects:
- * Reference counts for added dirs are upped.
- *
- *-----------------------------------------------------------------------
- */
+/* Concatenate two paths, adding the second to the end of the first,
+ * skipping duplicates. */
void
-Dir_Concat(SearchPath *path1, SearchPath *path2)
+Dir_Concat(SearchPath *dst, SearchPath *src)
{
SearchPathNode *ln;
- for (ln = path2->first; ln != NULL; ln = ln->next) {
+ for (ln = src->first; ln != NULL; ln = ln->next) {
CachedDir *dir = ln->datum;
- if (Lst_FindDatum(path1, dir) == NULL) {
+ if (Lst_FindDatum(dst, dir) == NULL) {
dir->refCount++;
- Lst_Append(path1, dir);
+ Lst_Append(dst, dir);
}
}
}
Index: src/usr.bin/make/job.c
diff -u src/usr.bin/make/job.c:1.292 src/usr.bin/make/job.c:1.293
--- src/usr.bin/make/job.c:1.292 Mon Oct 26 23:19:17 2020
+++ src/usr.bin/make/job.c Mon Oct 26 23:28:52 2020
@@ -1,4 +1,4 @@
-/* $NetBSD: job.c,v 1.292 2020/10/26 23:19:17 rillig Exp $ */
+/* $NetBSD: job.c,v 1.293 2020/10/26 23:28:52 rillig Exp $ */
/*
* Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
@@ -143,7 +143,7 @@
#include "trace.h"
/* "@(#)job.c 8.2 (Berkeley) 3/19/94" */
-MAKE_RCSID("$NetBSD: job.c,v 1.292 2020/10/26 23:19:17 rillig Exp $");
+MAKE_RCSID("$NetBSD: job.c,v 1.293 2020/10/26 23:28:52 rillig Exp $");
/* A shell defines how the commands are run. All commands for a target are
* written into a single file, which is then given to the shell to execute
@@ -1721,9 +1721,6 @@ JobOutput(Job *job, char *cp, char *endp
* finish TRUE if this is the last time we'll be called
* for this job
*
- * Results:
- * None
- *
* Side Effects:
* curPos may be shifted as may the contents of outBuf.
*-----------------------------------------------------------------------
Index: src/usr.bin/make/main.c
diff -u src/usr.bin/make/main.c:1.391 src/usr.bin/make/main.c:1.392
--- src/usr.bin/make/main.c:1.391 Mon Oct 26 21:34:10 2020
+++ src/usr.bin/make/main.c Mon Oct 26 23:28:52 2020
@@ -1,4 +1,4 @@
-/* $NetBSD: main.c,v 1.391 2020/10/26 21:34:10 rillig Exp $ */
+/* $NetBSD: main.c,v 1.392 2020/10/26 23:28:52 rillig Exp $ */
/*
* Copyright (c) 1988, 1989, 1990, 1993
@@ -118,7 +118,7 @@
#include "trace.h"
/* "@(#)main.c 8.3 (Berkeley) 3/19/94" */
-MAKE_RCSID("$NetBSD: main.c,v 1.391 2020/10/26 21:34:10 rillig Exp $");
+MAKE_RCSID("$NetBSD: main.c,v 1.392 2020/10/26 23:28:52 rillig Exp $");
#if defined(MAKE_NATIVE) && !defined(lint)
__COPYRIGHT("@(#) Copyright (c) 1988, 1989, 1990, 1993 "
"The Regents of the University of California. "
@@ -1783,17 +1783,8 @@ Fatal(const char *fmt, ...)
exit(2); /* Not 1 so -q can distinguish error */
}
-/*
- * Punt --
- * Major exception once jobs are being created. Kills all jobs, prints
- * a message and exits.
- *
- * Results:
- * None
- *
- * Side Effects:
- * All children are killed indiscriminately and the program Lib_Exits
- */
+/* Major exception once jobs are being created.
+ * Kills all jobs, prints a message and exits. */
void
Punt(const char *fmt, ...)
{
@@ -1812,16 +1803,7 @@ Punt(const char *fmt, ...)
DieHorribly();
}
-/*-
- * DieHorribly --
- * Exit without giving a message.
- *
- * Results:
- * None
- *
- * Side Effects:
- * A big one...
- */
+/* Exit without giving a message. */
void
DieHorribly(void)
{
@@ -1833,20 +1815,11 @@ DieHorribly(void)
exit(2); /* Not 1, so -q can distinguish error */
}
-/*
- * Finish --
- * Called when aborting due to errors in child shell to signal
- * abnormal exit.
- *
- * Results:
- * None
- *
- * Side Effects:
- * The program exits
- */
+/* Called when aborting due to errors in child shell to signal abnormal exit.
+ * The program exits.
+ * Errors is the number of errors encountered in Make_Make. */
void
Finish(int errors)
- /* number of errors encountered in Make_Make */
{
if (dieQuietly(NULL, -1))
exit(2);
