{"thread":{"id":"46919","subject":"[PATCH] api-argv-array.txt: Update link to string-list API","startedAt":"2017-10-05T21:12:56Z","lastAt":"2017-10-06T04:08:55Z","messageCount":5,"participants":["Todd Zullinger","Junio C Hamano","Jonathan Nieder"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"329810","messageId":"20171005211203.11913-1-tmz@pobox.com","threadId":"46919","inReplyTo":null,"subject":"[PATCH] api-argv-array.txt: Update link to string-list API","fromName":"Todd Zullinger","fromEmail":"tmz@pobox.com","sentAt":"2017-10-05T21:12:03Z","receivedAt":"2017-10-05T21:12:56Z","isPatch":true,"sender":{"key":"tmz@pobox.com","avatar":"https://avatars.githubusercontent.com/u/806319?v=4"},"body":"In 4f665f2cf3 (string-list.h: move documentation from Documentation/api/\ninto header, 2017-09-26) the string-list API documentation was moved\ninto string-list.h. Fix the link from the argv-array API documentation.\n\nSigned-off-by: Todd Zullinger \n---\n\nHi,\n\nI noticed this broken link in the html documentation while building\n2.15.0-rc0. I'm not sure whether it's better to point the link to the\nstring-list.h file on Git Hub, remove the link, or drop the entire\nparagraph.\n\nThe change I made to remove the link was simply:\n\n-The link:api-string-list.html[string-list API] is similar, but cannot be\n+The string-list API (documented in string-list.h) is similar, but cannot be\n\n Documentation/technical/api-argv-array.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/technical/api-argv-array.txt b/Documentation/technical/api-argv-array.txt\nindex cfc063018c..1603f4a941 100644\n--- a/Documentation/technical/api-argv-array.txt\n+++ b/Documentation/technical/api-argv-array.txt\n@@ -8,7 +8,7 @@ always NULL-terminated at the element pointed to by `argv[argc]`. This\n makes the result suitable for passing to functions expecting to receive\n argv from main(), or the link:api-run-command.html[run-command API].\n \n-The link:api-string-list.html[string-list API] is similar, but cannot be\n+The https://raw.githubusercontent.com/git/git/master/string-list.h[string-list API] is similar, but cannot be\n used for these purposes; instead of storing a straight string pointer,\n it contains an item structure with a `util` field that is not compatible\n with the traditional argv interface.\n-- \n2.14.2\n\n"},{"id":"329835","messageId":"xmqq4lrdyp8v.fsf@gitster.mtv.corp.google.com","threadId":"46919","inReplyTo":"20171005211203.11913-1-tmz@pobox.com","subject":"Re: [PATCH] api-argv-array.txt: Update link to string-list API","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-10-06T02:38:40Z","receivedAt":"2017-10-06T02:38:46Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Todd Zullinger writes:\n\n> I noticed this broken link in the html documentation while building\n> 2.15.0-rc0. I'm not sure whether it's better to point the link to the\n> string-list.h file on Git Hub, remove the link, or drop the entire\n> paragraph.\n\nProbably removing the link is the right thing to do. In the longer\nterm, as we move more and more API documentation to the header file,\nwe may want to have a mechanism in the documentation build procedure\nto extract them back to text. And at that point:\n\n - the API doc for argv-array is no longer in api-argv-array.txt in\n the source form;\n\n - however, it would be extacted from argv-array.h and made into\n manpage or html or whatever human readable format.\n\n - the API doc for string-list would also be extracted from\n string-list.h and made into manpage or html or whatever human\n readable format.\n\n - And these two can refer to each other as needed.\n\nBut we are not there yet.\n\n> The change I made to remove the link was simply:\n>\n> -The link:api-string-list.html[string-list API] is similar, but cannot be\n> +The string-list API (documented in string-list.h) is similar, but cannot be\n\nThis is preferrable for now, I would think.\n\n"},{"id":"329838","messageId":"20171006031456.9632-1-tmz@pobox.com","threadId":"46919","inReplyTo":"xmqq4lrdyp8v.fsf@gitster.mtv.corp.google.com","subject":"[PATCH v2] api-argv-array.txt: Remove broken link to string-list API","fromName":"Todd Zullinger","fromEmail":"tmz@pobox.com","sentAt":"2017-10-06T03:14:56Z","receivedAt":"2017-10-06T03:15:10Z","isPatch":true,"sender":{"key":"tmz@pobox.com","avatar":"https://avatars.githubusercontent.com/u/806319?v=4"},"body":"In 4f665f2cf3 (string-list.h: move documentation from Documentation/api/\ninto header, 2017-09-26) the string-list API documentation was moved to\nstring-list.h. The argv-array API documentation may follow a similar\ncourse in the future. Until then, prevent the broken link from making\nit to the end-user documentation.\n\nSigned-off-by: Todd Zullinger \n---\nJunio C Hamano wrote:\n> Probably removing the link is the right thing to do.\n\nExcellent. Thank you for detailing the likely progression as well as\nthe preferred solution.\n\n Documentation/technical/api-argv-array.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/technical/api-argv-array.txt b/Documentation/technical/api-argv-array.txt\nindex cfc063018c..870c8edbfb 100644\n--- a/Documentation/technical/api-argv-array.txt\n+++ b/Documentation/technical/api-argv-array.txt\n@@ -8,7 +8,7 @@ always NULL-terminated at the element pointed to by `argv[argc]`. This\n makes the result suitable for passing to functions expecting to receive\n argv from main(), or the link:api-run-command.html[run-command API].\n \n-The link:api-string-list.html[string-list API] is similar, but cannot be\n+The string-list API (documented in string-list.h) is similar, but cannot be\n used for these purposes; instead of storing a straight string pointer,\n it contains an item structure with a `util` field that is not compatible\n with the traditional argv interface.\n-- \n2.15.0.rc0\n\n"},{"id":"329839","messageId":"20171006034538.GA142701@aiede.mtv.corp.google.com","threadId":"46919","inReplyTo":"20171006031456.9632-1-tmz@pobox.com","subject":"Re: [PATCH v2] api-argv-array.txt: Remove broken link to string-list API","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2017-10-06T03:45:38Z","receivedAt":"2017-10-06T03:45:57Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Todd Zullinger wrote:\n\n> In 4f665f2cf3 (string-list.h: move documentation from Documentation/api/\n> into header, 2017-09-26) the string-list API documentation was moved to\n> string-list.h. The argv-array API documentation may follow a similar\n> course in the future. Until then, prevent the broken link from making\n> it to the end-user documentation.\n>\n> Signed-off-by: Todd Zullinger \n> ---\n> Documentation/technical/api-argv-array.txt | 2 +-\n> 1 file changed, 1 insertion(+), 1 deletion(-)\n\nReviewed-by: Jonathan Nieder \n\nThanks for catching it. Do you use a broken link detection tool to\ndetect this kind of issue automatically?\n\n[...]\n> --- a/Documentation/technical/api-argv-array.txt\n> +++ b/Documentation/technical/api-argv-array.txt\n> @@ -8,7 +8,7 @@ always NULL-terminated at the element pointed to by `argv[argc]`. This\n> makes the result suitable for passing to functions expecting to receive\n> argv from main(), or the link:api-run-command.html[run-command API].\n> \n> -The link:api-string-list.html[string-list API] is similar, but cannot be\n> +The string-list API (documented in string-list.h) is similar, but cannot be\n> used for these purposes; instead of storing a straight string pointer,\n> it contains an item structure with a `util` field that is not compatible\n> with the traditional argv interface.\n"},{"id":"329841","messageId":"20171006040841.GD3382@zaya.teonanacatl.net","threadId":"46919","inReplyTo":"20171006034538.GA142701@aiede.mtv.corp.google.com","subject":"Re: [PATCH v2] api-argv-array.txt: Remove broken link to string-list API","fromName":"Todd Zullinger","fromEmail":"tmz@pobox.com","sentAt":"2017-10-06T04:08:41Z","receivedAt":"2017-10-06T04:08:55Z","isPatch":true,"sender":{"key":"tmz@pobox.com","avatar":"https://avatars.githubusercontent.com/u/806319?v=4"},"body":"Jonathan Nieder wrote:\n> Thanks for catching it. Do you use a broken link detection tool to \n> detect this kind of issue automatically?\n\nYeah, in the Fedora git builds we pass all the generated html files \nthrough the linkchecker tool (http://wummel.github.io/linkchecker/). \n\nWe started using that a few months ago to help us catch broken links \nin case we somehow failed to include some documentation in our \npackaging. (After catching this minor issue I wondered if it might be \nuseful to add something similar to the travis builds, but I haven't \ndone any more than wonder about it. ;)\n\nHere's the (somehwat verbose) output from the failed link check:\n\n$ find /builddir/build/BUILDROOT/git-2.15.0-0.0.rc0.fc25.x86_64/usr/share/doc/git -name '*.html' | xargs linkchecker\n[...]\nStart checking at 2017-10-05 12:37:01-004\n10 threads active, 325 links queued, 194 links in 47 URLs checked, runtime 1 seconds\n10 threads active, 643 links queued, 1242 links in 197 URLs checked, runtime 6 seconds\n\nURL `api-string-list.html'\nName `string-list API'\nParent URL file:///builddir/build/BUILDROOT/git-2.15.0-0.0.rc0.fc25.x86_64/usr/share/doc/git/technical/api-argv-array.html, line 745, col 31\nReal URL file:///builddir/build/BUILDROOT/git-2.15.0-0.0.rc0.fc25.x86_64/usr/share/doc/git/technical/api-string-list.html\nCheck time 0.002 seconds\nResult Error: URLError: \n\nStatistics:\nDownloaded: 7.17MB.\nContent types: 0 image, 2764 text, 0 video, 0 audio, 0 application, 29 mail and 49 other.\nURL lengths: min=17, max=125, avg=96.\n\nThat's it. 2842 links in 232 URLs checked. 0 warnings found. 1 error found.\nStopped checking at 2017-10-05 12:37:09-004 (8 seconds)\n\n-- \nTodd\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nI always wanted to be a procrastinator, never got around to it.\n\n"}]}