Todd Zullinger wrote: > 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 <t...@pobox.com> > --- > Documentation/technical/api-argv-array.txt | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-)
Reviewed-by: Jonathan Nieder <jrnie...@gmail.com> Thanks for catching it. Do you use a broken link detection tool to detect this kind of issue automatically? [...] > --- a/Documentation/technical/api-argv-array.txt > +++ b/Documentation/technical/api-argv-array.txt > @@ -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.
