On Fri, 14 Jan 2022 11:59:49 +0200
"Tzvetomir Stoyanov (VMware)" <tz.stoyanov@xxxxxxxxx> 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
|