m_backup.c: Move interface to own file.

[nmh] / sbr / read_line.c

diff --git a/sbr/read_line.c b/sbr/read_line.c
index 51fa87d97cc54878f2fdeab9970ad0c2b29b025d..5f33cac6c731375b754442535a1a79c3bb6a8fea 100644 (file)
--- a/sbr/read_line.c
+++ b/sbr/read_line.c
@@ -1,6 +1,19 @@
-#include <h/mh.h>
-#include <h/utils.h>
+/* read_line.c -- read a possibly incomplete line from stdin.
+ *
+ * This code is Copyright (c) 2017, by the authors of nmh.  See the
+ * COPYRIGHT file in the root directory of the nmh distribution for
+ * complete copyright information.
+ */
 
+#include "h/mh.h"
+#include "h/utils.h"
+#include "read_line.h"
+
+/*
+ * Flush standard output, read a line from standard input into a static buffer,
+ * zero out the newline, and return a pointer to the buffer.
+ * On error, return NULL.
+ */
 const char *
 read_line(void)
 {
@@ -9,7 +22,7 @@ read_line(void)
     fflush(stdout);
     if (fgets(line, sizeof(line), stdin) == NULL)
             return NULL;
-    TrimSuffixC(line, '\n');
+    trim_suffix_c(line, '\n');
 
     return line; /* May not be a complete line. */
 }