From patchwork Fri May 14 12:14:25 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12257625 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.8 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 CE01BC43460 for ; Fri, 14 May 2021 12:14:45 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id A57146144C for ; Fri, 14 May 2021 12:14:45 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232644AbhENMPz (ORCPT ); Fri, 14 May 2021 08:15:55 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50388 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231839AbhENMPv (ORCPT ); Fri, 14 May 2021 08:15:51 -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 A1F8EC06174A for ; Fri, 14 May 2021 05:14:39 -0700 (PDT) Received: by mail-ot1-x32b.google.com with SMTP id 36-20020a9d0ba70000b02902e0a0a8fe36so19953984oth.8 for ; Fri, 14 May 2021 05:14:39 -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=CYs7BMRj1obWvw1DLh1in2k6rfxujAKOs6KmlKeI2wk=; b=eftQEtJ//oH3p8isrvHLrua/EQyfNGzAdXZXDb+6fGxDYoK49cmt3Y+LvTZyBOyOKy 6uwnkJYD3umdLV8/763ba31ppRPq1NINLqfIoMLkvzSiMah0ZOXo+98YDCRHcX4dXALn uT2lj9L9sDShBerHZTcqzoG/SyiPzhtxSd0HNPuauS0s5saj9/+wnd0tqSjTe63Wrw25 2NDy1WSCa09w9BI6zDACg8sAlk+zW308oqT7luv1grj7QZbWM+05ArqqTm0ff9UOwniu M2Nt1SiULUMO4lKqhs1cCTq2ge/DI36PkmgiXIL0Mu+Fdld8RJmwPcEJm1ZBtLabMeh5 l6nw== 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=CYs7BMRj1obWvw1DLh1in2k6rfxujAKOs6KmlKeI2wk=; b=W1P+P5m4Mry9gt/E6NeWF/e7N3png7ARkFTBR/KG9yeW4iEItTOYB0Vx+Pn/wxBUHa pSfdjKQ6hRW3HUlUPCyQrrD/b2fXkEVyioY1vKN3FUb7aF91SZnki/EmhGmySNCE82Ff VEepgkcf1FcP9N8juo4bOKWUpao34L/3GAFz9u/fV0WisJKbZIgrdagk7g1b11RK+nMV 2wYzljLOKdpoKibh4xEaldSDCLzU5mdiFptc7/Z+kXSougMsHSqUketulP20+l6Urvbb /pW7btzs8opfDSi6Nsc0uuJovdvQtawZyp9rjTmb9z8f6w5B0FljS888pbysHUWB+sja iBlg== X-Gm-Message-State: AOAM530xC4KVhqFWxYDRfn54ncN492lr92wCpaXuyCQ8auValS96maUR PIpAs1yoQKMB432ZreQcVUzYbizQXv1HVA== X-Google-Smtp-Source: ABdhPJwkzY3NQ2BYnNSBmqF7y5KFGvdR0LQCXQOr5ZWvwiHXyoLU3eOq2EE75mlAtgw6oNVITbu/pg== X-Received: by 2002:a9d:5a5:: with SMTP id 34mr40462454otd.353.1620994478721; Fri, 14 May 2021 05:14:38 -0700 (PDT) Received: from localhost (fixed-187-190-78-172.totalplay.net. [187.190.78.172]) by smtp.gmail.com with ESMTPSA id j66sm1313057otj.50.2021.05.14.05.14.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 May 2021 05:14:38 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Felipe Contreras Subject: [PATCH 01/11] doc: allow the user to provide ASCIIDOC_EXTRA Date: Fri, 14 May 2021 07:14:25 -0500 Message-Id: <20210514121435.504423-2-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com> References: <20210514121435.504423-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Without `override` all additions will be ignored by make. Signed-off-by: Felipe Contreras --- Documentation/Makefile | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/Makefile b/Documentation/Makefile index f5605b7767..981e322f18 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -191,9 +191,9 @@ ASCIIDOC = asciidoctor ASCIIDOC_CONF = ASCIIDOC_HTML = xhtml5 ASCIIDOC_DOCBOOK = docbook5 -ASCIIDOC_EXTRA += -acompat-mode -atabsize=8 -ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions -ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;' +override ASCIIDOC_EXTRA += -acompat-mode -atabsize=8 +override ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions +override ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;' ASCIIDOC_DEPS = asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS DBLATEX_COMMON = XMLTO_EXTRA += --skip-validation @@ -206,12 +206,12 @@ SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH)) ifdef DEFAULT_PAGER DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER)) -ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)' +override ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)' endif ifdef DEFAULT_EDITOR DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR)) -ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)' +override ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)' endif QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir @@ -375,7 +375,7 @@ technical/api-index.txt: technical/api-index-skel.txt \ technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS)) $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh -technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../ +technical/%.html: override ASCIIDOC_EXTRA += -a git-relative-html-prefix=../ $(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt \ asciidoc.conf GIT-ASCIIDOCFLAGS $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt @@ -425,7 +425,7 @@ $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt WEBDOC_DEST = /pub/software/scm/git/docs -howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../ +howto/%.html: override ASCIIDOC_EXTRA += -a git-relative-html-prefix=../ $(patsubst %.txt,%.html,$(HOWTO_TXT)): %.html : %.txt GIT-ASCIIDOCFLAGS $(QUIET_ASCIIDOC) \ sed -e '1,/^$$/d' $< | \ From patchwork Fri May 14 12:14:26 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12257627 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.8 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 CB2C2C433ED for ; Fri, 14 May 2021 12:14:47 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9E6F661460 for ; Fri, 14 May 2021 12:14:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232769AbhENMP5 (ORCPT ); Fri, 14 May 2021 08:15:57 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50390 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232478AbhENMPx (ORCPT ); Fri, 14 May 2021 08:15:53 -0400 Received: from mail-oo1-xc30.google.com (mail-oo1-xc30.google.com [IPv6:2607:f8b0:4864:20::c30]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DD99EC061574 for ; Fri, 14 May 2021 05:14:40 -0700 (PDT) Received: by mail-oo1-xc30.google.com with SMTP id o202-20020a4a2cd30000b02901fcaada0306so6298641ooo.7 for ; Fri, 14 May 2021 05:14:40 -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=qZrtjJEPOYxI0V6zwApFtoCcpSCr4zUBrY8JWBelif0=; b=urcaCefx5VvBmgnv4vG+gepjixMg61/9owqfGwU7vMRB+eEbvNz2v7J/wyShjETpmJ 3aJl6n6L+io5G9WNL5RgH3aXTeePi0R9sD78N4Ct2XcQpPmNX7tLSeMqmu3i84XQrjcO A+QWKZzjFG4k5ZjJ1gmLtQVbTbTggao88Kd/NYd+vlU2zaJhymRtjvGEcCqhDl7k5bNx 1Oh/5jFhVKaY2HkqNDqNPXLtU6slISir/bc0GQ8pfPZhsYPavaXWHNRE4JyooX1BUCUK s0PHMRVdTwcJjgcqXV/Zk9S/lmxUfTxLHuPiP0P43XYXTBFOdw1CWXe1pNUT3SMLqcph dduQ== 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=qZrtjJEPOYxI0V6zwApFtoCcpSCr4zUBrY8JWBelif0=; b=rqxzgmpLCPasCirBOofXovo+BfSV8uFRpGuqbkrpiA0lXgO3LUOS7UwurojJf/3ScE Eu0Nu/P4kjCKEbanXoZ91BoA7XEgw/x9ccT2Ilv91dSHcHdEV19zeAaShMekj8O4hrYB YeoIu8ZhVC4UNJJWkSmOjcj7PLyGJpmNbuRu0g6e3FCKhhtMJZMjwSnkEdsFR+ZhnWeQ uKLWfJXkpITWLnOLywddvu62eTkrxNB0gq9Z7BPD2dh9ORlrz4al7Op1ZUskOXA9IZ2f xDe+U1fk5enNU71gCd666mwcB0p0kW85si3D28Umg0/HjtNuYfQjmP2IKqGKp/PVMkIh MvNA== X-Gm-Message-State: AOAM531IqAjNrPoYryIc2DyqIdgSh8WPzCIoHzk7/ndy8fS7//Hn5szd mcn8CLrzrY8xhHKX7tLmcFZMErH9InKWyg== X-Google-Smtp-Source: ABdhPJzB+G9tnQdNBpDMA/BmaINGBkV+1wBoeCHHpfNRhJyAUK9bfAZIKhyMsS9jkv7A8r6P3JHFFQ== X-Received: by 2002:a4a:3516:: with SMTP id l22mr5181406ooa.65.1620994480111; Fri, 14 May 2021 05:14:40 -0700 (PDT) Received: from localhost (fixed-187-190-78-172.totalplay.net. [187.190.78.172]) by smtp.gmail.com with ESMTPSA id s3sm1107816oie.35.2021.05.14.05.14.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 May 2021 05:14:39 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Felipe Contreras Subject: [PATCH 02/11] doc: doc-diff: allow more than one flag Date: Fri, 14 May 2021 07:14:26 -0500 Message-Id: <20210514121435.504423-3-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com> References: <20210514121435.504423-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Signed-off-by: Felipe Contreras --- Documentation/doc-diff | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/doc-diff b/Documentation/doc-diff index 1694300e50..ecd88b0524 100755 --- a/Documentation/doc-diff +++ b/Documentation/doc-diff @@ -146,7 +146,7 @@ render_tree () { # through. oid=$1 && dname=$2 && - makemanflags=$3 && + makemanflags="$3" && if ! test -d "$tmp/installed/$dname" then git -C "$tmp/worktree" checkout --detach "$oid" && @@ -181,6 +181,6 @@ render_tree () { fi } -render_tree $from_oid $from_dir $from_makemanflags && -render_tree $to_oid $to_dir $to_makemanflags && +render_tree $from_oid $from_dir "$from_makemanflags" && +render_tree $to_oid $to_dir "$to_makemanflags" && git -C $tmp/rendered diff --no-index "$@" $from_dir $to_dir From patchwork Fri May 14 12:14:27 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12257629 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.8 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 A6FC9C433B4 for ; Fri, 14 May 2021 12:14:51 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 7AA816143D for ; Fri, 14 May 2021 12:14:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232874AbhENMP7 (ORCPT ); Fri, 14 May 2021 08:15:59 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50398 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232532AbhENMPy (ORCPT ); Fri, 14 May 2021 08:15:54 -0400 Received: from mail-oi1-x22f.google.com (mail-oi1-x22f.google.com [IPv6:2607:f8b0:4864:20::22f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 93125C06174A for ; Fri, 14 May 2021 05:14:42 -0700 (PDT) Received: by mail-oi1-x22f.google.com with SMTP id v22so23384730oic.2 for ; Fri, 14 May 2021 05:14:42 -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=ebGpCx1yduU1NUxD3tFKf56pKmMHI5To+Bw+tdyWl74=; b=NYr7iW/cONwLGiyZSQtR/JE/aaz7Kt8pQ6zOCX3xL5GhJgnjFbK7M0ePp7bI31dA61 luTbMUTedf0V9VHJS1map5wZj09yV1ltEplWW9j+KsAzQYNWYzPQCkfb5QMwxmTV+4O5 LRO2Xu8NGnUGlhbRF98l5hj8ZPXsZGaKXOGtdMFRN+Mx6IT0ZSfZuG25pI7vV7OG3zXH I2vpgQvlBXb9YhWv4AhdHfX4IVZ+3v1YxXCEoM0m8RFPqikc1iTDj5SjOYV/RgaCHLbw guDEv5qlajLudbTpwJ29oo0gwnYXRDF0bkt2fl0HnQKIClo75MFUQEr81skPnvi1V/cR fXIQ== 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=ebGpCx1yduU1NUxD3tFKf56pKmMHI5To+Bw+tdyWl74=; b=CN0tcS+IIIUf+IazysmDgrfqdMBgq5Fk7jrSJ5Hkoo67RvRYkwgrHKQYeUIp7Srv/L loVsvKf7KRZyEazAXumYUEz5dDaDBfhGjwNxIhhZDYALIFmMrQr6fhRE/f0jr8YQ3oXw v0hyHorz4qmzOZr2x8U+LrTaM4ZDAPXeE3AoOcFNXvwd67VmtayaJHELSE5lnslIAI7/ yF8f6+igUDQnGdT8yxMeX/CRYdrRVcU5MzVzsZHIE6HNaR3nkbDbT9sTIv+5n0MoFAZj 39zZsl9mtKbUCodnDceSTi07XoFT/JtRlpJuoWB1u90cXzr5xWNUElEACUcySHhmVLNU NkaA== X-Gm-Message-State: AOAM530jsKCiZ/WNIRvuVfwkVlWGhm24HtaFzgXw819NxsyZgRQ4HJGU j5OqWFkPXx7WMv6fjqXtvmrI1prWg3mhIQ== X-Google-Smtp-Source: ABdhPJxtCSRND19hpeSZoH6ad4l6rxTXbD6RYKhux8+GGHvlmdQ0a/NREerweZw2oEFsDd9kppYiVg== X-Received: by 2002:aca:df55:: with SMTP id w82mr6582558oig.25.1620994481771; Fri, 14 May 2021 05:14:41 -0700 (PDT) Received: from localhost (fixed-187-190-78-172.totalplay.net. [187.190.78.172]) by smtp.gmail.com with ESMTPSA id q1sm1322689otc.21.2021.05.14.05.14.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 May 2021 05:14:41 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Felipe Contreras Subject: [PATCH 03/11] doc: doc-diff: set docdate manually Date: Fri, 14 May 2021 07:14:27 -0500 Message-Id: <20210514121435.504423-4-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com> References: <20210514121435.504423-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org In order to minimize the differences in the footer. Asciidoc automatically generates a date with format '%Y-%m-%d', while asciidoctor '%F'. I personally prefer the latter, so only modify it for diff purposes. Fixes tons of these: -Git omitted 01/01/1970 GIT-ADD(1) +Git omitted 1970-01-01 GIT-ADD(1) Signed-off-by: Felipe Contreras Signed-off-by: Martin Ågren --- Documentation/doc-diff | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/doc-diff b/Documentation/doc-diff index ecd88b0524..aae5fc1933 100755 --- a/Documentation/doc-diff +++ b/Documentation/doc-diff @@ -111,7 +111,7 @@ construct_makemanflags () { echo USE_ASCIIDOCTOR= elif test "$1" = "-asciidoctor" then - echo USE_ASCIIDOCTOR=YesPlease + echo USE_ASCIIDOCTOR=YesPlease ASCIIDOC_EXTRA='-adocdate="01/01/1970"' fi } From patchwork Fri May 14 12:14:28 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12257631 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.8 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 40626C433ED for ; Fri, 14 May 2021 12:14:59 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 1524D6144C for ; Fri, 14 May 2021 12:14:59 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232854AbhENMQD (ORCPT ); Fri, 14 May 2021 08:16:03 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50408 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232712AbhENMP4 (ORCPT ); Fri, 14 May 2021 08:15:56 -0400 Received: from mail-oi1-x230.google.com (mail-oi1-x230.google.com [IPv6:2607:f8b0:4864:20::230]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 280B1C061574 for ; Fri, 14 May 2021 05:14:44 -0700 (PDT) Received: by mail-oi1-x230.google.com with SMTP id v22so23384782oic.2 for ; Fri, 14 May 2021 05:14:44 -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=otm/PrI+MiTE4j38696D4wY8wq/7XarYa+F8PkJSIps=; b=TBHLVCGd3snNxmyxktfDaleFa6cU0aa3rd6he7VU2I4Nru8lriLEUEo8xgfWU1x8EZ iTzbZm0zHW+I3/Vj3LS55DACDoVAjRy8gIGFdcX82IYVeBHw5HSEBoqM1iBuTDG/TEQy 6/194/Vt20Y7gHOiiGVB+7Sjo+3ePWoynlVXZM9+rBeSwvaIWK8FaMZpCzlARvigTSbQ JXsdV6rolBR6IcaHENFGemh1VfwsXIyQB4wC6TzIcm2ZNcRlqGTpxY7t0wfEflO2/sgC z07tgsxpQnMvoKqm85eNm5aUPVQbEaePUbEgScfZpPb5raoTfjlGDaYhP//vSqdp7WRJ vclg== 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=otm/PrI+MiTE4j38696D4wY8wq/7XarYa+F8PkJSIps=; b=K1nbrJcS0Tg8QBzf7fjsouSouHJmJ9SPvtw48ckgKcRJYOPo/enwJ0YEvrm6cYfaFT g4j26TIDHfrwy+XuN3PKQp8JoFhJpBlTfGEmF5IJT0SMHvKjgRqtjixAPNQiSgsAjYPi H0rM9pGQ/CQn68owoT8fZRDBf7vZYI6fXJtdYqN8eta8oA6bhHOoEt6/ODBC6l5wF98N 9/D9+1i2uizumDLucMN8+QOXEHCMmI5/w9g9w7NUg0xTgpK0wlssqCZADWTw/Z4K1QdN ovpBucNTZjaoDo+62QrOU3h3qTmRSrZHOaI/vo3EwRciNAZMyagwFRgNZCb2B9gTrGEz h80A== X-Gm-Message-State: AOAM530+lzJzPBIJ87AYUzc2SGtEMuG/FcXgpvUDpaEaSsXnJVQvsgwA pvTA1IxAwH0ornlgiidT/8Ybm9EJKPM+aA== X-Google-Smtp-Source: ABdhPJxCvSfyBoPXiXIpE3Tj+Zdu7qeyNl3R8XRhOJFRGv0a2hS+2nlI0+o8FqVMg4YQ3USPcydadQ== X-Received: by 2002:aca:4ec4:: with SMTP id c187mr32495557oib.34.1620994483371; Fri, 14 May 2021 05:14:43 -0700 (PDT) Received: from localhost (fixed-187-190-78-172.totalplay.net. [187.190.78.172]) by smtp.gmail.com with ESMTPSA id h9sm1288489otn.56.2021.05.14.05.14.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 May 2021 05:14:43 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Felipe Contreras , Bagas Sanjaya Subject: [PATCH 04/11] doc: use asciidoctor to build man pages directly Date: Fri, 14 May 2021 07:14:28 -0500 Message-Id: <20210514121435.504423-5-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com> References: <20210514121435.504423-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 use xmlto to build the man pages when modern asciidoctor can do it by itself. This new mode will be active only when USE_ASCIIDOCTOR is set. Suggested-by: Bagas Sanjaya Signed-off-by: Felipe Contreras --- Documentation/Makefile | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/Makefile b/Documentation/Makefile index 981e322f18..ce9cea0817 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -198,6 +198,7 @@ ASCIIDOC_DEPS = asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS DBLATEX_COMMON = XMLTO_EXTRA += --skip-validation XMLTO_EXTRA += -x manpage.xsl +TXT_TO_MAN = $(ASCIIDOC_COMMON) -b manpage endif SHELL_PATH ?= $(SHELL) @@ -362,8 +363,13 @@ $(OBSOLETE_HTML): %.html : %.txto $(ASCIIDOC_DEPS) manpage-base-url.xsl: manpage-base-url.xsl.in $(QUIET_GEN)sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@ +ifdef TXT_TO_MAN +%.1 %.5 %.7 : %.txt $(ASCIIDOC_DEPS) + $(QUIET_ASCIIDOC)$(TXT_TO_MAN) -o $@ $< +else %.1 %.5 %.7 : %.xml manpage-base-url.xsl $(wildcard manpage*.xsl) $(QUIET_XMLTO)$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $< +endif %.xml : %.txt $(ASCIIDOC_DEPS) $(QUIET_ASCIIDOC)$(TXT_TO_XML) -d manpage -o $@ $< From patchwork Fri May 14 12:14:29 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12257633 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.8 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 6952CC43461 for ; Fri, 14 May 2021 12:15:02 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 497FE6145B for ; Fri, 14 May 2021 12:15:02 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233153AbhENMQL (ORCPT ); Fri, 14 May 2021 08:16:11 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50416 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232478AbhENMP6 (ORCPT ); Fri, 14 May 2021 08:15:58 -0400 Received: from mail-oi1-x22f.google.com (mail-oi1-x22f.google.com [IPv6:2607:f8b0:4864:20::22f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B6858C06174A for ; Fri, 14 May 2021 05:14:45 -0700 (PDT) Received: by mail-oi1-x22f.google.com with SMTP id j75so28218944oih.10 for ; Fri, 14 May 2021 05:14:45 -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=ztBaJ2CE2139tz9IYPibSrKG5Xg32re2wYcBYtNISgs=; b=lAYAwtoJOiQmk3SBJsQlo9z4ZhA0kcAhjNhrr6s1Uo2dhypFXisZL+joY/CayuC2hz 3B+Y55oCuawy3lrqeEOoSVASgnfQkCNqyWAwq/luRxAACy3g8jv3XR43iRKv+Zkqis6k FHTAWQ9qf2QqMnCt7n7YgUlYumkynzYuV09nvh9si2LSswcQqfBJvYQJPTBjdfGXjpni rNkHYVpk3YGehhwwwJmGOroaXZrscwQuDuZsvnKUWCHlU0R0pRQXCxk61LyA6dK39gYE Q7PpjH3jKcgqGhAj3Rd0j0UoUCnA81LAXELhbaVVcv8tc7AikWHxmok+D4zkE8LcU/Pc fs7A== 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=ztBaJ2CE2139tz9IYPibSrKG5Xg32re2wYcBYtNISgs=; b=sKhwD8x1b9wBJ3gTNwuipMPoKv3SvTEc9QMmN7OLMpViTs6cvb9pYhjS35GeMtwMeJ +qJqwtlUK29SPs8nKCT3IyYC+gS/n3fO+aHOGHL1DvGIrO5pix2yCbrJLpl0OJWhCga8 6eG3R9ptQqMiueHNeVECXDDX195yauD9y/NJ+EE1ARANKuufFi9TjFn25rLJnKtnkeLl 87l8A2KK55ny/NxWWGFLiobVRNbSRDh1Wv7Gzdy4mxITE1svtjkzktCrOyZL4Oa+g6SV haKlYA6M7X1QJ7ZcdcxV8c2/tKgY666ymOO3cSSSb+v5m5J8c2M1C2hDI47U2f15ZroY E68g== X-Gm-Message-State: AOAM530DT6JxdyFfk91TOsAyC6RzDoH1jgB3rl7CaoIcOiKVJs/ArKhN J/l4mvRkyBVUCSX8zXBDiO1aC7MNSNUP4g== X-Google-Smtp-Source: ABdhPJwC4wg7RZT2E30L2R03h9BHim+HVF5lofgAxxfE9ujNz60geis11tng2oI6B3z6P8woytI7zQ== X-Received: by 2002:aca:aa08:: with SMTP id t8mr6566118oie.66.1620994484953; Fri, 14 May 2021 05:14:44 -0700 (PDT) Received: from localhost (fixed-187-190-78-172.totalplay.net. [187.190.78.172]) by smtp.gmail.com with ESMTPSA id s24sm1255155ooh.28.2021.05.14.05.14.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 May 2021 05:14:44 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Felipe Contreras Subject: [PATCH 05/11] doc: asciidoctor: add linkgit macros in man pages Date: Fri, 14 May 2021 07:14:29 -0500 Message-Id: <20210514121435.504423-6-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com> References: <20210514121435.504423-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Fixes the doc-diff: - Please see git-commit(1) for alternative ways to add content to a - commit. + Please see for alternative ways to add content to a commit. Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index d906a00803..ad68f7b0bb 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -15,6 +15,8 @@ module Git "#{target}(#{attrs[1]})" elsif parent.document.basebackend? 'html' %(#{target}(#{attrs[1]})) + elsif parent.document.basebackend? 'manpage' + "\e\\fB%s\e\\fR(%s)" % [target, attrs[1]] elsif parent.document.basebackend? 'docbook' "\n" \ "#{target}" \ From patchwork Fri May 14 12:14:30 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12257635 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.8 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 18D96C433ED for ; Fri, 14 May 2021 12:15:05 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id E83386144C for ; Fri, 14 May 2021 12:15:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233195AbhENMQO (ORCPT ); Fri, 14 May 2021 08:16:14 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50426 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232847AbhENMP7 (ORCPT ); Fri, 14 May 2021 08:15:59 -0400 Received: from mail-oi1-x230.google.com (mail-oi1-x230.google.com [IPv6:2607:f8b0:4864:20::230]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 317B0C061574 for ; Fri, 14 May 2021 05:14:47 -0700 (PDT) Received: by mail-oi1-x230.google.com with SMTP id f184so8049066oig.3 for ; Fri, 14 May 2021 05:14:47 -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=UteF4PXNqM3a2sDG1d6xPdafs9y23MarhGlVM7jL2l4=; b=VyeD7AKu1/LYzSQ4op3nnJqyStH1KZDylH3F6sCFRpZr0QUOl7/kusYBJEeTpqBQIk /sMaAjLFjO1o4PvqCxhPPuYmj/iE9eJyQHE6KCxZTd5wYNlSC5+LXa9G+Z8hyt8oJ+V/ r3HUMSlibrtE4AVT9+Tmqryub3ae0pvFWo9KSs6hn8f4MVPQeieJoHpV47EXEHqrg5jU cnBbAYLZt3l3WXjN1Eku8lToRRCH84nrnakPN/8VQM2Esb3DVEVo4Kxkeo+UDE1RNBnl XrhMLi5S12i4xY1Z/Wjpie9jEswq96FwV+PpFaBfALpk5hT+bCv6qHYWGqCqJ5mPIuIA cI/g== 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=UteF4PXNqM3a2sDG1d6xPdafs9y23MarhGlVM7jL2l4=; b=II74hg3LpeiA2Tzp7sdBaQxznc2aZxaQW2eSr+w9JlnWNDQ6Z3LIr17GSYHAGzNizQ hB+SoEPpmQtawOXayLbfmndC46XPFU3xcomZOG6QolRH8kz/WPqFU9Da44C/VXwY7ZEC stSqrnr83yC/Afv92rJWC4iz8IaetMo1FXJEbvq6kz5XjJc6NiZEBzTrlprXN8EOF62g kGEiUYSi8IoE2eTaA1oAiAPkdwXbUfumN70GJaAT/F/FdmVbDjEBJ0eyTIr7tfWeIRUB LUghVJG781AWHs8K2Bn5/KQPv2cGy9sSvES+aB1fK/CFGU3g7NDXzqTjzU6SAjb3Zq2y Jj9A== X-Gm-Message-State: AOAM530FTBJEhKdlHosvVmsmUJs7Lqw9mBs+kTTISA2YnSoVRBaqAwfz 4bo7+eu1X9RhJUxqgXo1qipmk7k6BmIfhQ== X-Google-Smtp-Source: ABdhPJy7ZNgrBSAakQpa8UpogZqu5LJP4nVdFl1GddMcGpg1ykmmT1rL/tKP4Rhbk79GFeCS/gjg/A== X-Received: by 2002:a54:408c:: with SMTP id i12mr24053774oii.77.1620994486436; Fri, 14 May 2021 05:14:46 -0700 (PDT) Received: from localhost (fixed-187-190-78-172.totalplay.net. [187.190.78.172]) by smtp.gmail.com with ESMTPSA id p15sm1222996otl.23.2021.05.14.05.14.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 May 2021 05:14:46 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Felipe Contreras Subject: [PATCH 06/11] doc: join mansource and manversion Date: Fri, 14 May 2021 07:14:30 -0500 Message-Id: <20210514121435.504423-7-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com> References: <20210514121435.504423-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org There's no real value in having two fields when one does the trick. Also, this add the version for asciidoctor generated man pages. Fixes the doc-diff: -Git omitted 01/01/1970 GIT-ADD(1) +Git 01/01/1970 GIT-ADD(1) Signed-off-by: Felipe Contreras --- Documentation/Makefile | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Documentation/Makefile b/Documentation/Makefile index ce9cea0817..a514a4e72c 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) From patchwork Fri May 14 12:14:31 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12257637 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.8 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,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 2CDB2C433B4 for ; Fri, 14 May 2021 12:15:09 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id EF04D6144C for ; Fri, 14 May 2021 12:15:08 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232532AbhENMQS (ORCPT ); Fri, 14 May 2021 08:16:18 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50438 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232968AbhENMQB (ORCPT ); Fri, 14 May 2021 08:16:01 -0400 Received: from mail-ot1-x336.google.com (mail-ot1-x336.google.com [IPv6:2607:f8b0:4864:20::336]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 24AEBC06174A for ; Fri, 14 May 2021 05:14:49 -0700 (PDT) Received: by mail-ot1-x336.google.com with SMTP id n32-20020a9d1ea30000b02902a53d6ad4bdso26264519otn.3 for ; Fri, 14 May 2021 05:14:49 -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=mz1z7gqRyw2uDM7CnONNHPFangOX77UJaxmd1U+ADVc=; b=rV50yHqTa8+FUfL70DX62UvMkOvYbIFiv4h/Mo7ixM5BMXghIbAktCmIVA5+s4hmuQ iixLi73eXyV85NWL1FekX13aUz3tS6NAsnK/hGK3fc3cO5K2n1dk4aVhP8ZpqfiJ1VwB bdChuLe8pQ4kFzwDIwx+Xk2nyGWNAXAvhkjFhpQ47+HNR6Ppw4ixDNZ9EH+9ETAGC+95 NK/H4WyL2a+XOhZsoNHNVinrf3/RdrKhLM9rlibHN9pyzLCmaeB2Ya+O3ghPDiZl5JWO V/hMbmRvh17xqcGlbU+kK0sghmdBpPgjV3O9s5Pa9YerTRKIdmchBtDyL2BUP7OulE9U +yKQ== 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=mz1z7gqRyw2uDM7CnONNHPFangOX77UJaxmd1U+ADVc=; b=Y9KU2lF70OB26/sxOarU7MT5j8aAf0no6TElEL6P4THEIPjXAVBZak/mIq1jpmPq5s GpfyHN+dSW1Ad+CCacEIPNefG/OI5LQ3ps6g6aqnxRYCdZZPmkjevYtFIqtjiwo9n4Wm KuJVmZhHCHTaOVQSrxk0yPzaLgF14xw26MAPjZXm4sf22PhVquVBrfNEuoK/RLTKzu2x gmXie63BGbRrxPflYwL2xyx2IjEZDW2u75oZw9Euun3g8s/WvJXqtUiBdQ0pKCV2j+dO 4Jv9ooN5jqN15wsKs6UxSTZSpbGeFpAtM+4NukVZRMjkSXfUW+AHf6JECIBt0nRdYhL7 0NSw== X-Gm-Message-State: AOAM530vgUB69zhlq9OgChJ3w50A1uY4qNRCIR86XmjInteYgzuykBYh 58R6JCjKoOWYi9MJM/w+V88zzrFpZ/oLKw== X-Google-Smtp-Source: ABdhPJxqAV4fxP0cjUzuvNvLAMWGtwP5l9Ew7uzKNFpFF5qNcA1RkThc2ibysxiyz09NIb+tUxIupQ== X-Received: by 2002:a9d:30c3:: with SMTP id r3mr39392037otg.292.1620994488297; Fri, 14 May 2021 05:14:48 -0700 (PDT) Received: from localhost (fixed-187-190-78-172.totalplay.net. [187.190.78.172]) by smtp.gmail.com with ESMTPSA id x18sm1137418oix.28.2021.05.14.05.14.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 May 2021 05:14:47 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Felipe Contreras Subject: [PATCH 07/11] doc: add man pages workaround for asciidoctor Date: Fri, 14 May 2021 07:14:31 -0500 Message-Id: <20210514121435.504423-8-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com> References: <20210514121435.504423-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Currently asciidoctor doesn't convert number character references (&#xx;) correctly for man pages. This hack fixes the issue with minimum changes elsewhere so it's easy to remove when fixed. Fixes doc-diffs like: so line count cannot be shown) and there is no difference between indexed copy and the working tree version (if the working tree version were also different, binary would have been shown in place - of nothing). The other file, git-add--interactive.perl, has 403 - lines added and 35 lines deleted if you commit what is in the - index, but working tree file has further modifications (one + of nothing). The other file, git-add--interactive.perl, + has 403 lines added and 35 lines deleted if you commit what is in + the index, but working tree file has further modifications (one addition and one deletion). https://github.com/asciidoctor/asciidoctor/issues/4059 Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index ad68f7b0bb..11937c2c1d 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -45,6 +45,17 @@ module Git end Asciidoctor::Extensions.register do + # Override attributes for man pages. + # https://github.com/asciidoctor/asciidoctor/issues/4059 + tree_processor do + process do |document| + if document.backend == 'manpage' + document.attributes.merge!({ 'litdd' => '\--', 'plus' => '+' }) + end + document + end + end + inline_macro Git::Documentation::LinkGitProcessor, :linkgit postprocessor Git::Documentation::DocumentPostProcessor end From patchwork Fri May 14 12:14:32 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12257639 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.8 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 9E293C433B4 for ; Fri, 14 May 2021 12:15:16 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 78C896143D for ; Fri, 14 May 2021 12:15:16 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233226AbhENMQX (ORCPT ); Fri, 14 May 2021 08:16:23 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50430 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232671AbhENMQC (ORCPT ); Fri, 14 May 2021 08:16:02 -0400 Received: from mail-oo1-xc35.google.com (mail-oo1-xc35.google.com [IPv6:2607:f8b0:4864:20::c35]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B2CB6C061756 for ; Fri, 14 May 2021 05:14:50 -0700 (PDT) Received: by mail-oo1-xc35.google.com with SMTP id s1-20020a4ac1010000b02901cfd9170ce2so6290545oop.12 for ; Fri, 14 May 2021 05:14:50 -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=0ii0dTt7ug845laR78U44NZhJl16Ht0FJG8Qq8pxOKc=; b=XxTz1cUfprMbJiKg64Khy6TRZlE7LpWeKhg8PgtaIXNG4pV2PxuC4uM89poOKwabNx eQz4k7lJQyWgizjjJpgEomkBNKNcBHADTvQwXxI/JZRPXufGlsZCcexJqt2/Rgx365Ej FCKwZQp9S/EDfaJn3JqVu4KTpDjQ8a0XU6TeK3NqmG3VkBuwCPcwWBXJykpLDroBEV63 2g6YoRJu9np9aEZTsJcZwfmyalnZyxlcpVeipf+kXrJ9U3CAZ2D8+QuC7/bxMmCvqXgB cfrYfIurWus0AAm3TkKN3sIU8lzaAMdtmKELVz5eBnbm2MExbBpT4oIMEJdrzdoLOFLt InYA== 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=0ii0dTt7ug845laR78U44NZhJl16Ht0FJG8Qq8pxOKc=; b=IHJw9V3iuYLjcUXf6WJsrq3QwQYucnJaNpDQPGOES16XRt4wLn23Eqezi9sZMirXCm 2nD1CUyjask2tMGXvEkDldnrZ6WgokJ8xlTJ8H9pmpIUtQW5Sq+pgjkU+sVyZIV7d3W4 qY0kNDMRwAvaWA/UROT0Hxqp5yjiyOIwfFC5Cyb1sHfXLiYfB4QpZfWqmIQki1PIL2E6 as0plP313u7r7gBEkymc65gHG4qKeduflXSMvQ8AGJYxZRlPT0C4sF5QktFfdjGom+m3 tPJVVZodLKzIvdq/3yEuxE/SZr0s/vAogQll1KgWnHDZZuasgUFWYTupB5egSAVQLq6D l8/g== X-Gm-Message-State: AOAM531LYxYJqzoKWQgLs6V5jaH24u8VKTshPtYsib1aD5s1uh1Fpaqg RoMdhiVB71W2SOqCCPm9PzV6I6CeY/vOOQ== X-Google-Smtp-Source: ABdhPJx+A6TwhG0fih1/gLGk9qylXvJJQw3YUr8BQak/hsip2QsFNIMyP/zZfO+Gbg97lLHAYlCtHA== X-Received: by 2002:a4a:abc8:: with SMTP id o8mr36385666oon.77.1620994489925; Fri, 14 May 2021 05:14:49 -0700 (PDT) Received: from localhost (fixed-187-190-78-172.totalplay.net. [187.190.78.172]) by smtp.gmail.com with ESMTPSA id a14sm1249257otl.52.2021.05.14.05.14.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 May 2021 05:14:49 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Felipe Contreras Subject: [PATCH 08/11] doc: asciidoctor: add hack for xrefs Date: Fri, 14 May 2021 07:14:32 -0500 Message-Id: <20210514121435.504423-9-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com> References: <20210514121435.504423-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The docbook manpage stylesheets convert cross-references with format the 'section called “%t”'. I personally prefer the asciidoctor version, but for now add a hack to minimize the diff. Thanks to the extensibility of Ruby we can override corresponding method in the man page converter. This fixes doc-diffs like: --worktree-attributes Look for attributes in .gitattributes files in the working tree as - well (see the section called “ATTRIBUTES”). + well (see ATTRIBUTES). This can easily be removed later once we are confortable with the asciidoctor version. Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index 11937c2c1d..b2bbb318ad 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -1,5 +1,22 @@ require 'asciidoctor' require 'asciidoctor/extensions' +require 'asciidoctor/converter/manpage' + +module Asciidoctor + class Converter::ManPageConverter + alias orig_convert_inline_anchor convert_inline_anchor + def convert_inline_anchor(node) + case node.type + when :xref + return node.text if node.text + refid = node.attributes['refid'] + 'the section called “%s”' % refid.gsub('_', ' ') + else + orig_convert_inline_anchor(node) + end + end + end +end module Git module Documentation From patchwork Fri May 14 12:14:33 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12257641 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.8 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,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 72759C433B4 for ; Fri, 14 May 2021 12:15:37 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 54EC26145B for ; Fri, 14 May 2021 12:15:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233026AbhENMQo (ORCPT ); Fri, 14 May 2021 08:16:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50450 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233008AbhENMQD (ORCPT ); Fri, 14 May 2021 08:16:03 -0400 Received: from mail-ot1-x330.google.com (mail-ot1-x330.google.com [IPv6:2607:f8b0:4864:20::330]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4088DC061760 for ; Fri, 14 May 2021 05:14:52 -0700 (PDT) Received: by mail-ot1-x330.google.com with SMTP id t10-20020a05683022eab0290304ed8bc759so5133192otc.12 for ; Fri, 14 May 2021 05:14:52 -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=j6C5VscLKH4P3VgeSFZrzKB42+3X70UlrLtAL/AoQCM=; b=EeItupdapvZsOO9FJGBue1jLWXuPNLfJWcBrrNpw5CbjcIXh7OzLih/cRgoZtOnQJ2 Fn9qHKEfcd8MW07Nxf+Xg9kXJXNRDI8PmSA2+gA4WCShGG4UNSF3u80C5RkTNF+R2bcw MAAVxPp+KXHMrsFYUY2smgxH4Q/EVnJ2tq9yntFRyXhqBcqz1u5fO59vK8Ei6t2ojZPB RpvTNFkxcm3YiuUCR/MAmpDytBczwBk3ADH5O6BcPK+1Ggo2tC4P5jIcfGGM14RQaeUM EApnzmE5GnlPqakfbwrg4m7TMGxEt6b6Qcjfy0MJU8aQyDqTVg7w5Qa3vEY5499BSqE3 Y+RA== 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=j6C5VscLKH4P3VgeSFZrzKB42+3X70UlrLtAL/AoQCM=; b=C98wJ1gqkjTDYNeEYUQQ0xG+Fh0z3MkC5cy9yLuqRC+PLRAw2HRkjxcf32LGKiu6BK yBpf19Ve+EogoyewWdSUzw2IHuEX1SPGTgn0zWUkDydvRaCGz7q9vAyCbhLpf19c27D1 TM76dYiKV/iyCj5A54WFNiI8t6DDVPekNR+JYemP+vGUdRZDwn+6KI1o0IdFmTqhbYnw Z7Ugfv56peQanvL7PhDqZnlhd2eqS5fo27uuuBfe1zTy+BSTdq2gr+09TP6AbnGWS4id /cXuERmkr6/ATePkIQadxn8zLwEKOQvwwxswAD4LTh5U1OEm8YX/TPHY+c0Qg6oCv9qX JhXA== X-Gm-Message-State: AOAM533etm0DdQZaRdG9iae/Ls7NEKJ0TOu8kp6nQdhyUY0GAQCV1iOe mqdndtQ5G7sMreJML1rhLER+janoSt01fg== X-Google-Smtp-Source: ABdhPJzBfmwwCSW1vhEo15RAKkpiZEWfFayFONPSTp6vGoHOxc2MHwdchAezDQQLJ7pF55V0KEWRiA== X-Received: by 2002:a05:6830:15c9:: with SMTP id j9mr38633342otr.73.1620994491437; Fri, 14 May 2021 05:14:51 -0700 (PDT) Received: from localhost (fixed-187-190-78-172.totalplay.net. [187.190.78.172]) by smtp.gmail.com with ESMTPSA id q24sm1343487otg.81.2021.05.14.05.14.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 May 2021 05:14:51 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Felipe Contreras Subject: [PATCH 09/11] doc: asciidoctor: add hack to improve links Date: Fri, 14 May 2021 07:14:33 -0500 Message-Id: <20210514121435.504423-10-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com> References: <20210514121435.504423-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org The way asciidoctor handles links is very primitive compared to docbook. Links are simply presented in the format "#{text} <#{target}>", which may not be all that bad for the future, but pollutes the doc-diff. By adding another modification to convert_inline_anchor() we can present links in a form very similar to docbook, diminishing the doc-diff. This significantly reduces the doc-diff: From: abysmal performance). These safety and performance issues cannot be backward compatibly fixed and as such, its use is not recommended. Please use an alternative history filtering tool such as git - filter-repo[1]. If you still need to use git filter-branch, please - carefully read the section called “SAFETY” (and the section called - “PERFORMANCE”) to learn about the land mines of filter-branch, and then - vigilantly avoid as many of the hazards listed there as reasonably - possible. + filter-repo" . If you + still need to use git filter-branch, please carefully read the section + called “SAFETY” (and the section called “PERFORMANCE”) to learn about + the land mines of filter-branch, and then vigilantly avoid as many of + the hazards listed there as reasonably possible. -NOTES - 1. git filter-repo - https://github.com/newren/git-filter-repo/ - - 2. filter-lamely - https://github.com/newren/git-filter-repo/blob/master/contrib/filter-repo-demos/filter-lamely - To: NOTES - 1. git filter-repo + [1] git filter-repo https://github.com/newren/git-filter-repo/ Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index b2bbb318ad..42133ee6c3 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -11,6 +11,19 @@ module Asciidoctor return node.text if node.text refid = node.attributes['refid'] 'the section called “%s”' % refid.gsub('_', ' ') + when :link + return node.target if node.text == node.target + doc = node.document + + footnote = doc.footnotes.find { |e| e.id == node.target } + if !footnote + footnote_text = "%s\n\e.RS\n\e\\%%%s\n\e.RE" % [node.text, node.target] + index = doc.counter('footnote-number') + footnote = Document::Footnote.new(index, node.target, footnote_text) + doc.register(:footnotes, footnote) + end + + "\e\\fB%s\e\\fR[%d]" % [node.text, footnote.index] else orig_convert_inline_anchor(node) end From patchwork Fri May 14 12:14:34 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12257643 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.8 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 07978C433B4 for ; Fri, 14 May 2021 12:15:44 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id DE8A46145A for ; Fri, 14 May 2021 12:15:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233184AbhENMQt (ORCPT ); Fri, 14 May 2021 08:16:49 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50458 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232712AbhENMQF (ORCPT ); Fri, 14 May 2021 08:16:05 -0400 Received: from mail-ot1-x32e.google.com (mail-ot1-x32e.google.com [IPv6:2607:f8b0:4864:20::32e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B37C0C061761 for ; Fri, 14 May 2021 05:14:53 -0700 (PDT) Received: by mail-ot1-x32e.google.com with SMTP id 69-20020a9d0a4b0000b02902ed42f141e1so16077324otg.2 for ; Fri, 14 May 2021 05:14:53 -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=no6C6rlHoDZr+R43OkYQLtRQ20yjXEyATkgANNl/oss=; b=DdI+ERWXceqGOEukM2zxFo8ioNzUipGonWx93Dyx5w7kwxKs9oZFr2MSALv4VShaQY ilcNkLCYmLZMdJkQPLoui0OREJDm1fRW4tr/R2ge8Os2TUOHDuS3Wdkzhwu6VcKYZKKn feccSIhtwexhjqI78aDgC9CcNfAPogZH+o+JsBquySCWDHw22KkWd+Uq9uaR9r3rAOTi EFQSv3WYpxdVj2PmOD/ZwElIVXJ/8eZwi10s3B8BhqbmohCfjtv9KS/ueExU9fnrk2pk qLLErkR7TDIouVc8VZ0u502oAd5sF283Zw3ey0LPa+krw7sFypkdfVjeq/op4e8OQ1pY CWIQ== 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=no6C6rlHoDZr+R43OkYQLtRQ20yjXEyATkgANNl/oss=; b=Fr4RtKagX+SJCK4y+YfKuy3dlu4OqZl5lRws76wUkdMVmI3CrBLnyo6iVKb88Aja5j ypYGPGtlSxIuDr2xoZoZsW8dFo1uDrzQp0eG1C1hiqbd9Qn3fJOLK8s7SsPBCRtWJS13 YCNNNXEw0ZwX3nF5awFMuZfNEtZbQ2JNjNogvXklXnZfYOIrZTFuEjxEC/t7Nb5FoNZn bivrGCS1mnCns+mx6Ik3MDrBLRIP90s/IPNx9RoWYNpReeiKivj2ZnV4TQiKHPeaRxc6 +e9BQOcH9pkdfZCWeHGen9/ur2OEKmtYpzDg0fJcUp97ynClGD/0eBImLT5Lp93WqDfA BDCQ== X-Gm-Message-State: AOAM5307dDDLH4rZY5NuOU8MMgFGcAIq2HwC3CTShcFDc31N1QpSuqMl GwgYRqhAqUP7kWd1T0lPOQWECCN1c8YcEw== X-Google-Smtp-Source: ABdhPJxHiV6bR2dXwwMinOU2PT6njUOllyORcG7p3lwAH24Y2IBMN6eFywGMtt6/1uOTaIF5ZAS9rw== X-Received: by 2002:a05:6830:40a4:: with SMTP id x36mr36230780ott.342.1620994492907; Fri, 14 May 2021 05:14:52 -0700 (PDT) Received: from localhost (fixed-187-190-78-172.totalplay.net. [187.190.78.172]) by smtp.gmail.com with ESMTPSA id m189sm1128807oif.45.2021.05.14.05.14.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 May 2021 05:14:52 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Felipe Contreras Subject: [PATCH 10/11] doc: asciidoctor: add support for baseurl Date: Fri, 14 May 2021 07:14:34 -0500 Message-Id: <20210514121435.504423-11-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com> References: <20210514121435.504423-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org So that we can present relative links correctly. Reduces the doc-diff: NOTES - 1. “Understanding history: What is a branch?” - file:///$HOME/share/doc/git-doc/user-manual.html#what-is-a-branch + [1] “Understanding history: What is a branch?” + user-manual.html#what-is-a-branch NOTES - 1. “Understanding history: What is a branch?” + [1] “Understanding history: What is a branch?” file:///$HOME/share/doc/git-doc/user-manual.html#what-is-a-branch Signed-off-by: Felipe Contreras --- Documentation/Makefile | 1 + Documentation/asciidoctor-extensions.rb | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/Documentation/Makefile b/Documentation/Makefile index a514a4e72c..cc5ff54d92 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -193,6 +193,7 @@ ASCIIDOC_DOCBOOK = docbook5 override ASCIIDOC_EXTRA += -acompat-mode -atabsize=8 override ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions override ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;' +override ASCIIDOC_EXTRA += -abaseurl='$(MAN_BASE_URL)' ASCIIDOC_DEPS = asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS DBLATEX_COMMON = XMLTO_EXTRA += --skip-validation diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index 42133ee6c3..2ed92c3055 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -17,7 +17,9 @@ module Asciidoctor footnote = doc.footnotes.find { |e| e.id == node.target } if !footnote - footnote_text = "%s\n\e.RS\n\e\\%%%s\n\e.RE" % [node.text, node.target] + target = node.target + target = doc.attributes['baseurl'] + target unless target.include? ':' + footnote_text = "%s\n\e.RS\n\e\\%%%s\n\e.RE" % [node.text, target] index = doc.counter('footnote-number') footnote = Document::Footnote.new(index, node.target, footnote_text) doc.register(:footnotes, footnote) From patchwork Fri May 14 12:14:35 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felipe Contreras X-Patchwork-Id: 12257645 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.8 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 9D86AC433B4 for ; Fri, 14 May 2021 12:15:49 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 82F836143D for ; Fri, 14 May 2021 12:15:49 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233313AbhENMQ7 (ORCPT ); Fri, 14 May 2021 08:16:59 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50468 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233109AbhENMQJ (ORCPT ); Fri, 14 May 2021 08:16:09 -0400 Received: from mail-ot1-x335.google.com (mail-ot1-x335.google.com [IPv6:2607:f8b0:4864:20::335]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 460B2C061763 for ; Fri, 14 May 2021 05:14:55 -0700 (PDT) Received: by mail-ot1-x335.google.com with SMTP id d3-20020a9d29030000b029027e8019067fso26202286otb.13 for ; Fri, 14 May 2021 05:14:55 -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=bx6OfZhevHB5IntTsT1ruLiFaeaivhIOEP3a1TGRqgE=; b=lALa7VVX3KoiAjdKlpNY7dFGeVWZR5BSqiK096K5tJjX0rwNYI666wLFsZr3gX2x5y 1aur7a+PYXmMqM9FAtJKflejTLtZNZEo2QQ4sP55FdXNSJWTMEiS8OGrDIGYnsb0QC6t lUNH4BP84CLJYX3EtfIuvkeeblGv0mH0PqdX5o8D/Tmuivdm46TEtTfKM6wROJ8xS4PK XXlwLUHyySxCY2E7PhMMWbvZEXkP7uaRG/8g7mKRAu1wDnHEZF9sKpBsAPXAc7DYexON 5hh23bPD8Gm7NTk3fAltWvL7kSmtWqgVGpIpDCa2RDAr/y0Wejyi5mljtK0HpUr6wfnP +qdg== 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=bx6OfZhevHB5IntTsT1ruLiFaeaivhIOEP3a1TGRqgE=; b=kuFmIUUHkZ4t5Bh9Q6kcbKXEczr00R99DosNhUb12kk9fZ+vi90WbVVRKlYpHtHGsF +ZB+pJUNdoRLgUfjjreWOWNTDGVK1elTiFss0dgaPsLEUHWiXi/7ZNSzUKk/Hd8JEaGr EvS/s3bZRkN3zjz0ukU/Grsrp8BiML4IzmSZoWzYkxb5gNVdIcd+DArB2WdXT6o3yC2D VtFNanrBLSrOBwTGo9NYrF/hUyEr42q4CCWw5dpPQZOVp5Q//zrG/PArWF4+cch6BGad UDSK20d5mJXoCrYl4cJB3YEqJK1DMkXGGx7MwAld9nnLVGhOgLTErjkvi8GMjtZd0MxP 8h6w== X-Gm-Message-State: AOAM533+fAHf8HS6zwAukOrwX+qUp1XqewfSBYlXjsBM1/4ZLb5eUUCt 1WTT4idPaNmXsQ/JsBbeuLi3nh/9onT8NA== X-Google-Smtp-Source: ABdhPJzY9GFdcz1RxtmS0x3vgrQp4UXtLKE8BjhbcQBh3Fi9aXfoyGaQjMHJu7LhtkT4pyGNCj0Kcg== X-Received: by 2002:a9d:12a5:: with SMTP id g34mr6876072otg.204.1620994494469; Fri, 14 May 2021 05:14:54 -0700 (PDT) Received: from localhost (fixed-187-190-78-172.totalplay.net. [187.190.78.172]) by smtp.gmail.com with ESMTPSA id 19sm1143488oiy.11.2021.05.14.05.14.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 14 May 2021 05:14:54 -0700 (PDT) From: Felipe Contreras To: git@vger.kernel.org Cc: =?utf-8?q?Martin_=C3=85gren?= , "brian m . carlson" , Jeff King , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Felipe Contreras Subject: [PATCH 11/11] doc: asciidoctor: cleanup man page hack Date: Fri, 14 May 2021 07:14:35 -0500 Message-Id: <20210514121435.504423-12-felipe.contreras@gmail.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com> References: <20210514121435.504423-1-felipe.contreras@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org There's basically nothing we need from the original orig_convert_inline_anchor(), so let's remove calls to it. Signed-off-by: Felipe Contreras --- Documentation/asciidoctor-extensions.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb index 2ed92c3055..f23c5628a5 100644 --- a/Documentation/asciidoctor-extensions.rb +++ b/Documentation/asciidoctor-extensions.rb @@ -4,7 +4,6 @@ require 'asciidoctor/converter/manpage' module Asciidoctor class Converter::ManPageConverter - alias orig_convert_inline_anchor convert_inline_anchor def convert_inline_anchor(node) case node.type when :xref @@ -26,8 +25,10 @@ module Asciidoctor end "\e\\fB%s\e\\fR[%d]" % [node.text, footnote.index] + when :ref, :bibref + '' else - orig_convert_inline_anchor(node) + nil end end end