From patchwork Wed Apr 10 00:37:33 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Todd Zullinger X-Patchwork-Id: 10892889 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 49D1213B5 for ; Wed, 10 Apr 2019 00:37:44 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 2652A28984 for ; Wed, 10 Apr 2019 00:37:44 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 1A99828986; Wed, 10 Apr 2019 00:37: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,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 9E95F28984 for ; Wed, 10 Apr 2019 00:37:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726774AbfDJAhm (ORCPT ); Tue, 9 Apr 2019 20:37:42 -0400 Received: from pb-smtp1.pobox.com ([64.147.108.70]:56038 "EHLO pb-smtp1.pobox.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726755AbfDJAhl (ORCPT ); Tue, 9 Apr 2019 20:37:41 -0400 Received: from pb-smtp1.pobox.com (unknown [127.0.0.1]) by pb-smtp1.pobox.com (Postfix) with ESMTP id 2813E13DCFE; Tue, 9 Apr 2019 20:37:39 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=pobox.com; h=from:to:cc :subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; s=sasl; bh=ocDMbGmnrP5daKwU+Ke3nH9Pj Z4=; b=ZfGcjYOA5WWtjO9vCj+I5LID7bVLn3qKMdCLw0IT8sOkWzuds0z4MBV/A dsWQMGylahfahqxd+sj3e5S+lTAXq3+TSg0g+XX2m7R/ws23xchJjfWELeQDgMxq 0VDhok0GdUGPTjE7qwDOlpD+Q66eLEwpqyh20rDvQ2e8MlKvKM= DomainKey-Signature: a=rsa-sha1; c=nofws; d=pobox.com; h=from:to:cc :subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; q=dns; s=sasl; b=COMGDdo9H5Hn4tLgFjy yRgWqnecYlwto15M7WiyJ8KQ1vzdHixenFNi5QmpkY5MtNNC6e3AtkR3ZXIZy35r 64VJeeoVhz0QVGGK7uzVx5+1FxdFr55DgMBy8jmC6S7/rscv8ELbjy8Qr+CQpOsn o4A2B2NQogcwtTjvrXzEMl+Y= Received: from pb-smtp1.nyi.icgroup.com (unknown [127.0.0.1]) by pb-smtp1.pobox.com (Postfix) with ESMTP id 207D713DCFD; Tue, 9 Apr 2019 20:37:39 -0400 (EDT) Received: from morphine.paradise.teonanacatl.net (unknown [47.202.93.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by pb-smtp1.pobox.com (Postfix) with ESMTPSA id 52A0D13DCF9; Tue, 9 Apr 2019 20:37:37 -0400 (EDT) From: Todd Zullinger To: =?utf-8?q?Martin_=C3=85gren?= Cc: Git Mailing List , "brian m. carlson" , Jeff King , =?utf-8?q?SZEDER_G=C3=A1bor?= Subject: [PATCH v2 1/2] Documentation/git-show-branch: avoid literal {apostrophe} Date: Tue, 9 Apr 2019 20:37:33 -0400 Message-Id: <20190410003734.17124-2-tmz@pobox.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: References: MIME-Version: 1.0 X-Pobox-Relay-ID: D7A42EB4-5B28-11E9-82A4-1646B3964D18-09356542!pb-smtp1.pobox.com Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP The {apostrophe} was needed at the time of a521845800 ("Documentation: remove stray backslash in show-branch discussion", 2010-08-20). All other uses of {apostrophe} were removed in 6cf378f0cb ("docs: stop using asciidoc no-inline-literal", 2012-04-26). Unfortunately, the {apostrophe} is rendered literally with Asciidoctor (at least with 1.5.5-2.0.3). Avoid this by using single-quotes. Escaping the leading single-quote allows the content to render properly in AsciiDoc and Asciidoctor. Signed-off-by: Todd Zullinger --- Documentation/git-show-branch.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index 4a01371227..5cc2fcefba 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -167,7 +167,7 @@ $ git show-branch master fixes mhf ------------------------------------------------ These three branches all forked from a common commit, [master], -whose commit message is "Add {apostrophe}git show-branch{apostrophe}". +whose commit message is "Add \'git show-branch'". The "fixes" branch adds one commit "Introduce "reset type" flag to "git reset"". The "mhf" branch adds many other commits. The current branch is "master". From patchwork Wed Apr 10 00:37:34 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Todd Zullinger X-Patchwork-Id: 10892891 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 ED27513B5 for ; Wed, 10 Apr 2019 00:37:45 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id D99DF28984 for ; Wed, 10 Apr 2019 00:37:45 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id CDC5828986; Wed, 10 Apr 2019 00:37:45 +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,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 75A7128984 for ; Wed, 10 Apr 2019 00:37:45 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726787AbfDJAho (ORCPT ); Tue, 9 Apr 2019 20:37:44 -0400 Received: from pb-smtp1.pobox.com ([64.147.108.70]:64418 "EHLO pb-smtp1.pobox.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726766AbfDJAhn (ORCPT ); Tue, 9 Apr 2019 20:37:43 -0400 Received: from pb-smtp1.pobox.com (unknown [127.0.0.1]) by pb-smtp1.pobox.com (Postfix) with ESMTP id D08B413DD00; Tue, 9 Apr 2019 20:37:40 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=pobox.com; h=from:to:cc :subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; s=sasl; bh=IupBwIbzmyx/AuNd8qhpTHw7R M0=; b=o7QokI5wotFA5mr2+XSe6qfFtVpwumad2/Dj8e+sq0MfC1hGMs+dfNU+w mcXnh0TRA0UAsjBTnrj0jaPAKFSVLE6QE0Ga3IYnhbhIDR76nh7whGkcUjcdTpvY BalGHwCBgYeDSYCNlcXsVgEbAyt/HFUC+VNITgExXkApgR1ZWc= DomainKey-Signature: a=rsa-sha1; c=nofws; d=pobox.com; h=from:to:cc :subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; q=dns; s=sasl; b=HvlfWEd9g/bkFG6o6EW ndV5w1XK3ImBr7J70kRU35dX1NiI0REvGxFwCXi9BZnoUJoAciDWXusA0P/qfneQ Y7o77c3LB9P56lHI7lSWZv9zt/Ugo647FfglJSNqPdMgNridR7PI/S6sF9LiUIFu /MfZbPU8fnhoeduKQdYWJSX4= Received: from pb-smtp1.nyi.icgroup.com (unknown [127.0.0.1]) by pb-smtp1.pobox.com (Postfix) with ESMTP id C8A7C13DCFF; Tue, 9 Apr 2019 20:37:40 -0400 (EDT) Received: from morphine.paradise.teonanacatl.net (unknown [47.202.93.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by pb-smtp1.pobox.com (Postfix) with ESMTPSA id 08CFD13DCFC; Tue, 9 Apr 2019 20:37:38 -0400 (EDT) From: Todd Zullinger To: =?utf-8?q?Martin_=C3=85gren?= Cc: Git Mailing List , "brian m. carlson" , Jeff King , =?utf-8?q?SZEDER_G=C3=A1bor?= Subject: [PATCH v2 2/2] Documentation/git-svn: improve asciidoctor compatibility Date: Tue, 9 Apr 2019 20:37:34 -0400 Message-Id: <20190410003734.17124-3-tmz@pobox.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: References: MIME-Version: 1.0 X-Pobox-Relay-ID: D8A7E454-5B28-11E9-8EFB-1646B3964D18-09356542!pb-smtp1.pobox.com Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP The second paragraph in the CONFIGURATION section intends to emphasize the word 'must' with bold type. It does so by writing it as *must*, and this works fine with AsciiDoc. It usually works great with Asciidoctor, too, but in this particular instance, we have another "*" earlier in the paragraph. We do escape it, and it is rendered literally just like we want it to, but Asciidoctor then ends up tripping on the second (or third) of the asterisks in this paragraph. Since that asterisk is (part of) a literal example, we can set it in monospace, by giving it as `*`. Adjust the whole paragraph in this way. There's lots more monospacing to be done in this document, but since our main motivation is addressing AsciiDoc/Asciidoctor discrepancies like this one, let's just convert this one paragraph. Signed-off-by: Todd Zullinger --- Documentation/git-svn.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt index b99029520d..81aaef8e4e 100644 --- a/Documentation/git-svn.txt +++ b/Documentation/git-svn.txt @@ -1100,10 +1100,10 @@ listed below are allowed: tags = tags/*/project-a:refs/remotes/project-a/tags/* ------------------------------------------------------------------------ -Keep in mind that the '\*' (asterisk) wildcard of the local ref -(right of the ':') *must* be the farthest right path component; +Keep in mind that the `*` (asterisk) wildcard of the local ref +(right of the `:`) *must* be the farthest right path component; however the remote wildcard may be anywhere as long as it's an -independent path component (surrounded by '/' or EOL). This +independent path component (surrounded by `/` or EOL). This type of configuration is not automatically created by 'init' and should be manually entered with a text-editor or using 'git config'.