[src/trunk]: src/usr.bin/make make(1): improve documentation for Buffer fields

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

details:   https://anonhg.NetBSD.org/src/rev/1d41cb6522ce
branches:  trunk
changeset: 943328:1d41cb6522ce
user:      rillig <rillig%NetBSD.org@localhost>
date:      Mon Aug 31 16:42:10 2020 +0000

description:
make(1): improve documentation for Buffer fields

diffstat:

 usr.bin/make/buf.h |  8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)

diffs (22 lines):

diff -r 54603a771cf8 -r 1d41cb6522ce usr.bin/make/buf.h
--- a/usr.bin/make/buf.h        Mon Aug 31 16:41:19 2020 +0000
+++ b/usr.bin/make/buf.h        Mon Aug 31 16:42:10 2020 +0000
@@ -1,4 +1,4 @@
-/*     $NetBSD: buf.h,v 1.26 2020/08/25 17:37:09 rillig Exp $  */
+/*     $NetBSD: buf.h,v 1.27 2020/08/31 16:42:10 rillig Exp $  */
 
 /*
  * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
@@ -83,9 +83,9 @@
 #include <stddef.h>
 
 typedef struct Buffer {
-    size_t size;       /* Current size of the buffer */
-    size_t count;      /* Number of bytes in buffer */
-    char *buffer;      /* The buffer itself (zero terminated) */
+    size_t size;       /* Allocated size of the buffer, including the null */
+    size_t count;      /* Number of bytes in buffer, excluding the null */
+    char *buffer;      /* The buffer itself (null-terminated) */
 } Buffer;
 
 /* If we aren't on NetBSD, __predict_false() might not be defined. */