From patchwork Fri Mar 29 12:35:15 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?SZEDER_G=C3=A1bor?= X-Patchwork-Id: 10876971 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id CAA8A922 for ; Fri, 29 Mar 2019 12:35:36 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id B668D28FFD for ; Fri, 29 Mar 2019 12:35:36 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id AA71E29006; Fri, 29 Mar 2019 12:35:36 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 5848A28FFD for ; Fri, 29 Mar 2019 12:35:36 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729522AbfC2Mfe (ORCPT ); Fri, 29 Mar 2019 08:35:34 -0400 Received: from mail-wr1-f66.google.com ([209.85.221.66]:40146 "EHLO mail-wr1-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729472AbfC2Mfd (ORCPT ); Fri, 29 Mar 2019 08:35:33 -0400 Received: by mail-wr1-f66.google.com with SMTP id h4so2401840wre.7 for ; Fri, 29 Mar 2019 05:35:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=J6dWr6A6810kFLcrncLWbeqlzOLeTtogdcqCfQjl0kQ=; b=l5gb3Smg+Ex0xeTtVHj69DAGp2MH97D6+qsML6l0m72A3hH/hjgyfO+NF3ijmfmQ1Q Sx2cFn56yscPy7WOTfyA4sAvduR2N21RMeDyQELErSIhwoTWUzbIwenubE2SCAwMR46e U74NaB35YeFb1+J2mF7hshGv53dgPxgXMswkZJIvrEz0+V9sL4+zDkOcwjga7pX5KC8O Y24W9sP3dZrbtOGT9eAiP2YJ8xtLf9RVqIcyhMpSeyYQoDukxqKCm2OlbZg88QGq0VHR pVVHJPRgOgnS7qygW9vrBG0PwBTyyv1jkFm5EmyBCt6FZYooC0Jl646kTxHrVVjdAMQe apyw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=J6dWr6A6810kFLcrncLWbeqlzOLeTtogdcqCfQjl0kQ=; b=bNbXLnrEVNFEB4N7pQGRrwfgBvufhxIm3v5K8NSza3rSmOTLFUsirSFJVCAxb5kbWi /66RPH1PBxwFK76lDQil6z59lwIP5IuHiokosTxAkqBUQw8HmaQzmDFC08SCo2LI1XQf dXOKc0hdXLAGIoIuaT3pqDgvpUPgCISboe7gPMbcjUq4e6zPQJrsvKbUfQqqjuR3O8bl 7lSCD4H+5CukXf/Pqd1YX6Z6lMHI5qcFaNLvuf5EcWWvglC6/xOhaE0D0BxhjxmgbTZI ZaThrZCFg1VjXl4dzv5q+xbCOgeUaIQgk1EqWKmdGoINYDRJ/aK8MZolemzU2bbV/+1x ebkQ== X-Gm-Message-State: APjAAAV3jdw14W3llFfu0yjj1yn11Gb2VpxvBFgj/0oaPsSgHLisDZex bYLMd97gCCoM/wQ6rxFi7Y2AhLDk X-Google-Smtp-Source: APXvYqx6RrMFvnbW3CpjXZNIpZOPZqeUbD6DNhU75FChb9skyAe5zbM5gkBXQYykhVeOKw+rVBuTgw== X-Received: by 2002:a5d:4446:: with SMTP id x6mr10461498wrr.147.1553862932049; Fri, 29 Mar 2019 05:35:32 -0700 (PDT) Received: from localhost.localdomain (x4dbd3bb2.dyn.telefonica.de. [77.189.59.178]) by smtp.gmail.com with ESMTPSA id 61sm7341781wre.50.2019.03.29.05.35.30 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 29 Mar 2019 05:35:31 -0700 (PDT) From: =?utf-8?q?SZEDER_G=C3=A1bor?= To: Junio C Hamano Cc: git@vger.kernel.org, Jeff King , Todd Zullinger , =?utf-8?q?Martin_=C3=85gren?= , "brian m. carlson" , Johannes Schindelin , =?utf-8?q?SZEDER_G=C3=A1b?= =?utf-8?q?or?= Subject: [PATCH v3 1/6] Documentation/git-diff-tree.txt: fix formatting Date: Fri, 29 Mar 2019 13:35:15 +0100 Message-Id: <20190329123520.27549-2-szeder.dev@gmail.com> X-Mailer: git-send-email 2.21.0.539.g07239c3a71.dirty In-Reply-To: <20190329123520.27549-1-szeder.dev@gmail.com> References: <20190324215534.9495-1-szeder.dev@gmail.com> <20190329123520.27549-1-szeder.dev@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Asciidoctor versions v1.5.7 or later print the following warning while building the documentation: ASCIIDOC git-diff-tree.xml asciidoctor: WARNING: diff-format.txt: line 2: unterminated listing block This highlights an issue (even with older Asciidoctor versions) where the "Raw output format" header is not rendered as a header, and the rest of the document is rendered in monospace. This is not caused by 'diff-format.txt' in itself, but rather by 'git-diff-tree.txt' including 'pretty-formats.txt' and 'diff-format.txt' on subsequent lines, while the former happens to end with monospace-formatted example commands. Fix this by inserting an empty line between the two include:: directives. The page rendered with AsciiDoc doesn't have this formatting issue. Signed-off-by: SZEDER Gábor --- Documentation/git-diff-tree.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 24f32e8c54..5c8a2a5e97 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -118,6 +118,7 @@ include::pretty-options.txt[] include::pretty-formats.txt[] + include::diff-format.txt[] GIT From patchwork Fri Mar 29 12:35:16 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?SZEDER_G=C3=A1bor?= X-Patchwork-Id: 10876973 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 3FF9A922 for ; Fri, 29 Mar 2019 12:35:38 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 2CB6728FFD for ; Fri, 29 Mar 2019 12:35:38 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 20D2D205FD; Fri, 29 Mar 2019 12:35:38 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id C705328FFD for ; Fri, 29 Mar 2019 12:35:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729529AbfC2Mfg (ORCPT ); Fri, 29 Mar 2019 08:35:36 -0400 Received: from mail-wr1-f65.google.com ([209.85.221.65]:46320 "EHLO mail-wr1-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729438AbfC2Mff (ORCPT ); Fri, 29 Mar 2019 08:35:35 -0400 Received: by mail-wr1-f65.google.com with SMTP id t17so2370898wrw.13 for ; Fri, 29 Mar 2019 05:35:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=aosOI7X8jOegorDWKC5cBD8GjBzQO0+hNli2kaJQGcg=; b=WKiy5A8sp3g5M7o/zG53RYoQ0B1018fGdZAFrTdPvnJpTcloljNtt3uyEkNAj1P5YK ug2V0trIQ1NKKZZhXZhlhP8GWQnXLtZys2HJVSjxYMTGtSWBap+dZkn+PKvgxy324sVf W0URRcXZckhX3dN4qf0t0JJ89Rib0bLCI3Aybk42RnmrnAq7kwdVGCylTvrb2QvbQvYh X5ml5BFEpAGohHoyGBvYNAgJ6UAXtL9K1gQGD2nc2kFKfqony/zQUPT4ikMJ27aJHe0W N8d1XQ8J+gmmfjZhD+uuUgEjRVtMoOb9ESTq3LlpVAXZke7P30uxb/bWlFWefiEdHf0b EHNg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=aosOI7X8jOegorDWKC5cBD8GjBzQO0+hNli2kaJQGcg=; b=pIhP8XtXRCX9+p1FWnGS3ro1PhQRiElBvFxtlivT/kGjxK337iskdxu3E598R97aCb NEGYY+WjB4dgEtte4CO1XSB2l3HVprtULQ19PKpyKvFU/vnALnkuV+dIKxtX7tezI6yS /3XDvOkxmvIG9AO7JC7mwQ/RVxpi80COP3OYeqc0X8h1AC1o8EbeZdTs6CT/tRhLQMl0 UBdeJBFcn16UHuBTeq2UTbxJG9A3Ha4823vLZ2oJzcqXNotHbx8THPhg72ESkaTVYj38 usxpPnAfYo5bLgr518h6GXTUozxEzyN3/62XZCaxkX5sUj05q9RguqD9PmJBeSRlWHZU ahVQ== X-Gm-Message-State: APjAAAV8QwVjvSFARd+Zx9Y6U0V2tLwZMweJHrAPILlnLt+TUF+UH0Qj GpGXp/Wj/124ls+hPXggoDs= X-Google-Smtp-Source: APXvYqzE9LCRRP6CX2ufauIBql/KVkLzZLQj9bY7fygxqOUOLHtTmQnlJT1bW2vqeQ653Q+fagDXig== X-Received: by 2002:a05:6000:1292:: with SMTP id f18mr31951646wrx.115.1553862933124; Fri, 29 Mar 2019 05:35:33 -0700 (PDT) Received: from localhost.localdomain (x4dbd3bb2.dyn.telefonica.de. [77.189.59.178]) by smtp.gmail.com with ESMTPSA id 61sm7341781wre.50.2019.03.29.05.35.32 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 29 Mar 2019 05:35:32 -0700 (PDT) From: =?utf-8?q?SZEDER_G=C3=A1bor?= To: Junio C Hamano Cc: git@vger.kernel.org, Jeff King , Todd Zullinger , =?utf-8?q?Martin_=C3=85gren?= , "brian m. carlson" , Johannes Schindelin , =?utf-8?q?SZEDER_G=C3=A1b?= =?utf-8?q?or?= Subject: [PATCH v3 2/6] Documentation/technical/api-config.txt: fix formatting Date: Fri, 29 Mar 2019 13:35:16 +0100 Message-Id: <20190329123520.27549-3-szeder.dev@gmail.com> X-Mailer: git-send-email 2.21.0.539.g07239c3a71.dirty In-Reply-To: <20190329123520.27549-1-szeder.dev@gmail.com> References: <20190324215534.9495-1-szeder.dev@gmail.com> <20190329123520.27549-1-szeder.dev@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Asciidoctor versions v1.5.7 or later print the following warning while building the documentation: ASCIIDOC technical/api-config.html asciidoctor: WARNING: api-config.txt: line 232: unterminated listing block This highlight an issue (even with older Asciidoctor versions) where the length of the '----' lines surrounding a code example don't match, and the rest of the document is rendered in monospace. Fix this by making sure that the length of those lines match. The page rendered with AsciiDoc doesn't have this formatting issue. Signed-off-by: SZEDER Gábor --- Documentation/technical/api-config.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/technical/api-config.txt b/Documentation/technical/api-config.txt index fa39ac9d71..7d20716c32 100644 --- a/Documentation/technical/api-config.txt +++ b/Documentation/technical/api-config.txt @@ -229,7 +229,7 @@ A `config_set` can be used to construct an in-memory cache for config-like files that the caller specifies (i.e., files like `.gitmodules`, `~/.gitconfig` etc.). For example, ---------------------------------------- +---------------------------------------- struct config_set gm_config; git_configset_init(&gm_config); int b; From patchwork Fri Mar 29 12:35:17 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?SZEDER_G=C3=A1bor?= X-Patchwork-Id: 10876979 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 7944F922 for ; Fri, 29 Mar 2019 12:35:41 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 64A83205FD for ; Fri, 29 Mar 2019 12:35:41 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 56AE928FF5; Fri, 29 Mar 2019 12:35:41 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id AD7C8205FD for ; Fri, 29 Mar 2019 12:35:40 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729535AbfC2Mfi (ORCPT ); Fri, 29 Mar 2019 08:35:38 -0400 Received: from mail-wr1-f68.google.com ([209.85.221.68]:36778 "EHLO mail-wr1-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729472AbfC2Mfg (ORCPT ); Fri, 29 Mar 2019 08:35:36 -0400 Received: by mail-wr1-f68.google.com with SMTP id y13so2432568wrd.3 for ; Fri, 29 Mar 2019 05:35:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=5PBiKF8zEpvtgpPoQZBnfSCqx9N/ons4aX+0a2zMnz0=; b=AIaz33STGl4J9xXyHC6ZhhNwmMd3/Fnx/mP8xSoLY1Qe1K5sumH/owM29VpWoeb7NO Th3P0qDuho9h4zNpoxMyXFWOeg0/NcVAxr+GPj+1vOhQR6goi+PcLTGydYk1XV24bh9t XO1K6pWg5qbuJRd5p6B1mZubo6gSeFlk3AfSnJRFwatoZ+HXBjtxdVrFh314oOBl3ikU FUCMW7I1ZcrpqVdWsBRTWtEgXvj9lw1GCNH9JL/4u6AgvhN0Llfrp3S3fQsTZxpCTS5z 20umNmvY9h2WPNsOtj1aed5lgCFGC9ke+lqsF9+cA6OAGnXVLZxiEWe0RuSzjZqMmOLV z16w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=5PBiKF8zEpvtgpPoQZBnfSCqx9N/ons4aX+0a2zMnz0=; b=TQyIwt15966eP6DqLHXDe7khr1DVIKISv3dDnfyVYiN76qrKQtXoyQyQr9c2td1IFV 0nspdcfHOpNXOjYrL30+QThl6WLeu1lF11HRJehxedXZ9NIC0blGjRlf1REFZKpXDrmY tSdFq2YlFfeowBrxEbGQ3qtefA8WWvXQysmtWEU8GLEJf4tSxvr/NLZJpnsJKbp6vU5q 9iT1wlUu8hYLFfpMExF14GTUBJ949KYk/gyddtcwHiQgSGyJ2Em8Xh0Dmy6lz5YWiLDb TW4nK8jqB5zqicDhH5wzHv1X6dXdUoqMtiAd02XKrJx+dIeH4/mF/9cFipt0bDfKcXVu pr2w== X-Gm-Message-State: APjAAAWeXeXxGWw5Jgx7J5Z/z5t0DAXvK7U/nXiAHf89QV8QLMqHBT5H z9AHwmI4KZGPodMr3e6ROtc= X-Google-Smtp-Source: APXvYqzTWvipnd9sXmsnwbGImDVzrpCHXtQViQjt6Y3ah0OPxWaFGhJQzrE+a9nR1KWDLzpymAhUgQ== X-Received: by 2002:adf:8367:: with SMTP id 94mr33024150wrd.46.1553862934256; Fri, 29 Mar 2019 05:35:34 -0700 (PDT) Received: from localhost.localdomain (x4dbd3bb2.dyn.telefonica.de. [77.189.59.178]) by smtp.gmail.com with ESMTPSA id 61sm7341781wre.50.2019.03.29.05.35.33 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 29 Mar 2019 05:35:33 -0700 (PDT) From: =?utf-8?q?SZEDER_G=C3=A1bor?= To: Junio C Hamano Cc: git@vger.kernel.org, Jeff King , Todd Zullinger , =?utf-8?q?Martin_=C3=85gren?= , "brian m. carlson" , Johannes Schindelin , =?utf-8?q?SZEDER_G=C3=A1b?= =?utf-8?q?or?= Subject: [PATCH v3 3/6] Documentation/technical/protocol-v2.txt: fix formatting Date: Fri, 29 Mar 2019 13:35:17 +0100 Message-Id: <20190329123520.27549-4-szeder.dev@gmail.com> X-Mailer: git-send-email 2.21.0.539.g07239c3a71.dirty In-Reply-To: <20190329123520.27549-1-szeder.dev@gmail.com> References: <20190324215534.9495-1-szeder.dev@gmail.com> <20190329123520.27549-1-szeder.dev@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Asciidoctor versions v1.5.7 or later print the following warning while building the documentation: ASCIIDOC technical/protocol-v2.html asciidoctor: WARNING: protocol-v2.txt: line 38: unterminated listing block This highlights an issue (even with older Asciidoctor versions) where the 'Initial Client Request' header is not rendered as a header but in monospace. I'm not sure what exactly causes this issue and why it's an issue only with this particular header, but all headers in 'protocol-v2.txt' are written like this: Initial Client Request ------------------------ i.e. the header itself is indented by a space, and the "underline" is two characters longer than the header. Dropping that indentation and making the length of the underline match the length of the header apparently fixes this issue. While at it, adjust all other headers 'protocol-v2.txt' as well, to match the style we use everywhere else. The page rendered with AsciiDoc doesn't have this formatting issue. Signed-off-by: SZEDER Gábor --- Documentation/technical/protocol-v2.txt | 52 ++++++++++++------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/Documentation/technical/protocol-v2.txt b/Documentation/technical/protocol-v2.txt index ead85ce35c..03264c7d9a 100644 --- a/Documentation/technical/protocol-v2.txt +++ b/Documentation/technical/protocol-v2.txt @@ -1,5 +1,5 @@ - Git Wire Protocol, Version 2 -============================== +Git Wire Protocol, Version 2 +============================ This document presents a specification for a version 2 of Git's wire protocol. Protocol v2 will improve upon v1 in the following ways: @@ -22,8 +22,8 @@ will be commands which a client can request be executed. Once a command has completed, a client can reuse the connection and request that other commands be executed. - Packet-Line Framing ---------------------- +Packet-Line Framing +------------------- All communication is done using packet-line framing, just as in v1. See `Documentation/technical/pack-protocol.txt` and @@ -34,8 +34,8 @@ In protocol v2 these special packets will have the following semantics: * '0000' Flush Packet (flush-pkt) - indicates the end of a message * '0001' Delimiter Packet (delim-pkt) - separates sections of a message - Initial Client Request ------------------------- +Initial Client Request +---------------------- In general a client can request to speak protocol v2 by sending `version=2` through the respective side-channel for the transport being @@ -43,22 +43,22 @@ used which inevitably sets `GIT_PROTOCOL`. More information can be found in `pack-protocol.txt` and `http-protocol.txt`. In all cases the response from the server is the capability advertisement. - Git Transport -~~~~~~~~~~~~~~~ +Git Transport +~~~~~~~~~~~~~ When using the git:// transport, you can request to use protocol v2 by sending "version=2" as an extra parameter: 003egit-upload-pack /project.git\0host=myserver.com\0\0version=2\0 - SSH and File Transport -~~~~~~~~~~~~~~~~~~~~~~~~ +SSH and File Transport +~~~~~~~~~~~~~~~~~~~~~~ When using either the ssh:// or file:// transport, the GIT_PROTOCOL environment variable must be set explicitly to include "version=2". - HTTP Transport -~~~~~~~~~~~~~~~~ +HTTP Transport +~~~~~~~~~~~~~~ When using the http:// or https:// transport a client makes a "smart" info/refs request as described in `http-protocol.txt` and requests that @@ -79,8 +79,8 @@ A v2 server would reply: Subsequent requests are then made directly to the service `$GIT_URL/git-upload-pack`. (This works the same for git-receive-pack). - Capability Advertisement --------------------------- +Capability Advertisement +------------------------ A server which decides to communicate (based on a request from a client) using protocol version 2, notifies the client by sending a version string @@ -101,8 +101,8 @@ to be executed by the client. key = 1*(ALPHA | DIGIT | "-_") value = 1*(ALPHA | DIGIT | " -_.,?\/{}[]()<>!@#$%^&*+=:;") - Command Request ------------------ +Command Request +--------------- After receiving the capability advertisement, a client can then issue a request to select the command it wants with any particular capabilities @@ -137,8 +137,8 @@ command be executed or can terminate the connection. A client may optionally send an empty request consisting of just a flush-pkt to indicate that no more requests will be made. - Capabilities --------------- +Capabilities +------------ There are two different types of capabilities: normal capabilities, which can be used to to convey information or alter the behavior of a @@ -153,8 +153,8 @@ management on the server side in order to function correctly. This permits simple round-robin load-balancing on the server side, without needing to worry about state management. - agent -~~~~~~~ +agent +~~~~~ The server can advertise the `agent` capability with a value `X` (in the form `agent=X`) to notify the client that the server is running version @@ -168,8 +168,8 @@ printable ASCII characters except space (i.e., the byte range 32 < x < and debugging purposes, and MUST NOT be used to programmatically assume the presence or absence of particular features. - ls-refs -~~~~~~~~~ +ls-refs +~~~~~~~ `ls-refs` is the command used to request a reference advertisement in v2. Unlike the current reference advertisement, ls-refs takes in arguments @@ -199,8 +199,8 @@ The output of ls-refs is as follows: symref = "symref-target:" symref-target peeled = "peeled:" obj-id - fetch -~~~~~~~ +fetch +~~~~~ `fetch` is the command used to fetch a packfile in v2. It can be looked at as a modified version of the v1 fetch where the ref-advertisement is @@ -444,8 +444,8 @@ header. 2 - progress messages 3 - fatal error message just before stream aborts - server-option -~~~~~~~~~~~~~~~ +server-option +~~~~~~~~~~~~~ If advertised, indicates that any number of server specific options can be included in a request. This is done by sending each option as a From patchwork Fri Mar 29 12:35:18 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?SZEDER_G=C3=A1bor?= X-Patchwork-Id: 10876977 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id D8E01922 for ; Fri, 29 Mar 2019 12:35:39 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id C4873205FD for ; Fri, 29 Mar 2019 12:35:39 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id B890128FF5; Fri, 29 Mar 2019 12:35:39 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 67EC2205FD for ; Fri, 29 Mar 2019 12:35:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729538AbfC2Mfi (ORCPT ); Fri, 29 Mar 2019 08:35:38 -0400 Received: from mail-wr1-f68.google.com ([209.85.221.68]:43949 "EHLO mail-wr1-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729523AbfC2Mfh (ORCPT ); Fri, 29 Mar 2019 08:35:37 -0400 Received: by mail-wr1-f68.google.com with SMTP id k17so2390766wrx.10 for ; Fri, 29 Mar 2019 05:35:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=dw8XUQv31vGhlc/arzk1yLc2F1VrYfPHX1YMJ4abEnM=; b=rEpCCQ+lpyVAWgL6J0l0seNjTpEvYp+AB5V9L+M6WQRGQhhYO+ry92xTCwzIRdV6iU 1gKRDFRqTUDatXvW3k1Mx0vyAU21OCrHeVUZT7s1ESpmBjrr6cd6yuJTJ1evcHHp3+2h o12WE5MuuXlLbW07bWxEFgaQShgT8p4Xcmz435Z3ZD3xiQE25Wg2qYI6T/V2z3pYus3G 3gg5PPPOdUDevAHBMu03nTxquhg9/XWCc5Jf433Q5VxLhQOaS1Wgiv2EtmErJIIPywYI YU+3UeeA16/HsIfiBXOYOKEYlCTRuO4hHqOIFXBb4F+g+F8lsUrylfdDMFkenCOcoHG8 gFMg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=dw8XUQv31vGhlc/arzk1yLc2F1VrYfPHX1YMJ4abEnM=; b=FmRzopZQ9qRQWkeXL5wKesJNeG4Qyh4jAYytc/qL5iw0XrlNRqMZqGYncDgjddEkze dCCQaOEroH3T2RMeYAPOCOyr+ud+jLyEuez14ywh7UYK1rl+ehBZG7qvgp0quy7bGhod TKF+TQNuknLkpZQ4G9KyMnTldwQk3+JwTZE9fBCgIrQTnP6H5ynYCWyDxhgb2zyAeZC3 Kuu31u4Ioa01AZC+JTH+8XP2icC2hR7OBID7r3tEGdAVJPhw9GNNKKRKE4RNYFlt6Pv7 COeXQCMOwOCeA5j4mCPKC1BIO+fVMniO2bQ8ox/B7e/7rj2PRsV6BHKCiw6bHWuRW9v0 LuSQ== X-Gm-Message-State: APjAAAUSrjnfZBSU3X++OT6M5uezVQpCK6OeheFusp8R49dbwCpNcVFf WYs4d361dnpQXr9QhXcAOwVzfAEl X-Google-Smtp-Source: APXvYqwiB4BkyJ8vdpJZnMegaN6Uwta8JMbCaQFxHRexwCNEctxHjjKzf32N4GLNOD1GLcktsD+/cg== X-Received: by 2002:a5d:400c:: with SMTP id n12mr30775769wrp.31.1553862935406; Fri, 29 Mar 2019 05:35:35 -0700 (PDT) Received: from localhost.localdomain (x4dbd3bb2.dyn.telefonica.de. [77.189.59.178]) by smtp.gmail.com with ESMTPSA id 61sm7341781wre.50.2019.03.29.05.35.34 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 29 Mar 2019 05:35:34 -0700 (PDT) From: =?utf-8?q?SZEDER_G=C3=A1bor?= To: Junio C Hamano Cc: git@vger.kernel.org, Jeff King , Todd Zullinger , =?utf-8?q?Martin_=C3=85gren?= , "brian m. carlson" , Johannes Schindelin , =?utf-8?q?SZEDER_G=C3=A1b?= =?utf-8?q?or?= Subject: [PATCH v3 4/6] ci: install Asciidoctor in 'ci/install-dependencies.sh' Date: Fri, 29 Mar 2019 13:35:18 +0100 Message-Id: <20190329123520.27549-5-szeder.dev@gmail.com> X-Mailer: git-send-email 2.21.0.539.g07239c3a71.dirty In-Reply-To: <20190329123520.27549-1-szeder.dev@gmail.com> References: <20190324215534.9495-1-szeder.dev@gmail.com> <20190329123520.27549-1-szeder.dev@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP When our '.travis.yml' was split into several 'ci/*' scripts [1], the installation of the 'asciidoctor' gem somehow ended up in 'ci/test-documentation.sh'. Install it in 'ci/install-dependencies.sh', where we install other dependencies of the Documentation build job as well (asciidoc, xmlto). [1] 657343a602 (travis-ci: move Travis CI code into dedicated scripts, 2017-09-10) Signed-off-by: SZEDER Gábor --- ci/install-dependencies.sh | 3 +++ ci/test-documentation.sh | 3 --- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/ci/install-dependencies.sh b/ci/install-dependencies.sh index d64667fcbf..76ec308965 100755 --- a/ci/install-dependencies.sh +++ b/ci/install-dependencies.sh @@ -54,6 +54,9 @@ StaticAnalysis) Documentation) sudo apt-get -q update sudo apt-get -q -y install asciidoc xmlto + + test -n "$ALREADY_HAVE_ASCIIDOCTOR" || + gem install asciidoctor ;; esac diff --git a/ci/test-documentation.sh b/ci/test-documentation.sh index be3b7d376a..8f91f48c81 100755 --- a/ci/test-documentation.sh +++ b/ci/test-documentation.sh @@ -5,9 +5,6 @@ . ${0%/*}/lib.sh -test -n "$ALREADY_HAVE_ASCIIDOCTOR" || -gem install asciidoctor - make check-builtins make check-docs From patchwork Fri Mar 29 12:35:19 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?SZEDER_G=C3=A1bor?= X-Patchwork-Id: 10876981 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 228011805 for ; Fri, 29 Mar 2019 12:35:42 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 0EB21205FD for ; Fri, 29 Mar 2019 12:35:42 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 02B8428FF5; Fri, 29 Mar 2019 12:35:42 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 9D678205FD for ; Fri, 29 Mar 2019 12:35:41 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729540AbfC2Mfk (ORCPT ); Fri, 29 Mar 2019 08:35:40 -0400 Received: from mail-wm1-f67.google.com ([209.85.128.67]:40911 "EHLO mail-wm1-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729438AbfC2Mfi (ORCPT ); Fri, 29 Mar 2019 08:35:38 -0400 Received: by mail-wm1-f67.google.com with SMTP id z24so2642447wmi.5 for ; Fri, 29 Mar 2019 05:35:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=mMemE2tYx2P4r8MS44OzkruoH1ouuk/8t5m3Z4hLimw=; b=tjc+H3sH44W8ZrglfbKUnXWiLa7EDD72ngsmZtxx9t0dkeck2voCe/ep3z7dL6gYti 5zxYqF6cOx7zYxd9/E95/Xx521DofoOjnwwS9C4++HuBU+m0QiaCSSGNwq/ILFVnzavt iSNm+yUS1bWr0p0OOujpxu4gLLrBBoIQtcbh7G1OVXyLKTcDlMP8yLlgZHQ15LNpAceE m3/WY2Mkmbs161uFwFYeYX7eCtetgzY+fH2pEizbTM69ZgLcGaRNbc25MyuXtSRKNKFK Jbu3cS4dpUYWgK2gexXt126taWwrtzchGUl/wI+Malye32XhdNxAvqwH7bAdpxsOmiLS xiAA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=mMemE2tYx2P4r8MS44OzkruoH1ouuk/8t5m3Z4hLimw=; b=pUnd3bEon2VaIMoeHEjI6odajcVHCiNf96Pi6fR8NpNQzfy9ixo6ZDJ6t5liXzG/dr LPVuBwEonaBsPqwzZSfNX3MvczngKE8cGqmyz65fnKHSgkn+erY8ZCbwPVnIc8QBYbwp GrwcmLK9xmSoDYdJHi+j9etvNYcrbMKvoBPH6U9YncifRF9rHkXIGhJwpvVDNC44+eQX fBElC8VQ3DQ56I4JoyOe0q1mu4we3K+LoT5/t2wAQt23TfPZiYy2ifmC81mHM9nGmUn4 HCZ146S9QeCEBxJpm/jb3ZWAeehodz51c/tBDKtnUFdwhKDAv2vY94+ORjQWZZHn4tG8 8jVQ== X-Gm-Message-State: APjAAAV/feQmPcSxFLC7Zy+vkWRR+dWTXHSsKC6Hntd9CXHpAh0IIFvE TAdD7rpyp76LJFDv/XecI0Y= X-Google-Smtp-Source: APXvYqyKeNvy1+RW7iWTfB1L5f7QTZQrVxANbrI4O9+n+xKh2mqO25cVl15nSbW56nKYrMwI/NCYLA== X-Received: by 2002:a1c:a8d3:: with SMTP id r202mr3693101wme.106.1553862936502; Fri, 29 Mar 2019 05:35:36 -0700 (PDT) Received: from localhost.localdomain (x4dbd3bb2.dyn.telefonica.de. [77.189.59.178]) by smtp.gmail.com with ESMTPSA id 61sm7341781wre.50.2019.03.29.05.35.35 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 29 Mar 2019 05:35:35 -0700 (PDT) From: =?utf-8?q?SZEDER_G=C3=A1bor?= To: Junio C Hamano Cc: git@vger.kernel.org, Jeff King , Todd Zullinger , =?utf-8?q?Martin_=C3=85gren?= , "brian m. carlson" , Johannes Schindelin , =?utf-8?q?SZEDER_G=C3=A1b?= =?utf-8?q?or?= Subject: [PATCH v3 5/6] ci: stick with Asciidoctor v1.5.8 for now Date: Fri, 29 Mar 2019 13:35:19 +0100 Message-Id: <20190329123520.27549-6-szeder.dev@gmail.com> X-Mailer: git-send-email 2.21.0.539.g07239c3a71.dirty In-Reply-To: <20190329123520.27549-1-szeder.dev@gmail.com> References: <20190324215534.9495-1-szeder.dev@gmail.com> <20190329123520.27549-1-szeder.dev@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP The release of Asciidoctor v2.0.0 two days ago broke our documentation build job on Travis CI, where we 'gem install asciidoctor', which always brings us the latest and (supposedly) greatest. Alas, we are not ready for that just yet, because it removed support for DocBook 4.5, and we have been requiring that particular DocBook version to build 'user-manual.xml' with Asciidoctor, resulting in: ASCIIDOC user-manual.xml asciidoctor: FAILED: missing converter for backend 'docbook45'. Processing aborted. Use --trace for backtrace make[1]: *** [user-manual.xml] Error 1 Unfortunately, we can't simply switch to DocBook 5 right away, as doing so leads to validation errors from 'xmlto', and working around those leads to yet another errors... [1] So let's stick with Asciidoctor v1.5.8 (latest stable release before v2.0.0) in our documentation build job on Travis CI for now, until we figure out how to deal with the fallout from Asciidoctor v2.0.0. [1] https://public-inbox.org/git/20190324162131.GL4047@pobox.com/ Signed-off-by: SZEDER Gábor --- ci/install-dependencies.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/install-dependencies.sh b/ci/install-dependencies.sh index 76ec308965..52a44c690a 100755 --- a/ci/install-dependencies.sh +++ b/ci/install-dependencies.sh @@ -56,7 +56,7 @@ Documentation) sudo apt-get -q -y install asciidoc xmlto test -n "$ALREADY_HAVE_ASCIIDOCTOR" || - gem install asciidoctor + gem install --version 1.5.8 asciidoctor ;; esac From patchwork Fri Mar 29 12:35:20 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?SZEDER_G=C3=A1bor?= X-Patchwork-Id: 10876983 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 564641805 for ; Fri, 29 Mar 2019 12:35:44 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 4130E205FD for ; Fri, 29 Mar 2019 12:35:44 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 3559B28FF5; Fri, 29 Mar 2019 12:35:44 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 9AD61205FD for ; Fri, 29 Mar 2019 12:35:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729542AbfC2Mfm (ORCPT ); Fri, 29 Mar 2019 08:35:42 -0400 Received: from mail-wr1-f68.google.com ([209.85.221.68]:37431 "EHLO mail-wr1-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729472AbfC2Mfj (ORCPT ); Fri, 29 Mar 2019 08:35:39 -0400 Received: by mail-wr1-f68.google.com with SMTP id w10so2414191wrm.4 for ; Fri, 29 Mar 2019 05:35:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=O0kSda6j0RB+hnnaInE22M7p+sKAjaxBMDm+ptFLgFQ=; b=iS4LYPaHtnuf412145Uo2rl7wo2R2Nh7ABpJIDG816DQiFIsELrUc4ybUAU3UQF3XX DuYsTZ20PGe6Z7NR7LHxNTy7s87bczBcdf8NKTQVxDHM2lAx2gD3IE/bZM09NBFOwIck 05uP3v34Xy03Gs0I8KkYwjH16/kv79ELSPl4qg5E6e9itjJwsAc0TjWilzpw4ccWnEjN e8LuiUQVwun1uwSfRv4jqWgiUYsnqq4bv7jpfdvVZQtnU2bEiR+DAyyWhc94Oi545fpG MncnDjdC02b3hyxuP2ch0tjpIO0e0Pl6/Yr9VU3uL1NYAjHt78pmSOKr/9N/RJsrWSBA gZ4Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=O0kSda6j0RB+hnnaInE22M7p+sKAjaxBMDm+ptFLgFQ=; b=SlgYcualbcXXBjLh4D+pTH6XDIMuoVOzC5C1u+TN5xbfSDkxfWekjK7d2gukgEP7lR xvS23a7UFrH00txiWwmh8mFGnq2xBgnLgxDQQKkQr4EhVkKMOlZv8+53O8FvfCqMK2DI LXezAybuYLknBcCC98sruUP7BLLA4Z0z/i0ZaoxzFNnGbNKeH9MYXdUJN9XRzcY9PRaA P6ldEuckIUiNwquPRt/PjCh0OF4OQMv1wmIH4zxUxyZfK+61oGsUbfn+g7UL7NO1/Rup JyE/jT0jg88m+dUJ6CQrXdyOpf0UNdiAfrLB41dSfXPYNqQTlklMWP6PMy3c+7YY6me5 v7dw== X-Gm-Message-State: APjAAAWVBU8f2Ke0Nh5Sw08rXzfoX0+pEepYYhM4B7t62+DqpBXqALzD B48nUxvSU4NwqP3XslGlNEc= X-Google-Smtp-Source: APXvYqwVMDajo8PsE4W7UjU27mBJ8cjieXBzg3S5rLh+o5xo/ZclzrK4LKVC1xthJuqiCwTjw5nSdQ== X-Received: by 2002:adf:ce07:: with SMTP id p7mr25564583wrn.148.1553862937791; Fri, 29 Mar 2019 05:35:37 -0700 (PDT) Received: from localhost.localdomain (x4dbd3bb2.dyn.telefonica.de. [77.189.59.178]) by smtp.gmail.com with ESMTPSA id 61sm7341781wre.50.2019.03.29.05.35.36 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 29 Mar 2019 05:35:37 -0700 (PDT) From: =?utf-8?q?SZEDER_G=C3=A1bor?= To: Junio C Hamano Cc: git@vger.kernel.org, Jeff King , Todd Zullinger , =?utf-8?q?Martin_=C3=85gren?= , "brian m. carlson" , Johannes Schindelin , =?utf-8?q?SZEDER_G=C3=A1b?= =?utf-8?q?or?= Subject: [PATCH v3 6/6] ci: fix AsciiDoc/Asciidoctor stderr check in the documentation build job Date: Fri, 29 Mar 2019 13:35:20 +0100 Message-Id: <20190329123520.27549-7-szeder.dev@gmail.com> X-Mailer: git-send-email 2.21.0.539.g07239c3a71.dirty In-Reply-To: <20190329123520.27549-1-szeder.dev@gmail.com> References: <20190324215534.9495-1-szeder.dev@gmail.com> <20190329123520.27549-1-szeder.dev@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP In 'ci/test-documentation.sh' we save the standard error of 'make doc', and, in an attempt to make sure that neither AsciiDoc nor Asciidoctor printed any warnings, we check the emptiness of the resulting file with '! test -s stderr.log'. This check has never actually worked, because in our 'ci/*' build scripts we rely on 'set -e' aborting the build job when a command exits with error, and, unfortunately, the combination of the two doesn't work as intended. According to POSIX [1]: "The -e setting shall be ignored when executing [...] a pipeline beginning with the ! reserved word" [2] Watch and learn: $ echo unexpected >file $ ( set -e; ! test -s file ; echo "should not reach this" ) ; echo $? should not reach this 0 This is why we haven't noticed the warnings from Asciidoctor that were fixed in the first patches of this patch series, though some of them were already there in the build of v2.18.0-rc0 [3]. Check the emptiness of that file with 'test ! -s' instead, which works properly with 'set -e': $ ( set -e; test ! -s file ; echo "should not reach this" ) ; echo $? 1 Furthermore, dump the contents of that file to the log for our convenience, so if it were to unexpectedly end up being non-empty, then we wouldn't have to scroll through all that long build log looking for warnings, but could see them right away near the end of the log. Note that we are only really interested in the standard error of AsciiDoc and Asciidoctor, but by saving the stderr of 'make doc' we also save any error output from the make rules. Currently there is only one such line: we build the docs with Asciidoctor right after a 'make clean', meaning that 'make USE_ASCIIDOCTOR=1 doc' always starts with running 'GIT-VERSION-GEN', which in turn prints the version to stderr. A 'sed' command was supposed to remove this version line to prevent it from triggering that (previously defunct) emptiness check, but, unfortunately, this command doesn't work as intended, either, because it leaves the file to be checked intact, but that defunct emptiness check hid this issue, too... Furthermore, in the near future there will be an other line on stderr, because commit 9a71722b4d (Doc: auto-detect changed build flags, 2019-03-17) in the currently cooking branch 'ma/doc-diff-doc-vs-doctor-comparison' will print "* new asciidoc flags" at the beginning of both 'make doc' invokations. Extend that 'sed' command to remove this line, too, wrap it in a helper function so the output of both 'make doc' is filtered the same way, and change its invokation to actually write the logfile to be checked. [1] http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set [2] POSIX doesn't discuss the meaning of '! cmd' in case of simple commands, but it defines that "A pipeline is a sequence of one or more commands separated by the control operator '|'", so apparently a simple command is considered as pipeline as well. http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_09_02 [3] https://travis-ci.org/git/git/jobs/385932007#L1463 Signed-off-by: SZEDER Gábor --- ci/test-documentation.sh | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/ci/test-documentation.sh b/ci/test-documentation.sh index 8f91f48c81..d49089832d 100755 --- a/ci/test-documentation.sh +++ b/ci/test-documentation.sh @@ -5,29 +5,38 @@ . ${0%/*}/lib.sh +filter_log () { + sed -e '/^GIT_VERSION = /d' \ + -e '/^ \* new asciidoc flags$/d' \ + "$1" +} + make check-builtins make check-docs # Build docs with AsciiDoc -make doc > >(tee stdout.log) 2> >(tee stderr.log >&2) -! test -s stderr.log +make doc > >(tee stdout.log) 2> >(tee stderr.raw >&2) +cat stderr.raw +filter_log stderr.raw >stderr.log +test ! -s stderr.log test -s Documentation/git.html test -s Documentation/git.xml test -s Documentation/git.1 grep '