Mon Aug 31 16:42:10 2020 UTC ()

make(1): improve documentation for Buffer fields


(rillig)

diff -r1.26 -r1.27 src/usr.bin/make/buf.h

--- src/usr.bin/make/buf.h 2020/08/25 17:37:09	1.26
+++ src/usr.bin/make/buf.h 2020/08/31 16:42:10	1.27

 @@ -1,14 +1,14 @@
-/*	$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.
+ *
  * 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.
  * 2. Redistributions in binary form must reproduce the above copyright
 @@ -73,29 +73,29 @@
  */
 /*-
  * buf.h --
  *	Automatically growing null-terminated buffer of characters.
  */
 #ifndef MAKE_BUF_H
 #define MAKE_BUF_H
 #include <stddef.h>
 typedef struct Buffer {
-    size_t size;	/* Current size of the buffer */
+    size_t size;	/* Allocated size of the buffer, including the null */
-    size_t count;	/* Number of bytes in buffer */
+    size_t count;	/* Number of bytes in buffer, excluding the null */
-    char *buffer;	/* The buffer itself (zero terminated) */
+    char *buffer;	/* The buffer itself (null-terminated) */
 } Buffer;
 /* If we aren't on NetBSD, __predict_false() might not be defined. */
 #ifndef __predict_false
 #define __predict_false(x) (x)
 #endif
 void Buf_Expand_1(Buffer *);
 /* Buf_AddByte adds a single byte to a buffer. */
 static inline void MAKE_ATTR_UNUSED
 Buf_AddByte(Buffer *bp, char byte)
+{