From: Jonathan Nieder <jrnieder@gmail.com>
To: Todd Zullinger <tmz@pobox.com>
Cc: Junio C Hamano <gitster@pobox.com>,
git@vger.kernel.org, Han-Wen Nienhuys <hanwen@google.com>
Subject: Re: [PATCH v2] api-argv-array.txt: Remove broken link to string-list API
Date: Thu, 5 Oct 2017 20:45:38 -0700 [thread overview]
Message-ID: <20171006034538.GA142701@aiede.mtv.corp.google.com> (raw)
In-Reply-To: <20171006031456.9632-1-tmz@pobox.com>
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 <tmz@pobox.com>
> ---
> Documentation/technical/api-argv-array.txt | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
Reviewed-by: Jonathan Nieder <jrnieder@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.
next prev parent reply other threads:[~2017-10-06 3:45 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-05 21:12 [PATCH] api-argv-array.txt: Update link to string-list API Todd Zullinger
2017-10-06 2:38 ` Junio C Hamano
2017-10-06 3:14 ` [PATCH v2] api-argv-array.txt: Remove broken " Todd Zullinger
2017-10-06 3:45 ` Jonathan Nieder [this message]
2017-10-06 4:08 ` Todd Zullinger
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171006034538.GA142701@aiede.mtv.corp.google.com \
--to=jrnieder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=hanwen@google.com \
--cc=tmz@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).