Re: [PATCH] Strbuf documentation: document most functions
From: Junio C Hamano <hidden>
Date: 2016-06-15 22:44:40
Miklos Vajna [off-list ref] writes:
All functions in strbuf.h are documented, except strbuf_expand() and launch_editor(). Signed-off-by: Miklos Vajna <redacted> --- Actually this is a bit of request for help,...
In that case,...
quoted hunk
diff --git a/Documentation/technical/api-strbuf.txt b/Documentation/technical/api-strbuf.txt index a52e4f3..3879e0e 100644 --- a/Documentation/technical/api-strbuf.txt +++ b/Documentation/technical/api-strbuf.txt@@ -1,6 +1,175 @@ strbuf API ========== -Talk about <strbuf.h> +strbuf's can be use in many ways: as a byte array, or to store arbitrary +long, overflow safe strings. -(Pierre, JC)
I expected somebody who touches this file to take hints from these names before removing them ;-) I'm still at work so I won't be commenting on them in this message but I'll take a look at it later. Pierre Cc'ed.