From patchwork Sat Sep 7 14:12:47 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 11136483 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 1346B1731 for ; Sat, 7 Sep 2019 14:13:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id E87172178F for ; Sat, 7 Sep 2019 14:13:30 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="kTcvXF1M" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2391442AbfIGONS (ORCPT ); Sat, 7 Sep 2019 10:13:18 -0400 Received: from mail-lf1-f65.google.com ([209.85.167.65]:35147 "EHLO mail-lf1-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2388458AbfIGONS (ORCPT ); Sat, 7 Sep 2019 10:13:18 -0400 Received: by mail-lf1-f65.google.com with SMTP id w6so7288310lfl.2 for ; Sat, 07 Sep 2019 07:13:16 -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=qEDo+fkeB8xz3wuIY3GGDmQBiU7awWjJY5+uX6Ymb/I=; b=kTcvXF1M2gskpJFd7i7BbSQCvr7YGBYJUyoIm765s8PwPF19swqe9q48MEpeQO+6ie FzvxSRqs4okRyKmvtwktEov16lpajOGwcMNo5uDHNCbhG/IzLqnwy7H8E1QuPjlfM+Lw PWX85LA/Bec7pMmRjVyZ4gJuO8zfnh47kz4I8ivlrK67XcDZkR9DmJh6LCN/WoH4JiGe m/kKlUHrcT2Sq0WzA1lJcDh/UzxX22ytD95cD5A6x1atWOlKW+wcCVVf2oF0+hpMNVB8 hS8Xj0qru/lHQUbMGCZ7IGa9yKchfSI32loc3lnxldyPMdYEljkbQhRuqYfhZ/tDdVDQ iOZg== 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=qEDo+fkeB8xz3wuIY3GGDmQBiU7awWjJY5+uX6Ymb/I=; b=ca3OOEPWxX6Q3Lf/X3TTn+Cj/9dO+sJSXPiP1V7yAO6FokSVDLUMWPXKtSOrb6wHnv WXWJTrDVE6OszTFe77y0D13Wp5jizU16c3XAcLaGBm92PhvstL/e2A215rtvQt92s5J7 hykONDGNlOUgbRbuRYl/AsG0wSZfq+9wWXzTBmf7KPq2Eh3zPtc7ayZaCB+UDqnm/hm3 mpEFNNa8Cf+57t7CdlNX/xV8EaIbqzR6CAP32iiLJoI8tUYN73QNnvTSc70Kp5/jkeDC KoeAkhsh5uD752xV3u+2EA7434wPVf2t59i7XT6WrvAn4rODEaybYjdsmjqmkChD7UMO kicw== X-Gm-Message-State: APjAAAV41VFxzoLY13KMV/wodZ+isjtjitxcX7QhNUN4vin1+2FAzH1S XHokXnGOK7GgdGejnue8ySVmwlZ1 X-Google-Smtp-Source: APXvYqxY1oOFYaqmNgSi+Bq5/heCcpeLRfO6lncMgnJi38Zo9+kXWlUtolNnI4yzrA+bhk51iGOZnw== X-Received: by 2002:ac2:51ce:: with SMTP id u14mr9402022lfm.72.1567865595025; Sat, 07 Sep 2019 07:13:15 -0700 (PDT) Received: from localhost.localdomain (31-211-229-121.customers.ownit.se. [31.211.229.121]) by smtp.gmail.com with ESMTPSA id u10sm1741316lfk.34.2019.09.07.07.13.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 07 Sep 2019 07:13:14 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Cc: Jeff King Subject: [PATCH 1/7] Documentation: wrap blocks with "--" Date: Sat, 7 Sep 2019 16:12:47 +0200 Message-Id: <4c6e89fbeb3b76ec1cd8d12d00da2e8d9c77f6bd.1567707999.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.23.0 In-Reply-To: References: MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The documentation for each of these options contains a list. After the list, AsciiDoc interprets the continuation as a continuation of the *list*, not as a continution of the larger block. As a result, we get too much indentation. Wrap the entire blocks in "--" to fix this. With Asciidoctor, this commit is a no-op, and the two programs now render these identically. These two files share the same problem and indeed, they both document `--untracked-files` in quite similar ways. I haven't checked to what extent that is intentional or warranted, and to what extent they have simply drifted apart. I consider such an investigation and possible cleanup as out of scope for this commit and this patch series. Signed-off-by: Martin Ågren --- Documentation/git-commit.txt | 8 +++++--- Documentation/git-status.txt | 18 +++++++++++------- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index a85c2c2a4c..e43dad26f5 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -282,18 +282,20 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].) --untracked-files[=]:: Show untracked files. + +-- The mode parameter is optional (defaults to 'all'), and is used to specify the handling of untracked files; when -u is not used, the default is 'normal', i.e. show untracked files and directories. -+ + The possible options are: -+ + - 'no' - Show no untracked files - 'normal' - Shows untracked files and directories - 'all' - Also shows individual files in untracked directories. -+ + The default can be changed using the status.showUntrackedFiles configuration variable documented in linkgit:git-config[1]. +-- -v:: --verbose:: diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index d4e8f24f0c..7731b45f07 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -59,16 +59,17 @@ This is optional and defaults to the original version 'v1' format. --untracked-files[=]:: Show untracked files. + +-- The mode parameter is used to specify the handling of untracked files. It is optional: it defaults to 'all', and if specified, it must be stuck to the option (e.g. `-uno`, but not `-u no`). -+ + The possible options are: -+ + - 'no' - Show no untracked files. - 'normal' - Shows untracked files and directories. - 'all' - Also shows individual files in untracked directories. -+ + When `-u` option is not used, untracked files and directories are shown (i.e. the same as specifying `normal`), to help you avoid forgetting to add newly created files. Because it takes extra work @@ -78,9 +79,10 @@ Consider enabling untracked cache and split index if supported (see `git update-index --untracked-cache` and `git update-index --split-index`), Otherwise you can use `no` to have `git status` return more quickly without showing untracked files. -+ + The default can be changed using the status.showUntrackedFiles configuration variable documented in linkgit:git-config[1]. +-- --ignore-submodules[=]:: Ignore changes to submodules when looking for changes. can be @@ -100,11 +102,12 @@ configuration variable documented in linkgit:git-config[1]. --ignored[=]:: Show ignored files as well. + +-- The mode parameter is used to specify the handling of ignored files. It is optional: it defaults to 'traditional'. -+ + The possible options are: -+ + - 'traditional' - Shows ignored files and directories, unless --untracked-files=all is specified, in which case individual files in ignored directories are @@ -112,12 +115,13 @@ The possible options are: - 'no' - Show no ignored files. - 'matching' - Shows ignored files and directories matching an ignore pattern. -+ + When 'matching' mode is specified, paths that explicitly match an ignored pattern are shown. If a directory matches an ignore pattern, then it is shown, but not paths contained in the ignored directory. If a directory does not match an ignore pattern, but all contents are ignored, then the directory is not shown, but all contents are shown. +-- -z:: Terminate entries with NUL, instead of LF. This implies From patchwork Sat Sep 7 14:12:48 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 11136485 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 3B1CF1398 for ; Sat, 7 Sep 2019 14:13:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 1CB152178F for ; Sat, 7 Sep 2019 14:13:31 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="m7VusFGy" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2403863AbfIGONU (ORCPT ); Sat, 7 Sep 2019 10:13:20 -0400 Received: from mail-lj1-f193.google.com ([209.85.208.193]:32976 "EHLO mail-lj1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2391011AbfIGONT (ORCPT ); Sat, 7 Sep 2019 10:13:19 -0400 Received: by mail-lj1-f193.google.com with SMTP id a22so8644756ljd.0 for ; Sat, 07 Sep 2019 07:13:18 -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=mmbt82z6qlumMJEhVZeHBxoaqkysoIgb93tl4ZU3h9o=; b=m7VusFGyCAuCLlr9i4CSc2suaObZ0RkIJCpKH3WnsSfsIf94jeDk+9y6ztYopC6jtt oIh4gXZwI0kNAQChKbHE4H3ugAgQ5MVMmSLaCuwD4dIFJo9EQ1sGpmcDvLDbGfMeoVFd erYrHdnabWSKXcvFkEGOu2/enN3GM0LkcwsDOQRHiqp+Xucp5TyM6PWpZwRVbaJKGMUi N6K4EyM8xBODmN0gnW57Iu4ZcwEj5GtqEjfuZU0hgQdwWVAm78sz8e5+rX7IZ7TPKvaB 53shvX866W781eF0vtxjNkqKJYl6SWKmYDIDFFGlF368nxqtS/MxM32Ef5G7Hc+jUQZW 1WfA== 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=mmbt82z6qlumMJEhVZeHBxoaqkysoIgb93tl4ZU3h9o=; b=mddA1y49rWYJ6vC0HbeyGtu7c6DL1QQ+CaCOymMInJ+rn9ucILGQnRJlVSRUMJ1HnR qIA7/XoFwHnOvHGTIDk/7pyC8+GFmJGWVzrPO0SU6gD+jaDZndjWTAZmcHEH2JJXsNIL E9Lu20at0F+O0gLl1+4tb2hPLpsoLrKJ88xxhKw3n+wSheswat67T/htNFNNp4urMRT9 tODMejOkdH1/6r+nnIhCVH+CtNeLyInCfmupGzRJBiJb9sz9D+LzeoMxJrvSSEhiBNnZ Q1A91Ky51rottfWyNIdDoiSzi8hazTtAApSyDlw4EIR/04AWefaH6wGriZVCsImL/+NS FcEw== X-Gm-Message-State: APjAAAUVutRUftyEJRbhzJjKH2T432F6gdSJZFHq6zokyP+GQ+be6xhM HoMqtLE/dCHHaOyDHTgcIoRZEvwa X-Google-Smtp-Source: APXvYqyhGfLJPJ0TL/tuoZXFCxxMigN3XCWk7cFv8QSw6jR65KYqqrT8ZSZ2KYDG8G6tN85bVg4VGg== X-Received: by 2002:a2e:6e1a:: with SMTP id j26mr9405870ljc.172.1567865596950; Sat, 07 Sep 2019 07:13:16 -0700 (PDT) Received: from localhost.localdomain (31-211-229-121.customers.ownit.se. [31.211.229.121]) by smtp.gmail.com with ESMTPSA id u10sm1741316lfk.34.2019.09.07.07.13.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 07 Sep 2019 07:13:16 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Cc: Jeff King Subject: [PATCH 2/7] git-merge-base.txt: render indentations correctly under Asciidoctor Date: Sat, 7 Sep 2019 16:12:48 +0200 Message-Id: <4c548f2fcea3db674a70973ef6ce46b6f1095dfe.1567707999.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.23.0 In-Reply-To: References: MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org There are several graphs in this document. For most of them, we use a single leading tab to indent the whole graph, and then we use spaces (possibly eight or more) to align things within the graph. In the larger graph, we use a different strategy: We use 1-N tabs and just a small number of spaces (<8). This is how we usually prefer to do our indenting, but Asciidoctor ends up rendering this differently from AsciiDoc. Same thing for the if-then-fi examples where the conditional code is indented by two tabs, which renders differently under AsciiDoc and Asciidoctor. Similar to 379805051d ("Documentation: render revisions correctly under Asciidoctor", 2018-05-06), use an explicit literal block to indicate that we want to keep the leading whitespace in the tables. Change not just the ones that render differently, but all of them for consistency. Because this gives us some extra indentation, we can remove the one that we have been carrying explicitly. That is, drop the first tab of indentation on each line. With AsciiDoc, this results in identical rendering before and after this commit, both for git-merge-base.1 and git-merge-base.html. A less intrusive change would be to replace tabs 2-N on each line with eight spaces. But let's follow the example set by 379805051d, so that we can use our preferred way of indenting. Signed-off-by: Martin Ågren --- Documentation/git-merge-base.txt | 98 +++++++++++++++++++------------- 1 file changed, 57 insertions(+), 41 deletions(-) diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index 9f07f4f6ed..411dca308b 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -80,9 +80,11 @@ which is reachable from both 'A' and 'B' through the parent relationship. For example, with this topology: - o---o---o---B - / - ---o---1---o---o---o---A +.... + o---o---o---B + / +---o---1---o---o---o---A +.... the merge base between 'A' and 'B' is '1'. @@ -90,21 +92,25 @@ Given three commits 'A', 'B' and 'C', `git merge-base A B C` will compute the merge base between 'A' and a hypothetical commit 'M', which is a merge between 'B' and 'C'. For example, with this topology: - o---o---o---o---C - / - / o---o---o---B - / / - ---2---1---o---o---o---A +.... + o---o---o---o---C + / + / o---o---o---B + / / +---2---1---o---o---o---A +.... the result of `git merge-base A B C` is '1'. This is because the equivalent topology with a merge commit 'M' between 'B' and 'C' is: - o---o---o---o---o - / \ - / o---o---o---o---M - / / - ---2---1---o---o---o---A +.... + o---o---o---o---o + / \ + / o---o---o---o---M + / / +---2---1---o---o---o---A +.... and the result of `git merge-base A M` is '1'. Commit '2' is also a common ancestor between 'A' and 'M', but '1' is a better common ancestor, @@ -116,11 +122,13 @@ the best common ancestor of all commits. When the history involves criss-cross merges, there can be more than one 'best' common ancestor for two commits. For example, with this topology: - ---1---o---A - \ / - X - / \ - ---2---o---o---B +.... +---1---o---A + \ / + X + / \ +---2---o---o---B +.... both '1' and '2' are merge-bases of A and B. Neither one is better than the other (both are 'best' merge bases). When the `--all` option is not given, @@ -131,18 +139,22 @@ and B is (or at least used to be) to compute the merge base between A and B, and check if it is the same as A, in which case, A is an ancestor of B. You will see this idiom used often in older scripts. - A=$(git rev-parse --verify A) - if test "$A" = "$(git merge-base A B)" - then - ... A is an ancestor of B ... - fi +.... +A=$(git rev-parse --verify A) +if test "$A" = "$(git merge-base A B)" +then + ... A is an ancestor of B ... +fi +.... In modern git, you can say this in a more direct way: - if git merge-base --is-ancestor A B - then - ... A is an ancestor of B ... - fi +.... +if git merge-base --is-ancestor A B +then + ... A is an ancestor of B ... +fi +.... instead. @@ -154,13 +166,15 @@ topic origin/master`, the history of remote-tracking branch `origin/master` may have been rewound and rebuilt, leading to a history of this shape: - o---B2 - / - ---o---o---B1--o---o---o---B (origin/master) - \ - B0 - \ - D0---D1---D (topic) +.... + o---B2 + / +---o---o---B1--o---o---o---B (origin/master) + \ + B0 + \ + D0---D1---D (topic) +.... where `origin/master` used to point at commits B0, B1, B2 and now it points at B, and your `topic` branch was started on top of it back @@ -193,13 +207,15 @@ will find B0, and will replay D0, D1 and D on top of B to create a new history of this shape: - o---B2 - / - ---o---o---B1--o---o---o---B (origin/master) - \ \ - B0 D0'--D1'--D' (topic - updated) - \ - D0---D1---D (topic - old) +.... + o---B2 + / +---o---o---B1--o---o---o---B (origin/master) + \ \ + B0 D0'--D1'--D' (topic - updated) + \ + D0---D1---D (topic - old) +.... A caveat is that older reflog entries in your repository may be expired by `git gc`. If B0 no longer appears in the reflog of the From patchwork Sat Sep 7 14:12:49 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 11136487 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 63FB01746 for ; Sat, 7 Sep 2019 14:13:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 44E622178F for ; Sat, 7 Sep 2019 14:13:31 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="Q+aP0AIF" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2404263AbfIGONV (ORCPT ); Sat, 7 Sep 2019 10:13:21 -0400 Received: from mail-lj1-f196.google.com ([209.85.208.196]:44547 "EHLO mail-lj1-f196.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2388458AbfIGONV (ORCPT ); Sat, 7 Sep 2019 10:13:21 -0400 Received: by mail-lj1-f196.google.com with SMTP id u14so8573599ljj.11 for ; Sat, 07 Sep 2019 07:13:19 -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=d6grHpI70/UKtx1Rboa/FrQpwxna6BwVuJvqTaEr83U=; b=Q+aP0AIFrY/xzPO5m9M5xGkY73s3f+ACEeNFlAPEu6WmM8xeX3NJl4tZsfuKQGvDhC 2hB525wf+JOQoFUJ4/kCtH1nJ8BjT9eNL3gFK/OXmcG+Xmlpi8ZQRE/4lkW0O/7nxVpc KernzExaZ26vEQwbNJQSB+WFDkHvRg3AJe4nn5+A+hTn6//UrQ6wlr31HKczn4MtXO6c 0aDLN6csGSh5A25us92EBsOcy0pM3WfgqKIrivK2s1XvA4XjIOvzbgno0fOW8oCcvurx yKIG7Be3YeTzszAo/6HXtfmXjM9lzlxHWUiJBTxJxAADTVviCC1KUBrNQJqmznz96tPM viUw== 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=d6grHpI70/UKtx1Rboa/FrQpwxna6BwVuJvqTaEr83U=; b=EOUBbNdcFKBL3/kxBLnKm4BZK6EYVQT18ZDolJTwKx7wqWqTAPtfpcfHmINxPwx46n kCgOuDcFExK10xJvUj/rffQ6jLoREagBDOZ9MkjeaKziW4qTwUf6Ui4wfF/1xdS4RZkP 5uRUU+5SEhf0ofOpgBc/2AySOeqoAUBXti0kCt/43BWTcF0vnWb5SQOYXgegrDX5Qlz3 sHBmNAqSC4WItMV7FhgV4ofV7GvQyb1DiH5AMhon6FSNzbf8Y6yHcTKMq/LB311QmEna 2Igp/xW6NwT/GLtXO3z/TQp3bVeYM4L9pG3Txei7VW2Po+ajDtR9LiB6/dDr17MgR2/e vbZQ== X-Gm-Message-State: APjAAAVnkIoYwM2mqmmcTiBdDNbNs6nBdPGKbbP9QTrq3y9aUTirIOUn ncTFulIu+0vxjAMUESyDjSo190+D X-Google-Smtp-Source: APXvYqyDzWuZxsaCe2JBQ7P41V+B0s6UiwU+CCbgFqn0Y8oMig+lsUtijaa9xM7MiPGpZL/6AcmBHg== X-Received: by 2002:a2e:9549:: with SMTP id t9mr5299259ljh.189.1567865598542; Sat, 07 Sep 2019 07:13:18 -0700 (PDT) Received: from localhost.localdomain (31-211-229-121.customers.ownit.se. [31.211.229.121]) by smtp.gmail.com with ESMTPSA id u10sm1741316lfk.34.2019.09.07.07.13.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 07 Sep 2019 07:13:17 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Cc: Jeff King Subject: [PATCH 3/7] Documentation: wrap config listings in "----" Date: Sat, 7 Sep 2019 16:12:49 +0200 Message-Id: <2a8cc66dff38f3e5bf9220a06440382ae2641fea.1567707999.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.23.0 In-Reply-To: References: MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The indented lines in these example config-file listings are indented differently by AsciiDoc and Asciidoctor. Fix this by marking the example config-files as code listings by wrapping them in "----". Because this gives us some extra indentation, we can remove the one that we have been carrying explicitly. That is, drop the first tab of indentation on each line. With AsciiDoc, this results in identical rendering before and after this commit. Asciidoctor now renders this the same as AsciiDoc does. git-config.txt pretty consistently uses twelve dashes rather than the minimum four to spell "----". Let's stick to the file-local convention there. Signed-off-by: Martin Ågren --- Documentation/config.txt | 84 ++++++++++++++++---------------- Documentation/git-config.txt | 56 +++++++++++---------- Documentation/git-send-email.txt | 12 +++-- Documentation/gitmodules.txt | 15 +++--- 4 files changed, 87 insertions(+), 80 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 7e2a6f61f5..f7cd0ae584 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -164,47 +164,49 @@ to either specify only the realpath version, or both versions. Example ~~~~~~~ - # Core variables - [core] - ; Don't trust file modes - filemode = false - - # Our diff algorithm - [diff] - external = /usr/local/bin/diff-wrapper - renames = true - - [branch "devel"] - remote = origin - merge = refs/heads/devel - - # Proxy settings - [core] - gitProxy="ssh" for "kernel.org" - gitProxy=default-proxy ; for the rest - - [include] - path = /path/to/foo.inc ; include by absolute path - path = foo.inc ; find "foo.inc" relative to the current file - path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory - - ; include if $GIT_DIR is /path/to/foo/.git - [includeIf "gitdir:/path/to/foo/.git"] - path = /path/to/foo.inc - - ; include for all repositories inside /path/to/group - [includeIf "gitdir:/path/to/group/"] - path = /path/to/foo.inc - - ; include for all repositories inside $HOME/to/group - [includeIf "gitdir:~/to/group/"] - path = /path/to/foo.inc - - ; relative paths are always relative to the including - ; file (if the condition is true); their location is not - ; affected by the condition - [includeIf "gitdir:/path/to/group/"] - path = foo.inc +---- +# Core variables +[core] + ; Don't trust file modes + filemode = false + +# Our diff algorithm +[diff] + external = /usr/local/bin/diff-wrapper + renames = true + +[branch "devel"] + remote = origin + merge = refs/heads/devel + +# Proxy settings +[core] + gitProxy="ssh" for "kernel.org" + gitProxy=default-proxy ; for the rest + +[include] + path = /path/to/foo.inc ; include by absolute path + path = foo.inc ; find "foo.inc" relative to the current file + path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory + +; include if $GIT_DIR is /path/to/foo/.git +[includeIf "gitdir:/path/to/foo/.git"] + path = /path/to/foo.inc + +; include for all repositories inside /path/to/group +[includeIf "gitdir:/path/to/group/"] + path = /path/to/foo.inc + +; include for all repositories inside $HOME/to/group +[includeIf "gitdir:~/to/group/"] + path = /path/to/foo.inc + +; relative paths are always relative to the including +; file (if the condition is true); their location is not +; affected by the condition +[includeIf "gitdir:/path/to/group/"] + path = foo.inc +---- Values ~~~~~~ diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index ff9310f958..899e92a1c9 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -339,33 +339,35 @@ EXAMPLES Given a .git/config like this: - # - # This is the config file, and - # a '#' or ';' character indicates - # a comment - # - - ; core variables - [core] - ; Don't trust file modes - filemode = false - - ; Our diff algorithm - [diff] - external = /usr/local/bin/diff-wrapper - renames = true - - ; Proxy settings - [core] - gitproxy=proxy-command for kernel.org - gitproxy=default-proxy ; for all the rest - - ; HTTP - [http] - sslVerify - [http "https://weak.example.com"] - sslVerify = false - cookieFile = /tmp/cookie.txt +------------ +# +# This is the config file, and +# a '#' or ';' character indicates +# a comment +# + +; core variables +[core] + ; Don't trust file modes + filemode = false + +; Our diff algorithm +[diff] + external = /usr/local/bin/diff-wrapper + renames = true + +; Proxy settings +[core] + gitproxy=proxy-command for kernel.org + gitproxy=default-proxy ; for all the rest + +; HTTP +[http] + sslVerify +[http "https://weak.example.com"] + sslVerify = false + cookieFile = /tmp/cookie.txt +------------ you can set the filemode to true with diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index 504ae7fe76..b2909a3dc5 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -478,11 +478,13 @@ Use gmail as the smtp server To use 'git send-email' to send your patches through the GMail SMTP server, edit ~/.gitconfig to specify your account settings: - [sendemail] - smtpEncryption = tls - smtpServer = smtp.gmail.com - smtpUser = yourname@gmail.com - smtpServerPort = 587 +---- +[sendemail] + smtpEncryption = tls + smtpServer = smtp.gmail.com + smtpUser = yourname@gmail.com + smtpServerPort = 587 +---- If you have multifactor authentication setup on your gmail account, you will need to generate an app-specific password for use with 'git send-email'. Visit diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt index a66e95b70c..08c7b8a722 100644 --- a/Documentation/gitmodules.txt +++ b/Documentation/gitmodules.txt @@ -105,14 +105,15 @@ EXAMPLES Consider the following .gitmodules file: - [submodule "libfoo"] - path = include/foo - url = git://foo.com/git/lib.git - - [submodule "libbar"] - path = include/bar - url = git://bar.com/git/lib.git +---- +[submodule "libfoo"] + path = include/foo + url = git://foo.com/git/lib.git +[submodule "libbar"] + path = include/bar + url = git://bar.com/git/lib.git +---- This defines two submodules, `libfoo` and `libbar`. These are expected to be checked out in the paths `include/foo` and `include/bar`, and for both From patchwork Sat Sep 7 14:12:50 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 11136489 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 96E3F924 for ; Sat, 7 Sep 2019 14:13:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 6E07F2178F for ; Sat, 7 Sep 2019 14:13:31 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="KEctgQsQ" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2404362AbfIGONW (ORCPT ); Sat, 7 Sep 2019 10:13:22 -0400 Received: from mail-lj1-f194.google.com ([209.85.208.194]:46389 "EHLO mail-lj1-f194.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2391011AbfIGONW (ORCPT ); Sat, 7 Sep 2019 10:13:22 -0400 Received: by mail-lj1-f194.google.com with SMTP id e17so8553993ljf.13 for ; Sat, 07 Sep 2019 07:13:21 -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=fDzSzenR+v+sxzP16dttcT2NQp/HszdbasAxKUqctcY=; b=KEctgQsQQxYisA2uD3Ty4LztpVm7QT3s0tR/wJm1V747K7AGUueSDXOtUfWd+bOZxi NWC1gsUulhiODb3S6wZpFjelaoIIAevfCE6T35epQL6EN/9vlADYwKBg5B2dfmkYYq5j +PK8B3WFsUNM6Pmfevy3pksH6TAug/kPjUbsc/rNwttTQ3eNEckcESjVEgUMkQlE1gVb zV6ILO1YZPJD/Y7kwQvNgJtC0uJVe5AJARMd5b3grFSfKvovdnVf/aZ5SS4yKTQAUp6o /6QNH/wpxiB976gbnHWieGPG7Tsm7eDxsOk2IK3TahPHA95nq7O3gYrhgDCw3/UgFsjp cCOw== 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=fDzSzenR+v+sxzP16dttcT2NQp/HszdbasAxKUqctcY=; b=i/GaaMjJyUW27lO9j+feA0W6mRTW9mj2NMRXZXnqmWdSJSWZeTRJ3OrKkPzbUAtYY9 DdCjtX9xOeC8YkKwdU2KU2o6BdW67j2IdLhy8ET6VilFriFkml1Ct70dPVR/ULXWECNM h4yG00Epl40uceZ56Gpr+JF9xcO2StSc1vSHYDnkQP+l28wC0DJ5OFs2d78c8MCvR72g +dnjOORqagy1rDCpOm8nNzdyVd0orrMX5FgVJcOkNiAgYD4Pkn8WNdgVtRn7GGYmaSUg lzhnQxyCGbBrhAMUal3wy7dqM2uERfS/ayAzcQ7lgdAXnO4U95w4c73d//UgMaNkXset tIfQ== X-Gm-Message-State: APjAAAVuO6qkypiVGpWdE17UuaM6MeFUYqJ+03ITvHXidNXGrsek7NLa OrMLuhaII2DVkBA0ZyKclHpGoqyT X-Google-Smtp-Source: APXvYqyzT7kznNRjVU11ItLqS7T9dkdO89tOmcN5z1F8zLia2az7iAKXOM0vmq5MSb6Tp4ElIAIDVA== X-Received: by 2002:a05:651c:113c:: with SMTP id e28mr8744891ljo.184.1567865600020; Sat, 07 Sep 2019 07:13:20 -0700 (PDT) Received: from localhost.localdomain (31-211-229-121.customers.ownit.se. [31.211.229.121]) by smtp.gmail.com with ESMTPSA id u10sm1741316lfk.34.2019.09.07.07.13.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 07 Sep 2019 07:13:19 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Cc: Jeff King Subject: [PATCH 4/7] git-ls-remote.txt: wrap shell listing in "----" Date: Sat, 7 Sep 2019 16:12:50 +0200 Message-Id: <93df070965c1222d5e00909ed3930dce299e1541.1567707999.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.23.0 In-Reply-To: References: MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The second "column" in the output of `git ls-remote` is typeset differently by AsciiDoc and Asciidoctor, similar to various examples touched by the last few commits. Fix this by marking the example shell session as a code listing by wrapping it in "----". Because this gives us some extra indentation, we can remove the one that we have been carrying explicitly. That is, drop the first tab of indentation on each line. With AsciiDoc, this results in identical rendering before and after this commit. Asciidoctor now renders this the same as AsciiDoc does. Signed-off-by: Martin Ågren --- Documentation/git-ls-remote.txt | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index 0b057cbb10..a2ea1fd687 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt @@ -92,21 +92,23 @@ OPTIONS EXAMPLES -------- - $ git ls-remote --tags ./. - d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99 - f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1 - 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3 - c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2 - 0918385dbd9656cab0d1d81ba7453d49bbc16250 refs/tags/junio-gpg-pub - $ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc - 5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master - c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/pu - $ git remote add korg http://www.kernel.org/pub/scm/git/git.git - $ git ls-remote --tags korg v\* - d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99 - f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1 - c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2 - 7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3 +---- +$ git ls-remote --tags ./. +d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99 +f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1 +7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3 +c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2 +0918385dbd9656cab0d1d81ba7453d49bbc16250 refs/tags/junio-gpg-pub +$ git ls-remote http://www.kernel.org/pub/scm/git/git.git master pu rc +5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master +c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/pu +$ git remote add korg http://www.kernel.org/pub/scm/git/git.git +$ git ls-remote --tags korg v\* +d6602ec5194c87b0fc87103ca4d67251c76f233a refs/tags/v0.99 +f25a265a342aed6041ab0cc484224d9ca54b6f41 refs/tags/v0.99.1 +c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2 +7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3 +---- SEE ALSO -------- From patchwork Sat Sep 7 14:12:51 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 11136491 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id C90B91708 for ; Sat, 7 Sep 2019 14:13:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id A07932178F for ; Sat, 7 Sep 2019 14:13:31 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="m9R8bdvZ" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2391551AbfIGONY (ORCPT ); Sat, 7 Sep 2019 10:13:24 -0400 Received: from mail-lj1-f174.google.com ([209.85.208.174]:41885 "EHLO mail-lj1-f174.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2404414AbfIGONY (ORCPT ); Sat, 7 Sep 2019 10:13:24 -0400 Received: by mail-lj1-f174.google.com with SMTP id a4so8594305ljk.8 for ; Sat, 07 Sep 2019 07:13:23 -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=h6GtHSFK5hov5882hvjwINPS7bsxG62UioRggNF2SLI=; b=m9R8bdvZL0/Wl9bSiYVXGK6aEwOxrlPxzJyJ87RLHjidizvhuTGVzdR30t2YnKwZlp rR5BgnWqqt7f/O7eesZXkjF34yDID+2W7ANClQP9zeCddBedbq28CLSvkp4M7WMtxAdE TY6ud2l2olAtCfLZPYKm3CVwMs0BHuU7aRJI+biGYwZ2dbgJZbHkr7IFro97nuVK9oYT gCiGeCYXH58lPuevpckOk4JedPpbg/BO9jt8yPJ1vt4qfHz5/Yh12TPCvjW++F/vtcAk mP7x4p2rf1RkKTZ4o67Xp+Ua60WiAPEenbtUSmtOvkcVxizb20ZZkuY1xtpYYrcohva6 nuMw== 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=h6GtHSFK5hov5882hvjwINPS7bsxG62UioRggNF2SLI=; b=nS1JQBaMPU6A4O6xsV3jlqDoclBYXzNxHdrTRpYufAOg1CLAjVbDyqllXu5IQTdZXA eggX2DhDXWvvg36ciFar+P9jHL6KwzjAgrvPshcitzbEJyXcpNxd+DlenNhmxucgUNyy cdIzpsXRGwe+KdQ3mEoAg5sVtUBV9z8jkP8OS1aw1NIIUncb/y2dPvHwkLkOK+NDT7il 0Qi+uPTRIEh6uXeWxZ/OL919WBswOsId0Xe/9bDVA+TnBxtMVu2JTaUfEI7wxJRdXkI7 rF9I9zoUoCr2uow5U8znl4ufshA2vG4jMmTacO5IKN3yi9QUpCZqNPRXPNaER6V3wWXJ cZBQ== X-Gm-Message-State: APjAAAWYk+uepwsirM51gt5sCc4nNsAhhxmYohr8l98/Xb/w7/axKdNl i777CnUMNohGVFmYYRjj/xo3M40c X-Google-Smtp-Source: APXvYqxVCrOzSsWAPC5CiuhjVfROYIQvCWysOvHydmmo5MIXjce7h5OUWo/2BiQ6CCTLwbV3doU29A== X-Received: by 2002:a05:651c:1135:: with SMTP id e21mr9264452ljo.83.1567865601922; Sat, 07 Sep 2019 07:13:21 -0700 (PDT) Received: from localhost.localdomain (31-211-229-121.customers.ownit.se. [31.211.229.121]) by smtp.gmail.com with ESMTPSA id u10sm1741316lfk.34.2019.09.07.07.13.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 07 Sep 2019 07:13:21 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Cc: Jeff King Subject: [PATCH 5/7] git-receive-pack.txt: wrap shell [script] listing in "----" Date: Sat, 7 Sep 2019 16:12:51 +0200 Message-Id: <6632bbac8c1cf943a439b69252d948f1ecf1de5f.1567707999.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.23.0 In-Reply-To: References: MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The indented lines in the example shell script listing are indented differently by AsciiDoc and Asciidoctor. Fix this by marking the example shell script as a code listing by wrapping it in "----". Because this gives us some extra indentation, we can remove the one that we have been carrying explicitly. That is, drop the first tab of indentation on each line. For consistency, make the same change to the short example shell session further down. With AsciiDoc, this results in identical rendering before and after this commit. Asciidoctor now renders this the same as AsciiDoc does. Signed-off-by: Martin Ågren --- Documentation/git-receive-pack.txt | 52 ++++++++++++++++-------------- 1 file changed, 28 insertions(+), 24 deletions(-) diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt index dedf97efbb..25702ed730 100644 --- a/Documentation/git-receive-pack.txt +++ b/Documentation/git-receive-pack.txt @@ -165,29 +165,31 @@ ref listing the commits pushed to the repository, and logs the push certificates of signed pushes with good signatures to a logger service: - #!/bin/sh - # mail out commit update information. - while read oval nval ref - do - if expr "$oval" : '0*$' >/dev/null - then - echo "Created a new ref, with the following commits:" - git rev-list --pretty "$nval" - else - echo "New commits:" - git rev-list --pretty "$nval" "^$oval" - fi | - mail -s "Changes to ref $ref" commit-list@mydomain - done - # log signed push certificate, if any - if test -n "${GIT_PUSH_CERT-}" && test ${GIT_PUSH_CERT_STATUS} = G +---- +#!/bin/sh +# mail out commit update information. +while read oval nval ref +do + if expr "$oval" : '0*$' >/dev/null then - ( - echo expected nonce is ${GIT_PUSH_NONCE} - git cat-file blob ${GIT_PUSH_CERT} - ) | mail -s "push certificate from $GIT_PUSH_CERT_SIGNER" push-log@mydomain - fi - exit 0 + echo "Created a new ref, with the following commits:" + git rev-list --pretty "$nval" + else + echo "New commits:" + git rev-list --pretty "$nval" "^$oval" + fi | + mail -s "Changes to ref $ref" commit-list@mydomain +done +# log signed push certificate, if any +if test -n "${GIT_PUSH_CERT-}" && test ${GIT_PUSH_CERT_STATUS} = G +then + ( + echo expected nonce is ${GIT_PUSH_NONCE} + git cat-file blob ${GIT_PUSH_CERT} + ) | mail -s "push certificate from $GIT_PUSH_CERT_SIGNER" push-log@mydomain +fi +exit 0 +---- The exit code from this hook invocation is ignored, however a non-zero exit code will generate an error message. @@ -212,8 +214,10 @@ anyway. This hook can be used, for example, to run `git update-server-info` if the repository is packed and is served via a dumb transport. - #!/bin/sh - exec git update-server-info +---- +#!/bin/sh +exec git update-server-info +---- QUARANTINE ENVIRONMENT From patchwork Sat Sep 7 14:12:52 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 11136493 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 0764D1398 for ; Sat, 7 Sep 2019 14:13:32 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id D311E2178F for ; Sat, 7 Sep 2019 14:13:31 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="sLrVdGCh" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2404416AbfIGON0 (ORCPT ); Sat, 7 Sep 2019 10:13:26 -0400 Received: from mail-lf1-f66.google.com ([209.85.167.66]:46289 "EHLO mail-lf1-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2388202AbfIGONZ (ORCPT ); Sat, 7 Sep 2019 10:13:25 -0400 Received: by mail-lf1-f66.google.com with SMTP id t8so7230667lfc.13 for ; Sat, 07 Sep 2019 07:13:24 -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=BlclNzxkxAlmmQptdiIu+G7fa5HeYegZeaLjXk1IMVw=; b=sLrVdGChuop+42Qmqea35G6rYgBV8bFh9GL/DDEJE+tzPNgP3el/1YGAKhEdB7wwsf HSZ4SPXkXsQiHfE1UmBhF5g4AtP1tZA/ijIMKWPJqshNU4jTVwfrlP1ZenvP9VdNqu7F tWwMZSkZUonbacGdwbZZvQWOK5AEukQegD+EeHxQjpslmlHKQm8XGl7jrMo/TGOKDyzD wPdxNbHrLXYTefaiwRbyFl0yxXrZ9DimBP4rqGz/FesIaQP4uz1i1fs7slwpQOQhVFhM olfWEtX67HKQzce08pRtSXV1/HWFiDwtWc1AXR6XUQ2uRR4R61/2Vbxr/TsiQaCI48mx wCuA== 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=BlclNzxkxAlmmQptdiIu+G7fa5HeYegZeaLjXk1IMVw=; b=piTHJJw96hYgtts3MQDnrkfIDD2v01Gs3AXzfMk7H4axm6DV7AOr+JuvmwOWNfztTi mnPy4mWoyK3NGxWWSySrytzpvtlmIvN97lM2flEfQaJuELgRBEaGKdNhlNMFElkS20wK UFlJwKmn6h3zBBqNE1hzuWVgouYMkBqSmjmG7uThFmFz7eT7R7iHaIX24Mf7wwYD6BZo M+em9oZRNy1cDgOebZ4WU+8JcXv3SqmUZGxsUDcebS47zds0j4+fvCM7Vu8KsFuUUCJ/ /xiX8rmPvG0XJ2XHfyJE63BIsvhM9gY9fCanZvoIvqj3Qev8PpMnPDP5B7bAtROlmdeh +EtA== X-Gm-Message-State: APjAAAVWDu6W/R/u3IfpK5obhZ0p/mjPJQzvdUqlBl9WJPFimn3HEakQ qP6yHgsr+6p2tDmt59c+Tbj/YKzf X-Google-Smtp-Source: APXvYqztAVr93mMijt8ryrx4pj9F4HIvTulhMY+l28kSalDlQnW/UN4TpkaatSYthlBD27WspW0SeQ== X-Received: by 2002:a19:428f:: with SMTP id p137mr10246789lfa.149.1567865603510; Sat, 07 Sep 2019 07:13:23 -0700 (PDT) Received: from localhost.localdomain (31-211-229-121.customers.ownit.se. [31.211.229.121]) by smtp.gmail.com with ESMTPSA id u10sm1741316lfk.34.2019.09.07.07.13.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 07 Sep 2019 07:13:22 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Cc: Jeff King Subject: [PATCH 6/7] git-merge-index.txt: wrap shell listing in "----" Date: Sat, 7 Sep 2019 16:12:52 +0200 Message-Id: X-Mailer: git-send-email 2.23.0 In-Reply-To: References: MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The example output of `git merge-index` has been enriched by a second "column" of helpful comments. When Asciidoctor renders this, the cells in that second column aren't aligned. Fix this by marking the example shell session as a code listing by wrapping it in "----". Also drop some of the horizontal space between the two columns so that we fit into 80 columns. This changes the rendering with both AsciiDoc and Asciidoctor. They now render this identically, nicely aligned, and within 80 columns. Signed-off-by: Martin Ågren --- Documentation/git-merge-index.txt | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt index 02676fb391..2ab84a91e5 100644 --- a/Documentation/git-merge-index.txt +++ b/Documentation/git-merge-index.txt @@ -54,20 +54,24 @@ original is first. But the argument order to the 3-way merge program Examples: - torvalds@ppc970:~/merge-test> git merge-index cat MM - This is MM from the original tree. # original - This is modified MM in the branch A. # merge1 - This is modified MM in the branch B. # merge2 - This is modified MM in the branch B. # current contents +---- +torvalds@ppc970:~/merge-test> git merge-index cat MM +This is MM from the original tree. # original +This is modified MM in the branch A. # merge1 +This is modified MM in the branch B. # merge2 +This is modified MM in the branch B. # current contents +---- or - torvalds@ppc970:~/merge-test> git merge-index cat AA MM - cat: : No such file or directory - This is added AA in the branch A. - This is added AA in the branch B. - This is added AA in the branch B. - fatal: merge program failed +---- +torvalds@ppc970:~/merge-test> git merge-index cat AA MM +cat: : No such file or directory +This is added AA in the branch A. +This is added AA in the branch B. +This is added AA in the branch B. +fatal: merge program failed +---- where the latter example shows how 'git merge-index' will stop trying to merge once anything has returned an error (i.e., `cat` returned an error From patchwork Sat Sep 7 14:12:53 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 11136495 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 2FF7F1745 for ; Sat, 7 Sep 2019 14:13:32 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 112202178F for ; Sat, 7 Sep 2019 14:13:32 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="U8jTiDmm" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2405992AbfIGON2 (ORCPT ); Sat, 7 Sep 2019 10:13:28 -0400 Received: from mail-lj1-f194.google.com ([209.85.208.194]:40845 "EHLO mail-lj1-f194.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2404502AbfIGON2 (ORCPT ); Sat, 7 Sep 2019 10:13:28 -0400 Received: by mail-lj1-f194.google.com with SMTP id 7so8577831ljw.7 for ; Sat, 07 Sep 2019 07:13:26 -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=B3MU+Sr1k0h3hnv2InjelCQagHzlzo9aUgj0bMVobdk=; b=U8jTiDmmAHMWnURYwjsS0jShUQZYeKLVaDTfVRn8jOP8ZtufpOf2S3/FayKtZ5nx0R LUNtp9+pDEUpmxwL+wPgFrsfyQrPHCAR/e0H+6m10IX3WAUqUUohOJw4rcqyxxwDxYm7 FTWv4IhLLZhFk/c0X1RtYq16T1aqhCUGo5UnG1pirXG2jyq8FW4FxESIr+m+wbItbHrU sROKW+ttOhIbFRUgbtjK2TTriv+7kb2ms8HZaorA79AkJffoWome8s86ksWlw0NxSELz Up0Jan1qmc4a2LiY7ACG5I9pwyUq0X4mMyfQLl6evcte1bRKgd4YWzbHOXmLBPjvelSX VKrQ== 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=B3MU+Sr1k0h3hnv2InjelCQagHzlzo9aUgj0bMVobdk=; b=bAydqpqXoCuRe+8l0SmNJJvjDN8TxwcmRUi3J7+XilK8ANC31yr9ImLuWpjmKm/OoA pV/vDefriDQ7c8pnvnzE5yA6q1dpiiqJxATiamhI+Ng4G7zrfmBCaA0XUx1Qvqeo1UUL 38BIKHh6lxx3/mrdYqo+MHsieMx7n3XE3Lt8ODhXvvE7Dri1u69VjJbZgBj6w+FcSNTl feP4Vtt6VHkfBueQSvCmZ5WAf45dblycg1b1+5GJiUmBaLg+MobHXrgZ+VfT250eXvab x58CoO3HIbd6LRcPxbJuuBWMt4FTPaVFU7B1FDochQIWtU10tDhxvvGeClZgqpi2xmxD Xh+g== X-Gm-Message-State: APjAAAVn/1GIzCgiEMPSJQQa286LJVp0uCxxzAqpkc6W2tsc4zc+VPO3 E5z08An0YaDQ4mLBLvC6r36qfqhD X-Google-Smtp-Source: APXvYqxBPkFZy40TVE7Jh0z7pF94UCsLeE9VeNaKYhUCEryYgY4QVzioqEmjXNLn0LdSlwNJTU+e7A== X-Received: by 2002:a2e:9145:: with SMTP id q5mr301604ljg.76.1567865605292; Sat, 07 Sep 2019 07:13:25 -0700 (PDT) Received: from localhost.localdomain (31-211-229-121.customers.ownit.se. [31.211.229.121]) by smtp.gmail.com with ESMTPSA id u10sm1741316lfk.34.2019.09.07.07.13.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 07 Sep 2019 07:13:24 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Cc: Jeff King Subject: [PATCH 7/7] gitweb.conf.txt: switch pluses to backticks to help Asciidoctor Date: Sat, 7 Sep 2019 16:12:53 +0200 Message-Id: <19c355cbe5e39f48bba30e84e655100be62119d4.1567707999.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.23.0 In-Reply-To: References: MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org This paragraph uses a lot of +pluses+ to render text as monospace. That works fine with AsciiDoc (8.6.10), and almost fine with Asciidoctor (1.5.5), which renders the third of these literally ("+$projname+"). The reason seems to be that Asciidoctor trips on the lone plus a bit earlier, even though it is escaped. Switch +$projname+ to `$projname`, and change the next, similar instance too (+$projname/+), because otherwise, we'd trip on /that one/ instead. If we would stop there, we would now start falling over on the escaped plus ('\+') mentioned earlier, rendering /it/ literally. So change that too... In other words, unescape the lone '+' and change all the pluses that follow it to backticks. AsciiDoc renders this paragraph identically before and after this commit, and Asciidoctor now renders this the same as AsciiDoc. I did try to switch the whole paragraph to using backticks rather than pluses. That worked great with Asciidoctor, but confused AsciiDoc... Let's go with this rather surgical change instead. Signed-off-by: Martin Ågren --- Documentation/gitweb.conf.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt index 35317e71c8..7963a79ba9 100644 --- a/Documentation/gitweb.conf.txt +++ b/Documentation/gitweb.conf.txt @@ -786,9 +786,9 @@ forks:: subdirectories of project root (basename) to be forks of existing projects. For each project +$projname.git+, projects in the +$projname/+ directory and its subdirectories will not be - shown in the main projects list. Instead, a \'\+' mark is shown - next to +$projname+, which links to a "forks" view that lists all - the forks (all projects in +$projname/+ subdirectory). Additionally + shown in the main projects list. Instead, a \'+' mark is shown + next to `$projname`, which links to a "forks" view that lists all + the forks (all projects in `$projname/` subdirectory). Additionally a "forks" view for a project is linked from project summary page. + If the project list is taken from a file (+$projects_list+ points to a