From patchwork Sat May 15 11:56:42 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259723 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-20.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9BD01C433ED for ; Sat, 15 May 2021 11:57:02 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 7FFD2613B5 for ; Sat, 15 May 2021 11:57:02 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231954AbhEOL6N (ORCPT ); Sat, 15 May 2021 07:58:13 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53200 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231874AbhEOL6L (ORCPT ); Sat, 15 May 2021 07:58:11 -0400 Received: from mail-oi1-x233.google.com (mail-oi1-x233.google.com [IPv6:2607:f8b0:4864:20::233]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BB885C061573 for ; Sat, 15 May 2021 04:56:57 -0700 (PDT) Received: by mail-oi1-x233.google.com with SMTP id j75so2039681oih.10 for ; Sat, 15 May 2021 04:56:57 -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=13FZ22kzClkXXGCXWszEtqo2ZqmLq3CraeHJYFpBRZU=; b=ij6rtM46p5GbPWEAFEJSoyqjBA5QETmwZ9MraJZ00I4KWg9hkzUPj+t9NAIhY6fGoE iNouxtvXiJmVY2NWVF7+j04erUbCa16Aw+BYxL/iAJ9mvXahSE72qFk2oYDGvZDTzH/N E5zyPp2t1C/I08Cthx1bEgpdqnafVTfYsNWW9wv94/HAHx5jwNOS4p0TUgp9Qw0OY0P8 XnfwBMtsS5eOaeWGUgB9EFq93N7+7PiflfZcmb8gj0LwRWzDo2ucYHoEy+EOARaqGuQ4 1lM5wa+A0EpIJmH4pc1DaZx7JzgDCkCxTDX/1FZMIE3omSPDr54wPjv5PRh+jMNSAZ24 qnJQ== 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=13FZ22kzClkXXGCXWszEtqo2ZqmLq3CraeHJYFpBRZU=; b=szQAAZH9JUIBphgH3rbc3YLnevTNuLNeYmhl/ucMT5/uyoQ+fayXQtreTVgN0mn5TM WB1RXETsJp4ipsw3R5Cp9XVYR5beXy196sltayK693gV8UPYRWAAYuq9WFBR5VGpkMXj LlglJMtoHJxQPT1kKLHwyPRN3CusKaC05zIclCsD+pDsknZC/13RSf97yxw5tHcJ0AQ3 qxTzt/F4OWViMPrX2ny0MV8GNIfjrSJLRnOG/pgDGy4LOO27dS9ZkGPKaeqWaKO6oKPv OpnZCRnjayvbbJHdCeq22AXjCVPunaD25T/ZTtUrzq0vWLoZjcu1arnhbo7r5857rkbu ki1Q== X-Gm-Message-State: AOAM530ZJ9MFRU94GaAw/lB4Bm97TSsSyGWookN0bJCjY0QP9V/l00D2 hgDtyWYCOSXpS8/kplFaI6Z2l5m8k49D/Q== X-Google-Smtp-Source: ABdhPJyM5jlyVwTEqEfNojbF5yVdEDrvFBrlnyTcL/zF85dQOnjo9ZgL8MQg3QyNzC7HAyCJpYIB0A== X-Received: by 2002:aca:4acf:: with SMTP id x198mr36527314oia.111.1621079816898; Sat, 15 May 2021 04:56:56 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id f9sm1932354otq.27.2021.05.15.04.56.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:56:56 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 01/12] doc: remove GNU troff workaround Date: Sat, 15 May 2021 06:56:42 -0500 Message-Id: <20210515115653.922902-2-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org In 2007 the docbook project made the mistake of converting ' to \' for man pages [1]. It's a problem because groff interprets \' as acute accent which is rendered as ' in ASCII, but as ยด in utf-8. This started a cascade of bug reports in git [2], debian [3], Arch Linux [4], docbook itself [5], and probably many others. A solution was to use the correct groff character: \(aq, which is always rendered as ', but the problem is that such character doesn't work in other troff programs. A portable solution required the use of a conditional character that is \(aq in groff, but ' in all others: .ie \n(.g .ds Aq \(aq .el .ds Aq ' The proper solution took time to be implemented in docbook, but in 2010 they did it [6]. So the docbook man page stylesheets were broken from 1.73 to 1.76. Unfortunately by that point many workarounds already existed. In the case of git GNU_ROFF was introduced, and in the case of Arch Linux a mappig from \' to ' was added to groff's man.local. Other distributions might have done the same, or similar workarounds. Since 2010 there is not need for this workaround, which is fixed elsewhere not just in docbook, but other layers as well. Let's remove it. Also, it's GNU troff, not GNU roff. [1] https://github.com/docbook/xslt10-stylesheets/commit/ea2a0bac56c56eec1892ac3d9254dca89f7c5746 [2] https://lore.kernel.org/git/20091012102926.GA3937@debian.b2j/ [3] https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=507673#65 [4] https://bugs.archlinux.org/task/9643 [5] https://sourceforge.net/p/docbook/bugs/1022/ [6] https://github.com/docbook/xslt10-stylesheets/commit/fb553434265906ed81edc6d5f533d0b08d200046 Inspired-by: brian m. carlson Signed-off-by: Felipe Contreras --- Documentation/Makefile | 8 -------- Documentation/manpage-quote-apos.xsl | 16 ---------------- Makefile | 4 ---- 3 files changed, 28 deletions(-) delete mode 100644 Documentation/manpage-quote-apos.xsl diff --git a/Documentation/Makefile b/Documentation/Makefile index f5605b7767..bf1f66b3eb 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -178,14 +178,6 @@ MAN_BASE_URL = file://$(htmldir)/ endif XMLTO_EXTRA += -m manpage-base-url.xsl -# If your target system uses GNU groff, it may try to render -# apostrophes as a "pretty" apostrophe using unicode. This breaks -# cut&paste, so you should set GNU_ROFF to force them to be ASCII -# apostrophes. Unfortunately does not work with non-GNU roff. -ifdef GNU_ROFF -XMLTO_EXTRA += -m manpage-quote-apos.xsl -endif - ifdef USE_ASCIIDOCTOR ASCIIDOC = asciidoctor ASCIIDOC_CONF = diff --git a/Documentation/manpage-quote-apos.xsl b/Documentation/manpage-quote-apos.xsl deleted file mode 100644 index aeb8839f33..0000000000 diff --git a/Makefile b/Makefile index 93664d6714..2a94cef62f 100644 --- a/Makefile +++ b/Makefile @@ -278,10 +278,6 @@ all:: # Define NO_ST_BLOCKS_IN_STRUCT_STAT if your platform does not have st_blocks # field that counts the on-disk footprint in 512-byte blocks. # -# Define GNU_ROFF if your target system uses GNU groff. This forces -# apostrophes to be ASCII so that cut&pasting examples to the shell -# will work. -# # Define USE_ASCIIDOCTOR to use Asciidoctor instead of AsciiDoc to build the # documentation. # From patchwork Sat May 15 11:56:43 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259725 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 21567C433B4 for ; Sat, 15 May 2021 11:57:07 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id F3BD161354 for ; Sat, 15 May 2021 11:57:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232046AbhEOL6R (ORCPT ); Sat, 15 May 2021 07:58:17 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53202 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231945AbhEOL6M (ORCPT ); Sat, 15 May 2021 07:58:12 -0400 Received: from mail-ot1-x32b.google.com (mail-ot1-x32b.google.com [IPv6:2607:f8b0:4864:20::32b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 319E8C061573 for ; Sat, 15 May 2021 04:56:59 -0700 (PDT) Received: by mail-ot1-x32b.google.com with SMTP id q7-20020a9d57870000b02902a5c2bd8c17so1585927oth.5 for ; Sat, 15 May 2021 04:56:59 -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=raFWYFYkVE4caVIeSt2SrGvqtr2T1dX0y+bluv07/iM=; b=vPSMJTO+udG1y7ioISFqIEcrRZtib4SpHp2XhrwO3QIhR5H2rG0S6r7x3yZ8+2P0Rr Xa4ZldBA/VewcNj5361NT86esfZVtZo5WO1C4Fmj6g54OBIc0OqTXut41ku8pWKCDXV1 +Ru/viPw868HQ+vDsJePcUWBIFmrfSpnWJ6a1RaiFDK4yHFjoZeGd+/R90fy3XXfswOp OTj91oBz3pPhgluVxS9qnvEpvmOHcXBQfgLASGzop6L2spIfKdVl8mkH3oBjQ1USbkV4 5e97THvT8lbwvCJuO/UEBQHp7AlR9tRaskae+VQh5dswo/+Zo/4+dAteySbePW15828o ySqA== 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=raFWYFYkVE4caVIeSt2SrGvqtr2T1dX0y+bluv07/iM=; b=qc5N7qqGnVDpcCLrxvGxmUEBJBA3hJQ1AmEfPBt3174hDSm/hW//puraUz3d3lNwkv gdLbUv8XfnF9F5UOn7xUaZkskVZufUQ4D/pm1HEQQavIzH7+8ZfSC7Lmp+Ett9XRQM+0 R5gvn5lgYPQ+opZQ5n4IUhgshSFOvmLuWnir25togVmxGGDHqbsG0+inUNFk1HMxoBwM Ha2D8I/HLQcmPkGA4zAbfGbSQbG9AGRboF2dpvHgGUvGg7NzNoWsUzyzxggN4TmlF6gs 8AQIUvEwOj3YAWbv3YfpzdsN1tH7iocnQUFpwSRu8Dyq9nhEqxSIzC4F72p2Yes+mp1q akrw== X-Gm-Message-State: AOAM530gmAMEgI2dRI0H1L9sAV4a6t5SI4InrZ/+4cxZpkdvSaZ/OOmr udhW7oqa49lFz4wPVeYPiWJ0ysn5UjAcFw== X-Google-Smtp-Source: ABdhPJwg8+tLeebXl8NL3ztXYLdfPBRAnl4pXkPEcUx8jj5/uqletqvBLYJjJkrrYgoV8nkWFyPLvw== X-Received: by 2002:a9d:8d6:: with SMTP id 80mr9788302otf.33.1621079818416; Sat, 15 May 2021 04:56:58 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id 16sm1932006otu.79.2021.05.15.04.56.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:56:58 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 02/12] doc: use --stringparam in xmlto Date: Sat, 15 May 2021 06:56:43 -0500 Message-Id: <20210515115653.922902-3-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Commit 50d9bbba92 (Documentation: Avoid use of xmlto --stringparam, 2009-12-04) introduced manpage-base-url.xsl because ancient versions of xmlto did not have --stringparam. However, that was more than ten years ago, no need for that complexity anymore. Signed-off-by: Felipe Contreras --- Documentation/.gitignore | 1 - Documentation/Makefile | 8 ++------ Documentation/manpage-base-url.xsl.in | 10 ---------- 3 files changed, 2 insertions(+), 17 deletions(-) delete mode 100644 Documentation/manpage-base-url.xsl.in diff --git a/Documentation/.gitignore b/Documentation/.gitignore index 9022d48355..e9f8d693b1 100644 --- a/Documentation/.gitignore +++ b/Documentation/.gitignore @@ -10,7 +10,6 @@ howto-index.txt doc.dep cmds-*.txt mergetools-*.txt -manpage-base-url.xsl SubmittingPatches.txt tmp-doc-diff/ GIT-ASCIIDOCFLAGS diff --git a/Documentation/Makefile b/Documentation/Makefile index bf1f66b3eb..84643a34e9 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -176,7 +176,7 @@ endif ifndef MAN_BASE_URL MAN_BASE_URL = file://$(htmldir)/ endif -XMLTO_EXTRA += -m manpage-base-url.xsl +XMLTO_EXTRA += --stringparam man.base.url.for.relative.links='$(MAN_BASE_URL)' ifdef USE_ASCIIDOCTOR ASCIIDOC = asciidoctor @@ -342,7 +342,6 @@ clean: $(RM) technical/*.html technical/api-index.txt $(RM) SubmittingPatches.txt $(RM) $(cmds_txt) $(mergetools_txt) *.made - $(RM) manpage-base-url.xsl $(RM) GIT-ASCIIDOCFLAGS $(MAN_HTML): %.html : %.txt $(ASCIIDOC_DEPS) @@ -351,10 +350,7 @@ $(MAN_HTML): %.html : %.txt $(ASCIIDOC_DEPS) $(OBSOLETE_HTML): %.html : %.txto $(ASCIIDOC_DEPS) $(QUIET_ASCIIDOC)$(TXT_TO_HTML) -o $@ $< -manpage-base-url.xsl: manpage-base-url.xsl.in - $(QUIET_GEN)sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@ - -%.1 %.5 %.7 : %.xml manpage-base-url.xsl $(wildcard manpage*.xsl) +%.1 %.5 %.7 : %.xml $(wildcard manpage*.xsl) $(QUIET_XMLTO)$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $< %.xml : %.txt $(ASCIIDOC_DEPS) diff --git a/Documentation/manpage-base-url.xsl.in b/Documentation/manpage-base-url.xsl.in deleted file mode 100644 index e800904df3..0000000000 From patchwork Sat May 15 11:56:44 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259727 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 56C1EC433ED for ; Sat, 15 May 2021 11:57:13 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 3016A61354 for ; Sat, 15 May 2021 11:57:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232153AbhEOL6W (ORCPT ); Sat, 15 May 2021 07:58:22 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53212 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232027AbhEOL6Q (ORCPT ); Sat, 15 May 2021 07:58:16 -0400 Received: from mail-ot1-x329.google.com (mail-ot1-x329.google.com [IPv6:2607:f8b0:4864:20::329]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C6CC8C061573 for ; Sat, 15 May 2021 04:57:00 -0700 (PDT) Received: by mail-ot1-x329.google.com with SMTP id i23-20020a9d68d70000b02902dc19ed4c15so1641640oto.0 for ; Sat, 15 May 2021 04:57:00 -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=WbWoYgvt/tW5xz3bC9UhkyBUsad/cCPG2DBw/TN8na8=; b=bC/OLc6LOTDzZPqVWShrcTik50QqIlXErkkyi6f79ZnvFRyhDSQLeJqxC4RGy/VhFH YCRfBdSeI/vzzTIGMSiCMNZONMGCA4xS1B1TScyn4fHDZ03aKygDZpE+BZGWJzRHryTi tFFED6rKSTUllUdp4NwyjssugRh81U1jVYXekfPGtBX8gRRZD6dM2/IbssOGhwmxmbX2 cccxxYyy0/Lo3KEUROIeC/5uxxyt7Nn6umMg8gpM4ubhymB4rzuSk9X8CGXRZHvINGRZ JsV+QdOhw4VmYzUTJvN48vfWcIY2t2Tvimn+jkI4hppXtxl/Dkyh2DOOCeHjbAkj3eMX AK6A== 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=WbWoYgvt/tW5xz3bC9UhkyBUsad/cCPG2DBw/TN8na8=; b=RI7+xXbNm9B3EnOI0SQWryCfPmmUCTegi10e+pkndcc469Ua1/S63CamqJw4KnZO2z l+GKnMc10gBBBUlEv3XXOrwmw7a/wEM4sD07lEz28vShpGq/yMho0FKJnfNeOzC8+2eB mR+PauDwTrGfAis+6o2LFyIG9dCSr7SfIH4KwczGzSndONp+6JT5FBSMF1S7rhWethA0 9p3UK6YHnv4bEAwUuvsnA+SqDlntj5NSh0lyyosWn2JrQfcNLAwjTa8kX3ONc8EfqylC M7tTkrtSW/Elavm2L4HsxBlY5WY5uKgEiusmeolcVq8XTU91SiFi5ioFmLHPSrzcWFOI ciUg== X-Gm-Message-State: AOAM530cqYZJmgrpyjFE3CC5nEFfJ5hy2Z6e4u8PdBMD+Ay1k3l1WexU y1LTWbN7tEvU3vNwAPSSCLgRlaVDMQFApA== X-Google-Smtp-Source: ABdhPJw8eq1uR6LZmevpfNgnyWVM9lcfpIBpaq0E9XLP7e2PwYE/z9yuxIMg8KT9k1XPxHS880TS6Q== X-Received: by 2002:a9d:192e:: with SMTP id j46mr14730746ota.346.1621079819945; Sat, 15 May 2021 04:56:59 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id d185sm1727310oib.25.2021.05.15.04.56.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:56:59 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 03/12] doc: simplify version passing Date: Sat, 15 May 2021 06:56:44 -0500 Message-Id: <20210515115653.922902-4-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The code to pass the version of the man page comes from 2007: 7ef195ba3e (Documentation: Add version information to man pages, 2007-03-25). However, both asciidoc and asciidoctor already do this by default. Asciidoctor doesn't read manversion, but there's no need since both tools just join mansource and manversion. Let's do that ourselves and get rid of a bunch of code. Signed-off-by: Felipe Contreras --- Documentation/Makefile | 3 +-- Documentation/asciidoc.conf | 19 ------------------- Documentation/asciidoctor-extensions.rb | 17 ----------------- 3 files changed, 1 insertion(+), 38 deletions(-) diff --git a/Documentation/Makefile b/Documentation/Makefile index 84643a34e9..47053c78f8 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -137,8 +137,7 @@ ASCIIDOC_HTML = xhtml11 ASCIIDOC_DOCBOOK = docbook ASCIIDOC_CONF = -f asciidoc.conf ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \ - -amanversion=$(GIT_VERSION) \ - -amanmanual='Git Manual' -amansource='Git' + -amanmanual='Git Manual' -amansource='Git $(GIT_VERSION)' ASCIIDOC_DEPS = asciidoc.conf GIT-ASCIIDOCFLAGS TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML) TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK) diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf index 3e4c13971b..60f76f43ed 100644 --- a/Documentation/asciidoc.conf +++ b/Documentation/asciidoc.conf @@ -51,25 +51,6 @@ ifdef::doctype-manpage[] endif::doctype-manpage[] endif::backend-docbook[] -ifdef::doctype-manpage[] -ifdef::backend-docbook[] -[header] -template::[header-declarations] - - -{mantitle} -{manvolnum} -{mansource} -{manversion} -{manmanual} - - - {manname} - {manpurpose} - -endif::backend-docbook[] -endif::doctype-manpage[] - ifdef::backend-xhtml11[] [attributes] git-relative-html-prefix= diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index d906a00803..70a0956663 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -23,26 +23,9 @@ module Git end end end - - class DocumentPostProcessor < Asciidoctor::Extensions::Postprocessor - def process document, output - if document.basebackend? 'docbook' - mansource = document.attributes['mansource'] - manversion = document.attributes['manversion'] - manmanual = document.attributes['manmanual'] - new_tags = "" \ - "#{mansource}\n" \ - "#{manversion}\n" \ - "#{manmanual}\n" - output = output.sub(/<\/refmeta>/, new_tags + "") - end - output - end - end end end Asciidoctor::Extensions.register do inline_macro Git::Documentation::LinkGitProcessor, :linkgit - postprocessor Git::Documentation::DocumentPostProcessor end From patchwork Sat May 15 11:56:45 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259729 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5A7D5C433B4 for ; Sat, 15 May 2021 11:57:19 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 382C561354 for ; Sat, 15 May 2021 11:57:19 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232164AbhEOL60 (ORCPT ); Sat, 15 May 2021 07:58:26 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53222 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232040AbhEOL6Q (ORCPT ); Sat, 15 May 2021 07:58:16 -0400 Received: from mail-oi1-x229.google.com (mail-oi1-x229.google.com [IPv6:2607:f8b0:4864:20::229]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5503FC061756 for ; Sat, 15 May 2021 04:57:02 -0700 (PDT) Received: by mail-oi1-x229.google.com with SMTP id b25so2121638oic.0 for ; Sat, 15 May 2021 04:57:02 -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=yIqQBfEdH5opye+2jtHlPSoJoDotMhI4gSjXvYXRgUc=; b=jkZ2feUk8Qey3LXmfI6fn/knMwIgJAwMsh39J+9Ul+QlaoGVVAn1PPMNBOfo3j14H3 Sdf7CEhiCFPbvIYmVtw1zLMx2OqlOrX2q0EwJAsivxDZrlz9WEdGKnDSrZOoL2rBWpJ5 uzHYtE7qFWQxp3UollICW86xSiTEsyajsK+RcYQ4PiCDcLX2X4WZtDZrW79qKXM3TLly 2aas8YxY67tWm3LlawXRfrBHnS52w+fXOQVO9i0PC5zbNauVF9b6GVAM5iqZ4M9SFDpU TvqWSXJce5BnwiBFINmLw1+GvI75ABPRBJoYG1mXg1CvyWCzf2oEp8m/uf8AMKX/MoLa fR8g== 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=yIqQBfEdH5opye+2jtHlPSoJoDotMhI4gSjXvYXRgUc=; b=rHxSj7kvuYTIrYZLH3+L+B131Ik1rZ+A89b3Ap8xq6O8RViJyKJAyuXs4+lMeAR2C8 KAHpFnuyuZ/L+AGgvVXaSSIcJwl5BXXhygbCPHEe0GyHr5TtcwVkEJ0VjCxZOUJfy9i7 oX/eiKyg16xvacLqD3SUGElfSDCeReor/rzmWhyWhu6fNyiJ8zTDDnbDyIKUMruCQXcF BaH67h3XwpgfSIzjeezN9BVA6g25ssFc4UnmuUoz9Q2w7VEW+DhrdqZoczFLzDcaoP7Q byj1rIpZYsLwuEPAQixFmx3tzdHqNwiDxU7z+zNQjx8SLOIhtqqQwxynWhtdXSx1WcWe jIcQ== X-Gm-Message-State: AOAM530nAsx+F2lJXeSvPWYiKRxxCAdpdTvZxQJwj8SHxqsXkA7wtWQM 7oeq+TUvkPcU1tAvtn97ZVKiyQYNMp/22g== X-Google-Smtp-Source: ABdhPJz+H4w7dwKgdQwT3GRxnYhztLkbfWQ76mBdRwuYH21Tb2+w9D2CI8DqSNIY2phQ9GZAeZbKxw== X-Received: by 2002:a05:6808:345:: with SMTP id j5mr9911495oie.106.1621079821575; Sat, 15 May 2021 04:57:01 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id z9sm1912823oog.25.2021.05.15.04.57.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:57:01 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 04/12] doc: asciidoc: remove unnecessary attribute Date: Sat, 15 May 2021 06:56:45 -0500 Message-Id: <20210515115653.922902-5-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org It's part of asciidoc global configuration since 2012. Signed-off-by: Felipe Contreras --- Documentation/asciidoc.conf | 1 - 1 file changed, 1 deletion(-) diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf index 60f76f43ed..f7908f9dea 100644 --- a/Documentation/asciidoc.conf +++ b/Documentation/asciidoc.conf @@ -12,7 +12,6 @@ [attributes] asterisk=* -plus=+ caret=^ startsb=[ endsb=] From patchwork Sat May 15 11:56:46 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259731 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id CC745C433B4 for ; Sat, 15 May 2021 11:57:21 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id A5D4461354 for ; Sat, 15 May 2021 11:57:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232217AbhEOL6d (ORCPT ); Sat, 15 May 2021 07:58:33 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53234 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231958AbhEOL6S (ORCPT ); Sat, 15 May 2021 07:58:18 -0400 Received: from mail-oi1-x22a.google.com (mail-oi1-x22a.google.com [IPv6:2607:f8b0:4864:20::22a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E05C0C06175F for ; Sat, 15 May 2021 04:57:03 -0700 (PDT) Received: by mail-oi1-x22a.google.com with SMTP id x15so2027112oic.13 for ; Sat, 15 May 2021 04:57:03 -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=mQNgCPhzxzCFTTlDUt00GfHjGdusv/qaDXTiOv2Fkqo=; b=DZFpKBs/hI+WcNt32HwXnVRAkghXi+64aWp8QpPVsH4fmaOaWeA7u9g8yXdnd0/ADA DceO6HEwxBW/s4CyF8Y4sKupB5YPug26IMr9DjTvRYG7YcYT57hvYGhomWAzm/gfeNWm xXHRcZGsCaB3qfCK8JoxlbTuqafkZTiTZVjJ9GOpL+AYxnKI3GOqbY8iOnJVXsp9fyk1 2u+Umgr4E/JaO7abb0Da43v0irsJqKZW/+O2prTHSr+CbnO8LcQoK2x/eVA4+5YO5ppQ FQbTUC3R6og86/NgnjS1LWcUVhWfIkvkbLyFvfQlfG9Pws8VKirqC6ZmRlhhYrZrw5yK vJmQ== 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=mQNgCPhzxzCFTTlDUt00GfHjGdusv/qaDXTiOv2Fkqo=; b=P63e5ZvUNXb6ZZNwipphso5Halo67syevtvljmTr9TCl8Y1Xa/p/XYoP6DAyxge5Uy KVfGheGuDYmnsTmhTCpqe3eqNK+kpWfHqhz3XRQU3Hbto/uBwWU7mkvFiKzdboy8g1TM ijoUHDDWvHDBcsEIulvvqA5oryQqaiU2sMVpvG4t8Mi8utDLC2uMJX32yvvOzNKDSY51 flG7IfmZN6CJaEu/B45+p9zBnzKJO6btVqBeSg05MGIPRgyxLZb2D1IuNyNyfL3sTZUP 25oOhSFjElezo7n5v/lO2Rj1DckK1X0LgwL2MhFVI03fPom/nrv51BRhLCbffTS0fCuN SbLw== X-Gm-Message-State: AOAM531mHq4a3X+RXsGa3TGxGRupd+JDHhfaUxzub1aU6WC4gLzEOYeH CYqxW352ImvfAyRRpPgLTe8og6B0pkQpJg== X-Google-Smtp-Source: ABdhPJy5aE2N5Xgomjww1KPXrMaAHvQwMvuhHwak+nx2TgnRYbwPP0CUyWs6WtAchCy74fF9AC3W4g== X-Received: by 2002:aca:4752:: with SMTP id u79mr20829068oia.86.1621079823110; Sat, 15 May 2021 04:57:03 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id h81sm1709159oif.53.2021.05.15.04.57.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:57:02 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 05/12] doc: asciidoctor: remove unnecessary require Date: Sat, 15 May 2021 06:56:46 -0500 Message-Id: <20210515115653.922902-6-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org This file is loaded by asciidoctor, the module is already loaded. In addition to being less redundant this fixes a problem while trying use a development version of asciidoctor when the gem is available: $GEM_HOME/gems/asciidoctor-2.0.15/lib/asciidoctor.rb:51: warning: already initialized constant Asciidoctor::RUBY_ENGINE $HOME/asciidoctor/lib/asciidoctor.rb:52: warning: previous definition of RUBY_ENGINE was here ... That's a bug in asciidoctor, but there's no need to trigger it. Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 1 - 1 file changed, 1 deletion(-) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index 70a0956663..423450392d 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -1,4 +1,3 @@ -require 'asciidoctor' require 'asciidoctor/extensions' module Git From patchwork Sat May 15 11:56:47 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259733 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 38F5CC433ED for ; Sat, 15 May 2021 11:57:23 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 14A87613BE for ; Sat, 15 May 2021 11:57:23 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232227AbhEOL6f (ORCPT ); Sat, 15 May 2021 07:58:35 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53242 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231874AbhEOL6T (ORCPT ); Sat, 15 May 2021 07:58:19 -0400 Received: from mail-ot1-x32d.google.com (mail-ot1-x32d.google.com [IPv6:2607:f8b0:4864:20::32d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 89199C061760 for ; Sat, 15 May 2021 04:57:05 -0700 (PDT) Received: by mail-ot1-x32d.google.com with SMTP id r26-20020a056830121ab02902a5ff1c9b81so1566714otp.11 for ; Sat, 15 May 2021 04:57:05 -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=qryDjEvV0FR5O6sICM8r4iYOMLB0UcHl5tSJzPfl088=; b=nfFEZzovFPAxHmeltyLKXW13MK1V1e3hYUCbulYZCIF+zvdZWFfDQP8vgOtutL0ilE 4Dl3c5b/GjcCOgGMsAt6cXM6YJF/i76xqbRrkDcSkHF8DjRpNks9dkRq4PP3oIpOewHC TUHZRGn9cwvOVYSgxaigqcc54aD0Zj2ktvsPBfBBiiqirN1TvlkUGOY0DEDv0CojUp3x F/Hg553M37hhTsuSuU25IgJ/DyIaAn9aUjnyvDTbp5yoWo18ZSAKDc8je3GtT0jvMTIF 4ENzBRFl4cneI/PlTc0i+s1s4FQgbwHxfuiAOc7EIoeiSIV5T0Fi2mHK3lyFJYOD52t+ feFA== 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=qryDjEvV0FR5O6sICM8r4iYOMLB0UcHl5tSJzPfl088=; b=FU/uDxumvknWuY4fkraeLIq9A04ROjqYXMs8y3ecQfV/FpT3cKh5zAQ7vO+X3WjDBa iBHYZOZbQFm1N7MiK9aokVqVyhjWnnCT7svR/39C5nEoBrS9dR2KBt+6VcRRDL8OJPFe WDCM54V9GvYTfUW/zhmiOZ0dyiI/XnuzLN/hdQKtdgIz7rQ4LjPV2qaCQFt0JPxoRWjo sd4XGp+OE+c7sDt4RbWD9H5eC33Da2wAH8ofLOfNz+oxuUSA85SNDe0L0m4Z45Ab1DqC 9QbvGc23BCCkkYzpFBfYx/NhLnbWScxCfSiMVt/rfHKlr9zTGpSHlcVIlgwZMEVcxPlc PTFg== X-Gm-Message-State: AOAM531YpV5al7VSD1gAQQPMjRtKu6hjD/evZQzSTXhrrCn+qbYIiJev bdnrLo9mn3Iwwj00UF4GqYuuZveRoGJnJw== X-Google-Smtp-Source: ABdhPJy7eBFtjVY3ijnDX13XMKLuJPLLEjinKIF2Imj6lJBZpFTxFVzlhq8wsvY+rdBzenzSoZB++g== X-Received: by 2002:a05:6830:44f:: with SMTP id d15mr5402233otc.369.1621079824775; Sat, 15 May 2021 04:57:04 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id b8sm1768818ots.6.2021.05.15.04.57.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:57:04 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 06/12] doc: asciidoctor: remove cruft Date: Sat, 15 May 2021 06:56:47 -0500 Message-Id: <20210515115653.922902-7-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org These were probably copy-pasted from other extensions. The name is already defined (:linkgit), and we are not using the DSL mode. Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 4 ---- 1 file changed, 4 deletions(-) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index 423450392d..3dea106d00 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -3,10 +3,6 @@ require 'asciidoctor/extensions' module Git module Documentation class LinkGitProcessor < Asciidoctor::Extensions::InlineMacroProcessor - use_dsl - - named :chrome - def process(parent, target, attrs) prefix = parent.document.attr('git-relative-html-prefix') if parent.document.doctype == 'book' From patchwork Sat May 15 11:56:48 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259735 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1B740C433B4 for ; Sat, 15 May 2021 11:57:24 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 00EF4613BB for ; Sat, 15 May 2021 11:57:23 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232280AbhEOL6f (ORCPT ); Sat, 15 May 2021 07:58:35 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53244 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232091AbhEOL6V (ORCPT ); Sat, 15 May 2021 07:58:21 -0400 Received: from mail-ot1-x334.google.com (mail-ot1-x334.google.com [IPv6:2607:f8b0:4864:20::334]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1D0FEC061761 for ; Sat, 15 May 2021 04:57:07 -0700 (PDT) Received: by mail-ot1-x334.google.com with SMTP id q7-20020a9d57870000b02902a5c2bd8c17so1586109oth.5 for ; Sat, 15 May 2021 04:57:07 -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=JgEvKmc077hG4bm8gYHUHuo+y9Iyra6rLQgekB1DkjQ=; b=LpdaCrUmXTDPaO/Nd209jP+29Si8jP7xFDpLB0wVKAxYHwtYjj6Kd9wQJjs/EiZkPe JAzTLtYUlarw8j3tXiZ7mnwXGLAUk4FtdxVwfPh4hx/ZrRSx3KscOaVpMIvOnIA+6iiX SxxNYlWh8LgyPg2Q7pOfGhdN4tAo3kNjF3qBG0hiq9ld5adEE37b/h5mh3NrkL+fLfjS ZcgZbNxdroo/E3Z9u9QkkL8qbNXd6ApuNZcr5LEW8TnAuVdxjcldt1T85byuCRI+doKE YbbEnnIpK/mul68BfgclflRlyAwOsLzdfvEKG2RQIBblry5IJ22aq8+p6oC5JlcoKI2J lAYA== 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=JgEvKmc077hG4bm8gYHUHuo+y9Iyra6rLQgekB1DkjQ=; b=dX7vJLsbNu7p13nienaoBbqJ3FhCRcHq2J7XN0T6uqdCZo5S6vdJPr2jk41W6AqaBU LDFbW8xBk/IlGWq5XT8p9xWBHLG1ClZfjc3TDkDBptDCpKlYUfF1j26PpeneFar5EWNT GP5XC2NCF6aaG5lH+HgAbCzcxBW+xp6KP4BAArZ47simqv/zip33p+HrIXP4iZg4gB2c OR7bUuhBKyyECLFbJSqdYHNS0ExuBCG0ePvYfIqYi9Vf7fSd3oHJK2cexHLdqu9XtLzc fu7xV1j/HrdnJ5HNd7B4Y6H81+ogw/VAgUJZ6p1IE03KsG91TvU7jERTdTl1E8DRbvcE ehxw== X-Gm-Message-State: AOAM530TGXTfqnMyXNWddhoF9VsBYWfuVnT1OrE5g6YhHNIxV1ml40e0 9Mtiiw5pF6lUmovvnUnJU6+2C5dVvkoYtw== X-Google-Smtp-Source: ABdhPJzb8NPEvkXRYeqjM+MphXFOPg0IpSe9KD6/kJYYDmTmM81DbVbp8L3O0LD5Mnz+35r4HfIvuA== X-Received: by 2002:a05:6830:33ea:: with SMTP id i10mr42824458otu.212.1621079826321; Sat, 15 May 2021 04:57:06 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id a12sm1897932oti.12.2021.05.15.04.57.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:57:06 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 07/12] doc: asciidoctor: reorganize extensions Date: Sat, 15 May 2021 06:56:48 -0500 Message-Id: <20210515115653.922902-8-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org There's no need to create verbose classes, we can do the same with a simple block. Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 34 +++++++++++-------------- 1 file changed, 15 insertions(+), 19 deletions(-) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index 3dea106d00..f998a42249 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -1,26 +1,22 @@ require 'asciidoctor/extensions' -module Git - module Documentation - class LinkGitProcessor < Asciidoctor::Extensions::InlineMacroProcessor - def process(parent, target, attrs) - prefix = parent.document.attr('git-relative-html-prefix') - if parent.document.doctype == 'book' - "" \ - "#{target}(#{attrs[1]})" - elsif parent.document.basebackend? 'html' - %(#{target}(#{attrs[1]})) - elsif parent.document.basebackend? 'docbook' - "\n" \ - "#{target}" \ - "#{attrs[1]}\n" \ - "" - end +Asciidoctor::Extensions.register do + + inline_macro :linkgit do + process do |parent, target, attrs| + prefix = parent.document.attr('git-relative-html-prefix') + if parent.document.doctype == 'book' + "" \ + "#{target}(#{attrs[1]})" + elsif parent.document.basebackend? 'html' + %(#{target}(#{attrs[1]})) + elsif parent.document.basebackend? 'docbook' + "\n" \ + "#{target}" \ + "#{attrs[1]}\n" \ + "" end end end -end -Asciidoctor::Extensions.register do - inline_macro Git::Documentation::LinkGitProcessor, :linkgit end From patchwork Sat May 15 11:56:49 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259737 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A910FC433B4 for ; Sat, 15 May 2021 11:57:30 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8D61F613BE for ; Sat, 15 May 2021 11:57:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232113AbhEOL6l (ORCPT ); Sat, 15 May 2021 07:58:41 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53234 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232122AbhEOL6V (ORCPT ); Sat, 15 May 2021 07:58:21 -0400 Received: from mail-ot1-x32f.google.com (mail-ot1-x32f.google.com [IPv6:2607:f8b0:4864:20::32f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9FA6FC061573 for ; Sat, 15 May 2021 04:57:08 -0700 (PDT) Received: by mail-ot1-x32f.google.com with SMTP id g15-20020a9d128f0000b02902a7d7a7bb6eso1570904otg.9 for ; Sat, 15 May 2021 04:57:08 -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=c1FiGAYtyFmV77j2EhKLB7vcqiackZIC91cYe2eWj9A=; b=l/RXPcIbu7+Rv+M05FntpZ+MuyWDM73Ywd1rjI8rZ7baRlSz5jLKbx0JRIh2TWQ/Zj sT6suGJ0YvlmHBsTpRiJ0xvGDtbr5ij2fzp1EKw/8eccgerNOwsP/GWLbIXPLTDrq7gn E1kcBlbrch5Q4aDI3X73icUroy5ZzucT2bopq0a7rOSNsR63BC1BajgB3jdZ1eejvk8b /lsZu8QtVdXkfhgUwBuk9aDxRft/n1KI83RW1gdORV23g+sGf6tjmgJchPygemnIMqYu sRH3MzyI87DOG1SgycnyTQFO68GMHVz9rSgTAytfZF2OeuUG3ewBEkoD0ZbJ+DF7uJ50 wmAg== 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=c1FiGAYtyFmV77j2EhKLB7vcqiackZIC91cYe2eWj9A=; b=kFElnV52MAcw2dGBrfhZJiuUZbElrPa39Vb0xNUwoncUPR3zKo8KuepIKzd4ZW3iOu 86PNtC1Sxb1hMxASGZoSXh5/OPANmBlRo+fhxiprX3JL0a4EPzVxee9q0Vd3foRlQ2Z2 PAHn46uSsY8J6Z7SxUouWh+iFhLVl1enUNMEVkeLtUlGmG6PPhsyCSqwWfjspPGuNltv ZYH4PP7ELVvcexhrcftlfDuvGa9RCKenA+X9rQu/1vrGM0xafEbxLag8Ts+4UgJ3c9Xn jGgrFh+urTbiWnNihKLrEt+2UOBYH+pz4VmHbyT1AuYalq9NKoGBR5Mh4dzt3KHNY9uj bG4A== X-Gm-Message-State: AOAM5327YT6bCTQ40AwQIuEGjJFk9WdhyVNoEYo7edzT7GiGGikyb9Nw vFJNBSvSVHMzO8ZsR8dBWuWQJc953XI56Q== X-Google-Smtp-Source: ABdhPJxutud09zYRdCNTmr41Ts6f+JKQmbXhEPEfm/gBZrQINTGD08rFUsW5DdbOK1yc4L/rr7qWkg== X-Received: by 2002:a9d:542:: with SMTP id 60mr13024459otw.143.1621079827835; Sat, 15 May 2021 04:57:07 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id y191sm1710432oia.50.2021.05.15.04.57.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:57:07 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 08/12] doc: asciidoctor: use html-prefix only for html Date: Sat, 15 May 2021 06:56:49 -0500 Message-Id: <20210515115653.922902-9-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org This is what asciidoc.conf does. Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index f998a42249..c77b6de350 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -4,11 +4,11 @@ Asciidoctor::Extensions.register do inline_macro :linkgit do process do |parent, target, attrs| - prefix = parent.document.attr('git-relative-html-prefix') if parent.document.doctype == 'book' - "" \ + "" \ "#{target}(#{attrs[1]})" elsif parent.document.basebackend? 'html' + prefix = parent.document.attr('git-relative-html-prefix') %(#{target}(#{attrs[1]})) elsif parent.document.basebackend? 'docbook' "\n" \ From patchwork Sat May 15 11:56:50 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259739 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A594EC43460 for ; Sat, 15 May 2021 11:57:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 860D9613BB for ; Sat, 15 May 2021 11:57:31 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232357AbhEOL6n (ORCPT ); Sat, 15 May 2021 07:58:43 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53244 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232058AbhEOL6X (ORCPT ); Sat, 15 May 2021 07:58:23 -0400 Received: from mail-ot1-x329.google.com (mail-ot1-x329.google.com [IPv6:2607:f8b0:4864:20::329]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2C11BC06174A for ; Sat, 15 May 2021 04:57:10 -0700 (PDT) Received: by mail-ot1-x329.google.com with SMTP id r26-20020a056830121ab02902a5ff1c9b81so1566827otp.11 for ; Sat, 15 May 2021 04:57:10 -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=apjKSujSu4w8CQegGCTqnVAiw/yjz7fz3BaJnD9wLwI=; b=QhHVgR4FU/FW81BMtjGo78R4qZ6t8P4Kqc9EocfqGcF1QxmiiExU62SZMkvjAZn3xw JEv7exS575NfFbAkQ+77M1pz0T7Ncj6V71CAB97W5DT+s0i4EvjNp8M8rWk0/1Qu/+71 qxl44ogSbEu1Py9sNEzKPixx552TTXTX0ep2jBichHFenQcOhk2N06I8duDgP9ycvcZi Drn0BcO3Fdw2o6vrWpVi41Z3vBBqAIFsQG3AIpRL9pl+DO3VsHzdl1m/Z/LpzYbx5Jx0 MB+3X2lFKzGnUidMq6fcJm1JFD97bv8zHK9zJLtrLcfsbzVAKTFm36EOkXxUrtWR5p0i 9Wyw== 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=apjKSujSu4w8CQegGCTqnVAiw/yjz7fz3BaJnD9wLwI=; b=H1FyaxeC7DOSSIA47TQVvhTHWIt4IeyS7sryixUBo6mxF+0JQ/ji1yyTa+YKms5QBr 2XLUO+wCQwIT7MaUT9g7i1ZaTiwbBQOkVY2tqMcM6Xln/Kp9w1A33FFSXOEuQX4Ocrti 3kNuNtS/21BR8aswdGowpBsMRSbuh92bw6W27CI2ZKncgTtw3PtSQnpuFHe+mmRTJcZs XbIBKrL3uWDXHM2anKs5MDUZ+TSsDFMZZDcLCKcE/BuBsPvu12oVx4fGr3kN7J1HwJBA g7WonHCqUac94oOvbhmskgy9JYrrFRvxn4fNd5CSJpMhceN9/Ek8L9soG1z7h2QzbOmL sOAA== X-Gm-Message-State: AOAM530BCsunu27IORLq3j2Lq5OdYBsgIX7OOYeQCxwfcCQAaRzD+nH1 WN7JYdbsy14ovF/jO2X+BIQ1pPLgu2hDmQ== X-Google-Smtp-Source: ABdhPJxOSALS6hsf3edPSeririyvzVDJ/7vzW5miBRY0c91QAaDZANrnMzZKYgcP6a8srMdDHqjLMQ== X-Received: by 2002:a9d:39e3:: with SMTP id y90mr44587177otb.257.1621079829378; Sat, 15 May 2021 04:57:09 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id a14sm1880969otl.52.2021.05.15.04.57.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:57:09 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 09/12] doc: asciidoctor: refactor macro registration Date: Sat, 15 May 2021 06:56:50 -0500 Message-Id: <20210515115653.922902-10-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org There is no need to execute extra code every time the process block is called. In Ruby the lexical scope is shared, so we can define variables in the register block scope, and all the rest will inherit those variables. Based on the doctype and basebackend one of three blocks is selected for the inline_macro. However, the conditionals will be run only once. In the end Ruby will only run the code between `process do end`, nothing else. Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index c77b6de350..a678704e17 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -2,15 +2,21 @@ require 'asciidoctor/extensions' Asciidoctor::Extensions.register do + doc = document + inline_macro :linkgit do - process do |parent, target, attrs| - if parent.document.doctype == 'book' + if doc.doctype == 'book' + process do |parent, target, attrs| "" \ "#{target}(#{attrs[1]})" - elsif parent.document.basebackend? 'html' - prefix = parent.document.attr('git-relative-html-prefix') + end + elsif doc.basebackend? 'html' + prefix = doc.attr('git-relative-html-prefix') + process do |parent, target, attrs| %(#{target}(#{attrs[1]})) - elsif parent.document.basebackend? 'docbook' + end + elsif doc.basebackend? 'docbook' + process do |parent, target, attrs| "\n" \ "#{target}" \ "#{attrs[1]}\n" \ From patchwork Sat May 15 11:56:51 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259741 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 46836C433B4 for ; Sat, 15 May 2021 11:57:35 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 29EDA613BE for ; Sat, 15 May 2021 11:57:35 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232402AbhEOL6o (ORCPT ); Sat, 15 May 2021 07:58:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53270 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232048AbhEOL6Z (ORCPT ); Sat, 15 May 2021 07:58:25 -0400 Received: from mail-oi1-x233.google.com (mail-oi1-x233.google.com [IPv6:2607:f8b0:4864:20::233]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BDE92C061756 for ; Sat, 15 May 2021 04:57:11 -0700 (PDT) Received: by mail-oi1-x233.google.com with SMTP id u144so2063493oie.6 for ; Sat, 15 May 2021 04:57:11 -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=olozIVNhVgtSAXctiCjsf3xwZ45sV7h/dHKCx2S9C38=; b=Td6jZetiilfzhPTxyubHL+FFp8NkxqIlE45mI6YY/+2Tgx6WMZobQ6WMAWVBD3n9r0 fnVdk9T0x5hI80WYwAZcEAT9wONcdVUITKVfrmkGpWNdC+N4FXWE4en5kRJl3AaHm6/r tjaEnHOA+tM1dhsbfJW/Iw5Yl8/tPf9wCAlYrNKadmHerjvGF9+KMlPlF67oOxt+pJzY wgwFsDijTsR0MFrmATl0vNUHAh+2BXHFia5oGCGoRe9xd9aq4OaAIJVW1UlzTgzOLYZN W5me2l7+wqeXDPh/S7I0tz/gKADuqUT7/tdIkK3uXazSAiMfMU3v6cVrKeYZGpeRBj8B 5kug== 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=olozIVNhVgtSAXctiCjsf3xwZ45sV7h/dHKCx2S9C38=; b=AG2jsE3go3tG57+yax2+KX70IUYgUdPtfGmfPj9Pf5DvNuYRPBJR29yIZeYPJDSybP c4Pq0KEyNlr8kXblqU23lAty1JfqHiSYiijNsHeDGqiCudtdtUKP/Q4FqVCUvn08kTRk QwbpxlWyYSjZz3O4dGrmrAJTndHI+G63uBTwWr4wZa52IUMp2PIfDWd/k0jcNVSbfvuL St/pp6MXF4xjY2Y6yYAFlyjN0NM6WIkCOQTUitpMvqs2Ms7duqnBxCjql9OyjDEkUr/p /2Spyd3pHcoIDMg6hbyqf1qVSsOn16GYgDkIN8V90uibNtLZZARbCeVR+jCyWQ2Y+L8s WThg== X-Gm-Message-State: AOAM531B5V+WFHobcZNnu02OqiFL8Psckpk9surmSmIYNTy1R36ETH3P SOFvZYvk6fq5mZK5+PFZ/pLNAJuwixW6Cw== X-Google-Smtp-Source: ABdhPJwy1Bc1Nqwy8hGZp7SVNu0zCT3a4YeKH43CPxuxb4H+A3PDQHmlbTwmC914oed0sMstAMushg== X-Received: by 2002:aca:b605:: with SMTP id g5mr16694183oif.127.1621079830906; Sat, 15 May 2021 04:57:10 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id u13sm1879830oop.40.2021.05.15.04.57.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:57:10 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 10/12] doc: asciidoctor: improve string handling Date: Sat, 15 May 2021 06:56:51 -0500 Message-Id: <20210515115653.922902-11-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Using printf style formatting (more familiar to git developers), and also here document. Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index a678704e17..eb2326d05a 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -7,20 +7,20 @@ Asciidoctor::Extensions.register do inline_macro :linkgit do if doc.doctype == 'book' process do |parent, target, attrs| - "" \ - "#{target}(#{attrs[1]})" + '%1$s(%2$s)' % [target, attrs[1]] end elsif doc.basebackend? 'html' prefix = doc.attr('git-relative-html-prefix') process do |parent, target, attrs| - %(#{target}(#{attrs[1]})) + %(%1$s(%2$s)) % [target, attrs[1]] end elsif doc.basebackend? 'docbook' process do |parent, target, attrs| - "\n" \ - "#{target}" \ - "#{attrs[1]}\n" \ - "" + <<~EOF % [target, attrs[1]] + + %s%s + + EOF end end end From patchwork Sat May 15 11:56:52 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259743 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 28BE8C433ED for ; Sat, 15 May 2021 11:57:37 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 10E15613BE for ; Sat, 15 May 2021 11:57:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232479AbhEOL6s (ORCPT ); Sat, 15 May 2021 07:58:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53274 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232158AbhEOL60 (ORCPT ); Sat, 15 May 2021 07:58:26 -0400 Received: from mail-oi1-x22e.google.com (mail-oi1-x22e.google.com [IPv6:2607:f8b0:4864:20::22e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 60375C061760 for ; Sat, 15 May 2021 04:57:13 -0700 (PDT) Received: by mail-oi1-x22e.google.com with SMTP id d21so2031841oic.11 for ; Sat, 15 May 2021 04:57:13 -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=Vs+U+Bfnb+fyY7OD/4TdfbLYOyIyvSPGeQ78H8t66Nw=; b=DSQ/BnXLHR1r/MyZRUT98t+jPdznlJzkfJslad2+YZZcfpPW9CkP8XpMguzK/9dIUu 8tL4lWRx7ZDUMn4xI30olonZSglMiAQ5Oho5x5FgvcDNTD0D2F/SenUALqqR1ng4pqu/ Y78FzhwXhiEnaT16gQ943kUYqoYWuJgubyfPAYVVqENyMPYxFimCEViSrtfTDEm5HIs9 Tx7gh1+WHy2PhfkIcYgng33+8Zwm+ledfGH6F8bdUwE1HiR78TnzWrudKPQKwtQdj6kH j+TyXd4f0GpLSBnZqiWPA50Xb0x05i2TQ6Vrkz7NbqJZPDo8LWJVb8yz4zhKYRkTRnYW vQyg== 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=Vs+U+Bfnb+fyY7OD/4TdfbLYOyIyvSPGeQ78H8t66Nw=; b=SOXhVViZpX1Rqcu8mJ/Z1K8vGV/5bu1OCrBiysTGFb3GeNCxJBeydqENvV/UTXa01s AnLD/gfGLt7kkxBmOS/tbd6QP5KzucZ2R62aTZQHdVO+ob2nX87EO1SVh0tIa7hr34Uy uJ9VwZmlsCzVJfmZWOtgodEI2zQ3sJGbAH3R4W8IadhlAbslN+YUDB/WWf6w8oAhRsfy 4RA2ZggRR27an0QBhBvnpPGyuqqwb2GFmojwhnOpIHhQaWd3hrezRaibhWs/+jhDUA9t cngE87BqgBK9EZmZxAJBcIZlLgP5IUhIuVhnX8KAChQqiL+eFeuiNGOyAEqm6bweSHqT +AsA== X-Gm-Message-State: AOAM530CVQU+YJSpg/nc0tXtvvrjv7u783lpL/ZDVRQCb1bQPqCmUk9/ GSnV7yuzssk+hkXXx5xNnG34WpcT6TTBKw== X-Google-Smtp-Source: ABdhPJx36bNO38OJ4CfXi/I+ChonAi9mCPD/G5cECQ7RYZWUgKO3S7vBtTkQGEx1zd8IXu0qZ8JTOA== X-Received: by 2002:aca:490d:: with SMTP id w13mr9688443oia.140.1621079832534; Sat, 15 May 2021 04:57:12 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id e26sm1669143oig.9.2021.05.15.04.57.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:57:12 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 11/12] doc: asciidoctor: split the format from the code Date: Sat, 15 May 2021 06:56:52 -0500 Message-Id: <20210515115653.922902-12-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org This way we don't have to specify the block to execute on every conditional. Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 26 ++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index eb2326d05a..f7696f19f6 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -6,22 +6,22 @@ Asciidoctor::Extensions.register do inline_macro :linkgit do if doc.doctype == 'book' - process do |parent, target, attrs| - '%1$s(%2$s)' % [target, attrs[1]] - end + format = '%1$s(%2$s)' elsif doc.basebackend? 'html' prefix = doc.attr('git-relative-html-prefix') - process do |parent, target, attrs| - %(%1$s(%2$s)) % [target, attrs[1]] - end + format = %(%1$s(%2$s)) elsif doc.basebackend? 'docbook' - process do |parent, target, attrs| - <<~EOF % [target, attrs[1]] - - %s%s - - EOF - end + format = <<~EOF + + %s%s + + EOF + else + return + end + + process do |_, target, attrs| + format % [target, attrs[1]] end end From patchwork Sat May 15 11:56:53 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12259745 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id DA9BAC433ED for ; Sat, 15 May 2021 11:57:40 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id C0C90613BE for ; Sat, 15 May 2021 11:57:40 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232508AbhEOL6u (ORCPT ); Sat, 15 May 2021 07:58:50 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53282 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232071AbhEOL62 (ORCPT ); Sat, 15 May 2021 07:58:28 -0400 Received: from mail-oi1-x22b.google.com (mail-oi1-x22b.google.com [IPv6:2607:f8b0:4864:20::22b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id F3670C061761 for ; Sat, 15 May 2021 04:57:14 -0700 (PDT) Received: by mail-oi1-x22b.google.com with SMTP id u144so2063611oie.6 for ; Sat, 15 May 2021 04:57:14 -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=W6N4jxMo55GMX5lrFsIFzBI3CPTu1IHcZkXoi2Fld7I=; b=Qk7dYMH3FTjUcdQXEgesU6ZzAzyhhxau2RAN/Ro0UKRJGniDaHPPzaHIkT63fFN+O1 UjhhWOZmV6Zs3wgjlC4a7j5xiaQUUIctuANwfqHcSf/Pl2nsck+p+YhJUd8/SJAlxdtM oEx/uxtEZ8w7IMRNhFPA/zrWjnf0rPBo+jpWlqF+X1Zi/EFTHsTuLZzTAa3Mb2qw6mEu 3ExU7l1GnD9KCaQIB+1dlCFE1rKXKdOl/J/Q7JyqKEwt4katrtXGfiw87+Xo9U9aVqWf CZsVHIztn4UwawcRglDld/Q4zT/0HXFrWFZgzLaJ+DEWFPf6lg8QyKhr1t4U4yJUeRc2 9ExQ== 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=W6N4jxMo55GMX5lrFsIFzBI3CPTu1IHcZkXoi2Fld7I=; b=rc1mQLcf9w5RzcpW3PQ6ad3lzS7nNR4HcB5zSHLzf0BQpYgA7CdrH2pdstRYiXUHCA 3wICNePmHkewsOywXaSm0AZ9QzG/1/rlz7dMczEnMFIMtC31pxqq4Wuq8lX9rlov4gd+ Si8gdEEYsJ3NFO1xJfSeStmg7orDUPX3CnhOSdW3+hVaU+xuGI/j4nKG88qmWuoWISYz ycVkjHE4WEbLRRnEtnsvbD3LBO9lZCNN1WVnm9Xqep/Xa6HLQERp1RDENWaYhv2mSJNb WGAM+WRPDC3yKNxODqY2wHITNBh4vDNdyOUInS8UBtCrUuIyFhPgNj90HCEaN0gxlqWz /4fw== X-Gm-Message-State: AOAM532vDPAKeNKOMG5A7EyrwQYtfdkri8xXdwNtA4Gx1KDM1Dfyy8Mx IPjfi3HhYKhK13g8mjcXrw0bwrn2/Mxi0w== X-Google-Smtp-Source: ABdhPJyL5jwo4erloEj0g6epx2ezzv1h8nrttJsWPKSyX1EKPkbj8+JEVCEUYBQYkd1zzNe43wmVWw== X-Received: by 2002:a05:6808:214:: with SMTP id l20mr8227111oie.62.1621079834253; Sat, 15 May 2021 04:57:14 -0700 (PDT) Received: from localhost (fixed-187-189-165-231.totalplay.net. [187.189.165.231]) by smtp.gmail.com with ESMTPSA id w66sm1909474ooa.37.2021.05.15.04.57.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 15 May 2021 04:57:13 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Felipe Contreras Subject: [PATCH 12/12] doc: asciidoctor: specify name of our group Date: Sat, 15 May 2021 06:56:53 -0500 Message-Id: <20210515115653.922902-13-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210515115653.922902-1-felipe.contreras@gmail.com> References: <20210515115653.922902-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Doesn't do anything, but otherwise we get a random name. Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index f7696f19f6..7d1b94a266 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -1,6 +1,6 @@ require 'asciidoctor/extensions' -Asciidoctor::Extensions.register do +Asciidoctor::Extensions.register :git do doc = document