membuf: Minor code-style improvements
authorSimon Glass <sjg@chromium.org>
Tue, 18 Mar 2025 15:20:48 +0000 (16:20 +0100)
committerTom Rini <trini@konsulko.com>
Thu, 3 Apr 2025 22:54:49 +0000 (16:54 -0600)
Show the start in end in the comment. Comment a missing variable in
membuf_readline() and fix its line length.

Signed-off-by: Simon Glass <sjg@chromium.org>
include/membuf.h
lib/membuf.c

index 636ed70..4676469 100644 (file)
@@ -25,7 +25,7 @@
  *
  * .............xxxxxxxxxxxxxxxx.........................
  *             ^               ^
- *             tail            head
+ * ^start      tail            head                     ^end
  *
  * xxxxxxxxxxxxx................xxxxxxxxxxxxxxxxxxxxxxxxx
  *             ^               ^
@@ -194,11 +194,13 @@ int membuf_free(struct membuf *mb);
  * @mb: membuff to adjust
  * @str: Place to put the line
  * @maxlen: Maximum line length (excluding terminator)
+ * @minch: Minimum ASCII character to permit as part of the line (e.g. ' ')
  * @must_fit: If true then str is empty if line doesn't fit
  * Return: number of bytes read (including terminator) if a line has been
  *        read, 0 if nothing was there or line didn't fit when must_fit is set
  */
-int membuf_readline(struct membuf *mb, char *str, int maxlen, int minch, bool must_fit);
+int membuf_readline(struct membuf *mb, char *str, int maxlen, int minch,
+                   bool must_fit);
 
 /**
  * membuf_extend_by() - expand a membuff
index 695d16d..f38ff36 100644 (file)
@@ -287,7 +287,8 @@ int membuf_free(struct membuf *mb)
                        (mb->end - mb->start) - 1 - membuf_avail(mb);
 }
 
-int membuf_readline(struct membuf *mb, char *str, int maxlen, int minch, bool must_fit)
+int membuf_readline(struct membuf *mb, char *str, int maxlen, int minch,
+                   bool must_fit)
 {
        int len;  /* number of bytes read (!= string length) */
        char *s, *end;