From: "Timothy B. Terriberry" <tterribe@xiph.org>

Fixes the example module documentation ccanlint outputs. The
missing \n meant that it would not validate its own example as valid
documentation (with no explanation of why it was invalid... but that
would be a much larger patch).

diff --git a/tools/ccanlint/has_info_documentation.c b/tools/ccanlint/has_info_documentation.c
index 2f2c369db186c8132b9a27f66998c7ee81e5d11f..3142b7b0f16243e0957679bce2ede873dd71d82f 100644 (file)
--- a/tools/ccanlint/has_info_documentation.c
+++ b/tools/ccanlint/has_info_documentation.c
@@ -56,7 +56,7 @@ static void create_info_template_doc(struct manifest *m, void *check_result)
                err(1, "Creating _info.c.new to insert documentation");
 
        if (fprintf(new,
                err(1, "Creating _info.c.new to insert documentation");
 
        if (fprintf(new,

-                   "/**"
+                   "/**\n"

                    " * %s - [[ONE LINE DESCRIPTION HERE]]\n"
                    " *\n"
                    " * Paragraphs why %s exists and where to use it.\n"
                    " * %s - [[ONE LINE DESCRIPTION HERE]]\n"
                    " *\n"
                    " * Paragraphs why %s exists and where to use it.\n"