Linux Perf Users
 help / color / mirror / Atom feed
From: sashiko-bot@kernel.org
To: "ORTOLA Raphaël" <raphael.ortola@gmail.com>,
	linux-perf-users@vger.kernel.org
Subject: Re: [PATCH RFC] perf docs: build only the declared manual section
Date: Thu, 12 Nov 2026 20:34:07 +0000	[thread overview]
Message-ID: <sashiko-outbox-211795@kernel.org> (raw)
In-Reply-To: <CACzNvX6qkkd-QgJzcQquHS6XiKacMqb85JeLC8LmfLTeWqu4EQ@mail.gmail.com>

Thank you for your contribution! Sashiko AI review found 2 potential
issues to consider:
- [High] perf docs: missing Signed-off-by trailer in commit message
- [Low] perf docs: missing Fixes trailers for multi-target manpage build
  rules
--

commit bfd2c7c72bce033b21098d6070bc47bebfe6a33c
Author: ORTOLA Raphaël <raphael.ortola@gmail.com>

> perf docs: build only the declared manual section
>
> 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.

[Severity: High]
The commit message is missing a Signed-off-by: trailer, which is required
under Documentation/process/submitting-patches.rst before a patch can be
applied.  Also, the greeting and RFC note should go below the ---
separator so they do not end up in the permanent git changelog.

[Severity: Low]
Since this fixes the multi-target implicit rules for XMLto and
Asciidoctor, should it include Fixes: trailers for the commits that
introduced them?

  Fixes: c1c2365acf8c ("perf_counter tools: Generate per command manpages (and pdf/html, etc.)")
  Fixes: ffef80ecf89f ("perf Documentation: Support for asciidoctor")

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/CACzNvX6qkkd-QgJzcQquHS6XiKacMqb85JeLC8LmfLTeWqu4EQ@mail.gmail.com?part=1

      reply	other threads:[~2026-11-12 20:34 UTC|newest]

Thread overview: 2+ 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 [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=sashiko-outbox-211795@kernel.org \
    --to=sashiko-bot@kernel.org \
    --cc=linux-perf-users@vger.kernel.org \
    --cc=raphael.ortola@gmail.com \
    --cc=sashiko-reviews@lists.linux.dev \
    /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