From: Steven Rostedt <rostedt@goodmis.org>
To: "Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com>
Cc: linux-trace-devel@vger.kernel.org
Subject: Re: [PATCH 1/2] libtracefs: Unify man pages style
Date: Fri, 14 Jan 2022 15:36:04 -0500 [thread overview]
Message-ID: <20220114153604.3ee9a7df@gandalf.local.home> (raw)
In-Reply-To: <20220114095950.41334-2-tz.stoyanov@gmail.com>
On Fri, 14 Jan 2022 11:59:49 +0200
"Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com> wrote:
> Man pages of the library should have consistent view. There are some
> differences in functions and arguments visualisation across current man
> pages. Made the style of all pages consistent:
> - all function names in bold
> - all arguments are underlined.
> Fixed also a few spelling mistakes.
>
A patch about consistency should be consistent ;-)
> --- a/Documentation/libtracefs-hist.txt
> +++ b/Documentation/libtracefs-hist.txt
> @@ -4,7 +4,7 @@ libtracefs(3)
> NAME
> ----
> tracefs_hist_alloc, tracefs_hist_free, tracefs_hist_add_key, tracefs_hist_add_value, tracefs_hist_add_name, tracefs_hist_start,
> -tracefs_hist_destory, tracefs_hist_add_sort_key, tracefs_hist_set_sort_key, tracefs_hist_sort_key_direction
> +tracefs_hist_destroy, tracefs_hist_add_sort_key, tracefs_hist_set_sort_key, tracefs_hist_sort_key_direction
> tracefs_hist_echo_cmd, tracefs_hist_get_name, tracefs_hist_get_event, tracefs_hist_get_system - Create, update and describe event histograms
>
> SYNOPSIS
> @@ -13,68 +13,68 @@ SYNOPSIS
> --
> *#include <tracefs.h>*
>
> -enum tracefs_hist_key_type {
> - TRACEFS_HIST_KEY_NORMAL = 0,
> - TRACEFS_HIST_KEY_HEX,
> - TRACEFS_HIST_KEY_SYM,
> - TRACEFS_HIST_KEY_SYM_OFFSET,
> - TRACEFS_HIST_KEY_SYSCALL,
> - TRACEFS_HIST_KEY_EXECNAME,
> - TRACEFS_HIST_KEY_LOG,
> - TRACEFS_HIST_KEY_USECS,
> - TRACEFS_HIST_KEY_MAX
> +enum *tracefs_hist_key_type* {
> + _TRACEFS_HIST_KEY_NORMAL_ = 0,
> + _TRACEFS_HIST_KEY_HEX_,
> + _TRACEFS_HIST_KEY_SYM_,
> + _TRACEFS_HIST_KEY_SYM_OFFSET_,
> + _TRACEFS_HIST_KEY_SYSCALL_,
> + _TRACEFS_HIST_KEY_EXECNAME_,
> + _TRACEFS_HIST_KEY_LOG_,
> + _TRACEFS_HIST_KEY_USECS_,
> + _TRACEFS_HIST_KEY_MAX_
> };
>
The above you have enums be underlined.
> --- a/Documentation/libtracefs-synth2.txt
> +++ b/Documentation/libtracefs-synth2.txt
> @@ -14,24 +14,24 @@ SYNOPSIS
> --
>
> +[verse]
> +--
> enum tracefs_synth_handler {
> - TRACEFS_SYNTH_HANDLE_MATCH,
> - TRACEFS_SYNTH_HANDLE_MAX,
> - TRACEFS_SYNTH_HANDLE_CHANGE,
> + *TRACEFS_SYNTH_HANDLE_MATCH*,
> + *TRACEFS_SYNTH_HANDLE_MAX*,
> + *TRACEFS_SYNTH_HANDLE_CHANGE*,
> };
Here they are bold.
Actually, bold is correct.
-- Steve
next prev parent reply other threads:[~2022-01-14 20:36 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-14 9:59 [PATCH 0/2] Man pages updates and fixes Tzvetomir Stoyanov (VMware)
2022-01-14 9:59 ` [PATCH 1/2] libtracefs: Unify man pages style Tzvetomir Stoyanov (VMware)
2022-01-14 20:36 ` Steven Rostedt [this message]
2022-01-14 9:59 ` [PATCH 2/2] libtracefs: Update main man page Tzvetomir Stoyanov (VMware)
2022-01-14 21:06 ` Steven Rostedt
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=20220114153604.3ee9a7df@gandalf.local.home \
--to=rostedt@goodmis.org \
--cc=linux-trace-devel@vger.kernel.org \
--cc=tz.stoyanov@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.