From: Daniel Bristot de Oliveira <bristot@kernel.org>
To: Costa Shulyupin <costa.shul@redhat.com>,
Steven Rostedt <rostedt@goodmis.org>,
Jonathan Corbet <corbet@lwn.net>,
linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs: rtla: replace dashes with spaces in titles
Date: Wed, 2 Aug 2023 09:12:44 +0200 [thread overview]
Message-ID: <845391b2-12f6-86b6-9ce6-19e16edbfce1@kernel.org> (raw)
In-Reply-To: <20230802035037.404230-1-costa.shul@redhat.com>
On 8/2/23 05:50, Costa Shulyupin wrote:
> because
> - Titles containing spaces offer better readability compared
> to those with dashes
> - Commands and their described subcommands are separated by spaces
> - Ensure that the titles are identical to the commands with subcommands
I added the - because that is how we call the man-pages:
man rtla-osnoise-top
--------------- %< ----------------------
RTLA-OSNOISE-TOP(1) RTLA-OSNOISE-TOP(1)
NAME
rtla-osnoise-top - Display a summary of the operating system noise
SYNOPSIS
rtla osnoise top [OPTIONS]
--------------- %< ----------------------
and it is also inline with other kernel tools, like perf:
man perf-record
--------------- %< ----------------------
PERF-RECORD(1) perf Manual PERF-RECORD(1)
NAME
perf-record - Run a command and record its profile into perf.data
SYNOPSIS
perf record [-e <EVENT> | --event=EVENT] [-a] <command>
perf record [-e <EVENT> | --event=EVENT] [-a] -- <command> [<options>]
--------------- %< ----------------------
also...
[bristot@x1 rtla]$ make
rst2man --verbose rtla-hwnoise.rst > rtla-hwnoise.1
rst2man --verbose rtla-osnoise-hist.rst > rtla-osnoise-hist.1
rtla-osnoise-hist.rst:1: (ERROR/3) Invalid section title or transition marker.
===================
===================
rst2man --verbose rtla-osnoise.rst > rtla-osnoise.1
rtla-osnoise.rst:1: (ERROR/3) Invalid section title or transition marker.
===============
===============
rtla-osnoise.rst:3: (SEVERE/4) Missing matching underline for section title overline.
------------------------------------------------------------------
rtla osnoise
Measure the operating system noise
Exiting due to level-4 (SEVERE) system message.
make: *** [Makefile:36: rtla-osnoise.1] Error 1
[bristot@x1 rtla]$
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
prev parent reply other threads:[~2023-08-02 7:12 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-02 3:50 [PATCH] docs: rtla: replace dashes with spaces in titles Costa Shulyupin
2023-08-02 7:12 ` Daniel Bristot de Oliveira [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=845391b2-12f6-86b6-9ce6-19e16edbfce1@kernel.org \
--to=bristot@kernel.org \
--cc=corbet@lwn.net \
--cc=costa.shul@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=rostedt@goodmis.org \
/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;
as well as URLs for NNTP newsgroup(s).