Linux Perf Users
 help / color / mirror / Atom feed
From: Namhyung Kim <namhyung@kernel.org>
To: "ORTOLA Raphaël" <raphael.ortola@gmail.com>
Cc: linux-perf-users@vger.kernel.org
Subject: Re: [PATCH RFC] perf docs: build only the declared manual section
Date: Thu, 19 Nov 2026 00:18:55 -0800	[thread overview]
Message-ID: <av6w7-WZbFp444bR@google.com> (raw)
In-Reply-To: <CACzNvX6qkkd-QgJzcQquHS6XiKacMqb85JeLC8LmfLTeWqu4EQ@mail.gmail.com>

Hello,

On Thu, Nov 12, 2026 at 02:24:29PM -0600, ORTOLA Raphaël wrote:
> Hello,
> 
> While building Ubuntu linux 7.3.0-9.9, GNU make 4.4.1 reports that the
> perf manual rules do not update their .5 and .7 peer targets. The
> implicit multi-target rules promise all three sections for each input,
> whereas XMLto and Asciidoctor emit the section declared by that input.
> 
> The proposed change uses the existing DOC_MAN1/DOC_MAN5/DOC_MAN7 lists
> with static pattern prerequisites and one recipe per backend. The
> shared asciidoc.conf prerequisite is moved after those rules so that
> $< remains the manual input rather than the configuration file.
> USE_ASCIIDOCTOR selects the two alternative backends.
> 
> Checks on this downstream source:
> - Before: the native XMLto build reports missing .5/.7 peer targets.
> - After: all 41 native XMLto manuals build without warnings.
> - Additional section 5 and 7 fixture manuals build with XMLto.
> - Asciidoctor 2.0.26 with Ruby 3.3.8 generates section 1, 5 and 7
> fixture manuals without warnings, using explicit ASCIIDOC_EXTRA
> backend flags.
> 
> This is an RFC for the documentation rules; it is not a claim of a
> completed kernel build or testing on current upstream master. Please
> review the proposed fix below.

Thanks for the patch.  I'm not familiar with this area but I guess it
removes some unnecessary steps during the manual build?  Should be ok
unless it changes any outputs.

Can you please send a formal patch with your Sign off?

Thanks,
Namhyung


> 
> --- a/tools/perf/Documentation/Makefile
> +++ b/tools/perf/Documentation/Makefile
> @@ -174,7 +174,6 @@
> 
>  html: $(DOC_HTML)
> 
> -$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
> 
>  man: man1 man5 man7
>  man1: $(DOC_MAN1)
> @@ -259,17 +258,26 @@
>                      --date=short --no-show-signature $<)))
> 
>  ifdef USE_ASCIIDOCTOR
> -$(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : %.txt
> +$(DOC_MAN1): $(OUTPUT)%.1: %.txt
> +$(DOC_MAN5): $(OUTPUT)%.5: %.txt
> +$(DOC_MAN7): $(OUTPUT)%.7: %.txt
> +$(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7):
>  	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
>  	$(ASCIIDOC) -b manpage -d manpage \
>  		$(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) \
>  		-adocdate=$(PERF_DATE) -o $@+ $< && \
>  	mv $@+ $@
> -endif
> -
> -$(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : $(OUTPUT)%.xml
> +else
> +
> +$(DOC_MAN1): $(OUTPUT)%.1: $(OUTPUT)%.xml
> +$(DOC_MAN5): $(OUTPUT)%.5: $(OUTPUT)%.xml
> +$(DOC_MAN7): $(OUTPUT)%.7: $(OUTPUT)%.xml
> +$(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7):
>  	$(QUIET_XMLTO)$(RM) $@ && \
>  	$(XMLTO) -o $(OUTPUT). -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
> +endif
> +
> +$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
> 
>  $(OUTPUT)%.xml : %.txt
>  	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \

      parent reply	other threads:[~2026-11-19  8:18 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-12 20:24 [PATCH RFC] perf docs: build only the declared manual section ORTOLA Raphaël
2026-11-12 20:34 ` sashiko-bot
2026-11-19  8:18 ` Namhyung Kim [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=av6w7-WZbFp444bR@google.com \
    --to=namhyung@kernel.org \
    --cc=linux-perf-users@vger.kernel.org \
    --cc=raphael.ortola@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox