{"thread":{"id":"35637","subject":"[PATCH] Create HTML for technical/http-protocol.txt","startedAt":"2014-01-11T11:19:29Z","lastAt":"2014-01-13T18:40:05Z","messageCount":2,"participants":["Thomas Ackermann","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"233021","messageId":"196469122.1795615.1389439169514.JavaMail.ngmail@webmail08.arcor-online.net","threadId":"35637","inReplyTo":null,"subject":"[PATCH] Create HTML for technical/http-protocol.txt","fromName":"Thomas Ackermann","fromEmail":"th.acker@arcor.de","sentAt":"2014-01-11T11:19:29Z","receivedAt":"2014-01-11T11:19:29Z","isPatch":true,"sender":{"key":"th.acker@arcor.de","avatar":"https://avatars.githubusercontent.com/u/1358536?v=4"},"body":"\n- Add to Documentation/Makefile\n- Start every TODO with a new line\n- Fix indentation error\n\nSigned-off-by: Thomas Ackermann <th.acker@arcor.de>\n---\n Documentation/Makefile                    | 1 +\n Documentation/technical/http-protocol.txt | 3 +--\n 2 files changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex 36c58fc..b4a4c82 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -70,6 +70,7 @@ TECH_DOCS += technical/racy-git\n TECH_DOCS += technical/send-pack-pipeline\n TECH_DOCS += technical/shallow\n TECH_DOCS += technical/trivial-merge\n+TECH_DOCS += technical/http-protocol\n SP_ARTICLES += $(TECH_DOCS)\n SP_ARTICLES += technical/api-index\n \ndiff --git a/Documentation/technical/http-protocol.txt b/Documentation/technical/http-protocol.txt\nindex d21d77d..c64a5e9 100644\n--- a/Documentation/technical/http-protocol.txt\n+++ b/Documentation/technical/http-protocol.txt\n@@ -332,6 +332,7 @@ server advertises capability \"allow-tip-sha1-in-want\".\n   have_list         =  *PKT-LINE(\"have\" SP id LF)\n \n TODO: Document this further.\n+\n TODO: Don't use uppercase for variable names below.\n \n The Negotiation Algorithm\n@@ -376,10 +377,8 @@ The computation to select the minimal pack proceeds as follows\n \n      Commands MUST appear in the following order, if they appear\n      at all in the request stream:\n-\n        * want\n        * have\n-\n      The stream is terminated by a pkt-line flush (\"0000\").\n \n      A single \"want\" or \"have\" command MUST have one hex formatted\n-- \n1.8.5.2.msysgit.0\n\n\n---\nThomas\n"},{"id":"233057","messageId":"xmqq38kr7mka.fsf@gitster.dls.corp.google.com","threadId":"35637","inReplyTo":"196469122.1795615.1389439169514.JavaMail.ngmail@webmail08.arcor-online.net","subject":"Re: [PATCH] Create HTML for technical/http-protocol.txt","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2014-01-13T18:40:05Z","receivedAt":"2014-01-13T18:40:05Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Thomas Ackermann <th.acker@arcor.de> writes:\n\n> - Add to Documentation/Makefile\n> - Start every TODO with a new line\n> - Fix indentation error\n>\n> Signed-off-by: Thomas Ackermann <th.acker@arcor.de>\n> ---\n>  Documentation/Makefile                    | 1 +\n>  Documentation/technical/http-protocol.txt | 3 +--\n>  2 files changed, 2 insertions(+), 2 deletions(-)\n>\n> diff --git a/Documentation/Makefile b/Documentation/Makefile\n> index 36c58fc..b4a4c82 100644\n> --- a/Documentation/Makefile\n> +++ b/Documentation/Makefile\n> @@ -70,6 +70,7 @@ TECH_DOCS += technical/racy-git\n>  TECH_DOCS += technical/send-pack-pipeline\n>  TECH_DOCS += technical/shallow\n>  TECH_DOCS += technical/trivial-merge\n> +TECH_DOCS += technical/http-protocol\n\nThe output from \"ls Documentation/technical/[b-z]*.txt\" tells me\nthat this patch makes the TECH_DOCS cover everything (in other\nwords, this is not \"I was intereted in http-protocol.txt; I did not\nbother checking if there are others that are not formatted.\").\n\nWhich is good, but that is something you could have said at the very\nbeginning as the motivation (which cannot be read from the patch)\nbefore going into details of what you did (which can be read in the\npatch).\n\nAlso let's keep them in order and move the new line before the\nindex-format, as h comes before i.\n\n>  SP_ARTICLES += $(TECH_DOCS)\n>  SP_ARTICLES += technical/api-index\n>  \n> diff --git a/Documentation/technical/http-protocol.txt b/Documentation/technical/http-protocol.txt\n> index d21d77d..c64a5e9 100644\n> --- a/Documentation/technical/http-protocol.txt\n> +++ b/Documentation/technical/http-protocol.txt\n> @@ -332,6 +332,7 @@ server advertises capability \"allow-tip-sha1-in-want\".\n>    have_list         =  *PKT-LINE(\"have\" SP id LF)\n>  \n>  TODO: Document this further.\n> +\n>  TODO: Don't use uppercase for variable names below.\n>\n>  The Negotiation Algorithm\n> @@ -376,10 +377,8 @@ The computation to select the minimal pack proceeds as follows\n>  \n>       Commands MUST appear in the following order, if they appear\n>       at all in the request stream:\n> -\n>         * want\n>         * have\n> -\n>       The stream is terminated by a pkt-line flush (\"0000\").\n>  \n>       A single \"want\" or \"have\" command MUST have one hex formatted\n\nThe resulting _source_ file read as txt becomes somewhat harder to\nread with these changes.  Admittedly, it is mostly because the\noriginal text was meant to be easy to read in TEXT, not to be\nformatted via AsciiDoc into HTML.  We can see that in many places in\nthe formatted output with your patch.  For example:\n\n - Strings like \"200 OK\", \"304 Not Modified\", \"HEAD\" are italicized\n   (\"Discovering References\" section); \"GET\" request is shown as\n   Roman body text.  I think in our documentation it is customery to\n   typeset these \"as-is\" things in monospaced.\n\n - \"dumb server reply:\", \"smart server reply:\" (\"Smart Clients\"\n   section) are shown in monospace just like the actual protocol\n   message examples that follow them, but we would most likely want\n   to see them as part of the body text.\n\n - As all the descriptions of steps in the Negotiation Algorithm are\n   indented, the AsciiDoc formatted result becomes just a series of\n   fixed-font blocks around there.\n\nSo,... I think this patch may be a good first step, but it needs to\nbe followed by another that cleans up the mark-up in order for the\nresulting HTML to be truly usable.\n\nThanks.\n"}]}