[PATCH v2] api-argv-array.txt: Remove broken link to string-list API
- Date: Thu, 5 Oct 2017 23:14:56 -0400
- From: Todd Zullinger <tmz@xxxxxxxxx>
- Subject: [PATCH v2] api-argv-array.txt: Remove broken link to string-list API
In 4f665f2cf3 (string-list.h: move documentation from Documentation/api/
into header, 2017-09-26) the string-list API documentation was moved to
string-list.h. The argv-array API documentation may follow a similar
course in the future. Until then, prevent the broken link from making
it to the end-user documentation.
Signed-off-by: Todd Zullinger <tmz@xxxxxxxxx>
Junio C Hamano wrote:
> Probably removing the link is the right thing to do.
Excellent. Thank you for detailing the likely progression as well as
the preferred solution.
Documentation/technical/api-argv-array.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/technical/api-argv-array.txt b/Documentation/technical/api-argv-array.txt
index cfc063018c..870c8edbfb 100644
@@ -8,7 +8,7 @@ always NULL-terminated at the element pointed to by `argv[argc]`. This
makes the result suitable for passing to functions expecting to receive
argv from main(), or the link:api-run-command.html[run-command API].
-The link:api-string-list.html[string-list API] is similar, but cannot be
+The string-list API (documented in string-list.h) is similar, but cannot be
used for these purposes; instead of storing a straight string pointer,
it contains an item structure with a `util` field that is not compatible
with the traditional argv interface.