Skip to contentSkip to conversation

libtracefs/Documentation: Fix up man pages

PATCH New Steven Rostedt 1 participant 4 messages Jan 17, 2022 Documentation

lore
Share & tools
lore
#0 lore raw

cover libtracefs/Documentation: Fix up man pages

The libtracefs-hist.txt and libtracefs-synth2.txt had more than 9 functions defined in them. When that happens, the man page build process starts spitting out errors. Split out some of the functions into their own man pages to keep all man pages under the limit of 9.

Also, the SEE ALSO section underlined the commands when they should have been bold. Fix them and a couple of other command references.

Steven Rostedt (3):
libtracefs: Split up libtracefs-hist.txt man page
libtracefs: Split up libtracefs-synth2.txt man page libtracefs/Documentation: Referencing commands should be bold not
underlined

 Documentation/libtracefs-dynevents.txt        |   6 +-
 Documentation/libtracefs-eprobes.txt          |   6 +-
 Documentation/libtracefs-error.txt            |   6 +-
 Documentation/libtracefs-events-tep.txt       |   8 +-
 Documentation/libtracefs-events.txt           |   6 +-
 Documentation/libtracefs-files.txt            |   6 +-
 Documentation/libtracefs-filter.txt           |  28 +-
 Documentation/libtracefs-function-filter.txt  |   6 +-
 Documentation/libtracefs-hist-cont.txt        |  28 +-
 Documentation/libtracefs-hist-mod.txt         | 540 ++++++++++++++++++
 Documentation/libtracefs-hist.txt             | 142 +----
 .../libtracefs-instances-affinity.txt         |   8 +-
 .../libtracefs-instances-file-manip.txt       |   6 +-
 Documentation/libtracefs-instances-files.txt  |   6 +-
 Documentation/libtracefs-instances-manage.txt |   6 +-
 Documentation/libtracefs-instances-utils.txt  |   6 +-
 Documentation/libtracefs-kprobes.txt          |   6 +-
 Documentation/libtracefs-log.txt              |   6 +-
 Documentation/libtracefs-marker.txt           |   6 +-
 Documentation/libtracefs-marker_raw.txt       |   6 +-
 Documentation/libtracefs-option-get.txt       |   6 +-
 Documentation/libtracefs-option-misc.txt      |   6 +-
 Documentation/libtracefs-options.txt          |   6 +-
 Documentation/libtracefs-sql.txt              |  52 +-
 Documentation/libtracefs-stream.txt           |   6 +-
 Documentation/libtracefs-synth-info.txt       | 298 ++++++++++
 Documentation/libtracefs-synth.txt            |  48 +-
 Documentation/libtracefs-synth2.txt           | 110 ++--
 Documentation/libtracefs-traceon.txt          |   6 +-
 Documentation/libtracefs-tracer.txt           |   6 +-
 Documentation/libtracefs-utils.txt            |   6 +-
 Documentation/libtracefs.txt                  |   4 +-
 32 files changed, 1039 insertions(+), 353 deletions(-)
 create mode 100644 Documentation/libtracefs-hist-mod.txt
 create mode 100644 Documentation/libtracefs-synth-info.txt
Signature · 1 line
2.33.0
#1 lore raw

PATCH 1/3 libtracefs: Split up libtracefs-hist.txt man page

Man page generation appears to not allow more than 9 functions to be described before it starts spitting out errors. As libtracefs-hist.txt has 14 functions (and it did not even include tracefs_hist_append_filter() to make it 15), split out the functions:

tracefs_hist_add_sort_key()
tracefs_hist_set_sort_key()
tracefs_hist_sort_key_direction()
tracefs_hist_append_filter()
tracefs_hist_echo_cmd()
tracefs_hist_command()
tracefs_hist_get_name()
tracefs_hist_get_event()
tracefs_hist_get_system()

into their own man page: libtracefs-hist-mod.txt

and this removes the errors for libtracefs-hist.txt.

---
 Documentation/libtracefs-hist-mod.txt | 540 ++++++++++++++++++++++++++
 Documentation/libtracefs-hist.txt     | 130 +------
 2 files changed, 542 insertions(+), 128 deletions(-)
 create mode 100644 Documentation/libtracefs-hist-mod.txt
Documentation/libtracefs-hist-mod.txt new file +540 -0
new file mode 100644
index 000000000000..732ae2b62e88
@@ -0,0 +1,540 @@
+libtracefs(3)
+=============
+
+NAME
+----
+tracefs_hist_add_sort_key, tracefs_hist_set_sort_key, tracefs_hist_sort_key_direction,
+tracefs_hist_append_filter, tracefs_hist_echo_cmd, tracefs_hist_command,
+tracefs_hist_get_name, tracefs_hist_get_event, tracefs_hist_get_system - Update and describe an event histogram
+
+SYNOPSIS
+--------
+[verse]
+--
+*#include <tracefs.h>*
+
+int *tracefs_hist_add_sort_key*(struct tracefs_hist pass:[*]_hist_,
+			      const char pass:[*]_sort_key_);
+
+int *tracefs_hist_set_sort_key*(struct tracefs_hist pass:[*]_hist_,
+			      const char pass:[*]_sort_key_, _..._);
+int *tracefs_hist_sort_key_direction*(struct tracefs_hist pass:[*]_hist_,
+				    const char pass:[*]_sort_key_,
+				    enum tracefs_hist_sort_direction _dir_);
+
+int *tracefs_hist_add_name*(struct tracefs_hist pass:[*]_hist_, const char pass:[*]_name_);
+
+int *tracefs_hist_append_filter*(struct tracefs_hist pass:[*]_hist_,
+			       enum tracefs_filter _type_,
+			       const char pass:[*]_field_,
+			       enum tracefs_compare _compare_,
+			       const char pass:[*]_val_);
+
+int *tracefs_hist_echo_cmd*(struct trace_seq pass:[*]_s_, struct tracefs_instance pass:[*]_instance_,
+			  struct tracefs_hist pass:[*]_hist_,
+			  enum tracefs_hist_command _command_);
+
+int *tracefs_hist_command*(struct tracefs_instance pass:[*]_instance_,
+			 struct tracefs_hist pass:[*]_hist_,
+			 enum tracefs_hist_command _command_);
+
+const char pass:[*]*tracefs_hist_get_name*(struct tracefs_hist pass:[*]_hist_);
+
+const char pass:[*]*tracefs_hist_get_event*(struct tracefs_hist pass:[*]_hist_);
+
+const char pass:[*]*tracefs_hist_get_system*(struct tracefs_hist pass:[*]_hist_);
+
+--
+
+DESCRIPTION
+-----------
+Event histograms are created by the trigger file in the event directory.
+The syntax can be complex and difficult to get correct. This API handles the
+syntax, and facilitates the creation and interaction with the event histograms.
+See https://www.kernel.org/doc/html/latest/trace/histogram.html for more information.
+
+*tracefs_hist_add_sort_key*() will add a key to sort on. The _hist_ is the
+histogram descriptor to add the sort key to. The _sort_key_ is a string
+that must match either an already defined key of the histogram, or an already
+defined value. If _hist_  already has sorting keys (previously added) the new
+_sort_key_ will have lower priority(be secondary or so on) when sorting.
+
+*tracefs_hist_set_sort_key*() will reset the list of key to sort on. The _hist_ is
+the histogram descriptor to reset the sort key to. The _sort_key_ is a string
+that must match either an already defined key of the histogram, or an already
+defined value. Multiple sort keys may be added to denote a secondary, sort order
+and so on, but all sort keys must match an existing key or value, or be
+TRACEFS_HIST_HITCOUNT. The last parameter of *tracefs_hist_add_sort_key*() must
+be NULL.
+
+*tracefs_hist_sort_key_direction*() allows to change the direction of an
+existing sort key of _hist_. The _sort_key_ is the sort key to change, and
+_dir_ can be either TRACEFS_HIST_SORT_ASCENDING or TRACEFS_HIST_SORT_DESCENDING,
+to make the direction of the sort key either ascending or descending respectively.
+
+*tracefs_hist_add_name*() adds a name to a histogram. A histogram may be
+named and if the name matches between more than one event, and they have
+compatible keys, the multiple histograms with the same name will be merged
+into a single histogram (shown by either event's hist file). The _hist_
+is the histogram to name, and the _name_ is the name to give it.
+
+*tracefs_hist_append_filter*() creates a filter or appends to it for the
+histogram  event. Depending on _type_, it will build a string of tokens for
+parenthesis or logic statements, or it may add a comparison of _field_
+to _val_ based on _compare_.
+
+If _type_ is:
+*TRACEFS_FILTER_COMPARE*     -  See below
+*TRACEFS_FILTER_AND*         -  Append "&&" to the filter
+*TRACEFS_FILTER_OR*          -  Append "||" to the filter
+*TRACEFS_FILTER_NOT*         -  Append "!" to the filter
+*TRACEFS_FILTER_OPEN_PAREN*  -  Append "(" to the filter
+*TRACEFS_FILTER_CLOSE_PAREN* -  Append ")" to the filter
+
+_field_, _compare_, and _val_ are ignored unless _type_ is equal to
+*TRACEFS_FILTER_COMPARE*, then _compare_ will be used for the following:
+
+*TRACEFS_COMPARE_EQ* - _field_ == _val_
+
+*TRACEFS_COMPARE_NE* - _field_ != _val_
+
+*TRACEFS_COMPARE_GT* - _field_ > _val_
+
+*TRACEFS_COMPARE_GE* - _field_ >= _val_
+
+*TRACEFS_COMPARE_LT* - _field_ < _val_
+
+*TRACEFS_COMPARE_LE* - _field_ <pass:[=] _val_
+
+*TRACEFS_COMPARE_RE* - _field_ ~ "_val_" : where _field_ is a string.
+
+*TRACEFS_COMPARE_AND* - _field_ & _val_ : where _field_ is a flags field.
+
+*trace_hist_echo_cmd*() prints the commands needed to create the given histogram
+in the given _instance_, or NULL for the top level, into the _seq_.
+The command that is printed is described by _command_ and shows the functionality
+that would be done by *tracefs_hist_command*(3).
+
+*tracefs_hist_command*() is called to process a command on the histogram
+_hist_ for its event in the given _instance_, or NULL for the top level.
+The _cmd_ can be one of:
+
+*TRACEFS_HIST_CMD_START* or zero to start execution of the histogram.
+
+*TRACEFS_HIST_CMD_PAUSE* to pause the given histogram.
+
+*TRACEFS_HIST_CMD_CONT* to continue a paused histogram.
+
+*TRACEFS_HIST_CMD_CLEAR* to reset the values of a histogram.
+
+*TRACEFS_HIST_CMD_DESTROY* to destroy the histogram (undo a START).
+
+The below functions are wrappers to tracefs_hist_command() to make the
+calling conventions a bit easier to understand what is happening.
+
+KEY TYPES
+---------
+
+*tracefs_hist_alloc_nd*() and *tracefs_hist_add_key*() both add a key and requires
+that key to have a type. The types may be:
+
+*TRACEFS_HIST_KEY_NORMAL* or zero (0) which is to not modify the type.
+
+*TRACEFS_HIST_KEY_HEX* to display the key in hex.
+
+*TRACEFS_HIST_KEY_SYM* to display the key as a kernel symbol (if found). If
+the key is an address, this is useful as it will display the function names instead
+of just a number.
+
+*TRACEFS_HIST_KEY_SYM_OFFSET* similar to *TRACEFS_HIST_KEY_SYM* but will also include
+the offset of the function to match the exact address.
+
+*TRACEFS_HIST_KEY_SYSCALL* If the key is a system call "id" (the number passed from user
+space to the kernel to tell it what system call it is calling), then the name of
+the system call is displayed.
+
+*TRACEFS_HIST_KEY_EXECNAME* If "common_pid" is the key (the pid of the executing task),
+instead of showing the number, show the name of the running task.
+
+*TRACEFS_HIST_KEY_LOG* will display the key in a binary logarithmic scale.
+
+*TRACEFS_HIST_KEY_USECS* for use with "common_timestamp" or TRACEFS_HIST_TIMESTAMP,
+in which case it will show the timestamp in microseconds instead of nanoseconds.
+
+RETURN VALUE
+------------
+*tracefs_hist_get_name*() returns the name of the histogram or NULL on error.
+The returned string belongs to the histogram object and is freed with the histogram
+by *tracefs_hist_free*().
+
+*tracefs_hist_get_event*() returns the event name of the histogram or NULL on error.
+The returned string belongs to the histogram object and is freed with the histogram
+by *tracefs_hist_free*().
+
+*tracefs_hist_get_system*() returns the system name of the histogram or NULL on error.
+The returned string belongs to the histogram object and is freed with the histogram
+by *tracefs_hist_free*().
+
+*tracefs_hist_alloc_nd*() returns an allocated histogram descriptor which must
+be freed by *tracefs_hist_free*() or NULL on error.
+
+*tracefs_hist_get_name*(), *tracefs_hist_get_event*() and *tracefs_hist_get_system*()
+return strings owned by the histogram object.
+
+All the other functions return zero on success or -1 on error.
+
+EXAMPLE
+-------
+[source,c]
+--
+#include <stdlib.h>
+#include <unistd.h>
+#include <tracefs.h>
+
+enum commands {
+	START,
+	PAUSE,
+	CONT,
+	RESET,
+	DELETE,
+	SHOW,
+};
+
+static void parse_system_event(char *group, char **system, char **event)
+{
+	*system = strtok(group, "/");
+	*event = strtok(NULL, "/");
+	if (!*event) {
+		*event = *system;
+		*system = NULL;
+	}
+}
+
+static int parse_keys(char *keys, struct tracefs_hist_axis **axes)
+{
+	char *sav = NULL;
+	char *key;
+	int cnt = 0;
+
+	for (key = strtok_r(keys, ",", &sav); key; key = strtok_r(NULL, ",", &sav)) {
+		struct tracefs_hist_axis *ax;
+		char *att;
+
+		ax = realloc(*axes, sizeof(*ax) * (cnt + 2));
+		if (!ax) {
+			perror("Failed to allocate axes");
+			exit(-1);
+		}
+		ax[cnt].key = key;
+		ax[cnt].type = 0;
+		ax[cnt + 1].key = NULL;
+		ax[cnt + 1].type = 0;
+
+		*axes = ax;
+
+		att = strchr(key, '.');
+		if (att) {
+			*att++ = '\0';
+			if (strcmp(att, "hex") == 0)
+				ax[cnt].type = TRACEFS_HIST_KEY_HEX;
+			else if (strcmp(att, "sym") == 0)
+				ax[cnt].type = TRACEFS_HIST_KEY_SYM;
+			else if (strcmp(att, "sym_offset") == 0)
+				ax[cnt].type = TRACEFS_HIST_KEY_SYM_OFFSET;
+			else if (strcmp(att, "syscall") == 0)
+				ax[cnt].type = TRACEFS_HIST_KEY_SYSCALL;
+			else if (strcmp(att, "exec") == 0)
+				ax[cnt].type = TRACEFS_HIST_KEY_EXECNAME;
+			else if (strcmp(att, "log") == 0)
+				ax[cnt].type = TRACEFS_HIST_KEY_LOG;
+			else if (strcmp(att, "usecs") == 0)
+				ax[cnt].type = TRACEFS_HIST_KEY_USECS;
+			else {
+				fprintf(stderr, "Undefined attribute '%s'\n", att);
+				fprintf(stderr,"  Acceptable attributes:\n");
+				fprintf(stderr,"    hex, sym, sym_offset, syscall, exe, log, usecs\n");
+				exit(-1);
+			}
+		}
+		cnt++;
+	}
+	return cnt;
+}
+
+static void process_hist(enum commands cmd, const char *instance_name,
+			 char *group, char *keys, char *vals, char *sort,
+			 char *ascend, char *desc)
+{
+	struct tracefs_instance *instance = NULL;
+	struct tracefs_hist *hist;
+	struct tep_handle *tep;
+	struct tracefs_hist_axis *axes = NULL;
+	char *system;
+	char *event;
+	char *sav;
+	char *val;
+	int ret;
+	int cnt;
+
+	if (instance_name) {
+		instance = tracefs_instance_create(instance_name);
+		if (!instance) {
+			fprintf(stderr, "Failed instance create\n");
+			exit(-1);
+		}
+	}
+
+	tep = tracefs_local_events(NULL);
+	if (!tep) {
+		perror("Could not read events");
+		exit(-1);
+	}
+
+	parse_system_event(group, &system, &event);
+
+	if (cmd == SHOW) {
+		char *content;
+		content = tracefs_event_file_read(instance, system, event,
+						  "hist", NULL);
+		if (!content) {
+			perror("Reading hist file");
+			exit(-1);
+		}
+		printf("%s\n", content);
+		free(content);
+		return;
+	}
+
+	if (!keys) {
+		fprintf(stderr, "Command needs -k option\n");
+		exit(-1);
+	}
+
+	cnt = parse_keys(keys, &axes);
+	if (!cnt) {
+		fprintf(stderr, "No keys??\n");
+		exit(-1);
+	}
+
+	/* Show examples of hist1d and hist2d */
+	switch (cnt) {
+	case 1:
+		hist = tracefs_hist_alloc(tep, system, event,
+					  axes[0].key, axes[0].type);
+		break;
+	case 2:
+		hist = tracefs_hist_alloc_2d(tep, system, event,
+					     axes[0].key, axes[0].type,
+					     axes[1].key, axes[1].type);
+		break;
+	default:
+		/* Really, 1 and 2 could use this too */
+		hist = tracefs_hist_alloc_nd(tep, system, event, axes);
+	}
+	if (!hist) {
+		fprintf(stderr, "Failed hist create\n");
+		exit(-1);
+	}
+
+	if (vals) {
+		sav = NULL;
+		for (val = strtok_r(vals, ",", &sav); val; val = strtok_r(NULL, ",", &sav)) {
+			ret = tracefs_hist_add_value(hist, val);
+			if (ret) {
+				fprintf(stderr, "Failed to add value %s\n", val);
+				exit(-1);
+			}
+		}
+	}
+
+	if (sort) {
+		sav = NULL;
+		for (val = strtok_r(sort, ",", &sav); val; val = strtok_r(NULL, ",", &sav)) {
+			ret = tracefs_hist_add_sort_key(hist, val);
+			if (ret) {
+				fprintf(stderr, "Failed to add sort key/val %s\n", val);
+				exit(-1);
+			}
+		}
+	}
+
+	if (ascend) {
+		sav = NULL;
+		for (val = strtok_r(ascend, ",", &sav); val; val = strtok_r(NULL, ",", &sav)) {
+			ret = tracefs_hist_sort_key_direction(hist, val, TRACEFS_HIST_SORT_ASCENDING);
+			if (ret) {
+				fprintf(stderr, "Failed to add ascending key/val %s\n", val);
+				exit(-1);
+			}
+		}
+	}
+
+	if (desc) {
+		sav = NULL;
+		for (val = strtok_r(desc, ",", &sav); val; val = strtok_r(NULL, ",", &sav)) {
+			ret = tracefs_hist_sort_key_direction(hist, val, TRACEFS_HIST_SORT_DESCENDING);
+			if (ret) {
+				fprintf(stderr, "Failed to add descending key/val %s\n", val);
+				exit(-1);
+			}
+		}
+	}
+
+	tracefs_error_clear(instance);
+
+	switch (cmd) {
+	case START:
+		ret = tracefs_hist_start(instance, hist);
+		if (ret) {
+			char *err = tracefs_error_last(instance);
+			if (err)
+				fprintf(stderr, "\n%s\n", err);
+		}
+		break;
+	case PAUSE:
+		ret = tracefs_hist_pause(instance, hist);
+		break;
+	case CONT:
+		ret = tracefs_hist_continue(instance, hist);
+		break;
+	case RESET:
+		ret = tracefs_hist_reset(instance, hist);
+		break;
+	case DELETE:
+		ret = tracefs_hist_destroy(instance, hist);
+		break;
+	case SHOW:
+		/* Show was already done */
+		break;
+	}
+	if (ret)
+		fprintf(stderr, "Failed: command\n");
+	exit(ret);
+}
+
+int main (int argc, char **argv, char **env)
+{
+	enum commands cmd;
+	char *instance = NULL;
+	char *cmd_str;
+	char *event = NULL;
+	char *keys = NULL;
+	char *vals = NULL;
+	char *sort = NULL;
+	char *desc = NULL;
+	char *ascend = NULL;
+
+	if (argc < 2) {
+		fprintf(stderr, "usage: %s command [-B instance][-e [system/]event][-k keys][-v vals][-s sort]\n", argv[0]);
+		fprintf(stderr, "      [-a ascending][-d descending]\n");
+		exit(-1);
+	}
+
+	cmd_str = argv[1];
+
+	if (!strcmp(cmd_str, "start"))
+		cmd = START;
+	else if (!strcmp(cmd_str, "pause"))
+		cmd = PAUSE;
+	else if (!strcmp(cmd_str, "cont"))
+		cmd = CONT;
+	else if (!strcmp(cmd_str, "reset"))
+		cmd = RESET;
+	else if (!strcmp(cmd_str, "delete"))
+		cmd = DELETE;
+	else if (!strcmp(cmd_str, "show"))
+		cmd = SHOW;
+	else {
+		fprintf(stderr, "Unknown command %s\n", cmd_str);
+		exit(-1);
+	}
+
+	for (;;) {
+		int c;
+
+		c = getopt(argc - 1, argv + 1, "e:k:v:B:s:d:a:");
+		if (c == -1)
+			break;
+
+		switch (c) {
+		case 'e':
+			event = optarg;
+			break;
+		case 'k':
+			keys = optarg;
+			break;
+		case 'v':
+			vals = optarg;
+			break;
+		case 'B':
+			instance = optarg;
+			break;
+		case 's':
+			sort = optarg;
+			break;
+		case 'd':
+			desc = optarg;
+			break;
+		case 'a':
+			ascend = optarg;
+			break;
+		}
+	}
+	if (!event) {
+		event = "kmem/kmalloc";
+		if (!keys)
+			keys = "call_site.sym,bytes_req";
+		if (!vals)
+			vals = "bytes_alloc";
+		if (!sort)
+			sort = "bytes_req,bytes_alloc";
+		if (!desc)
+			desc = "bytes_alloc";
+	}
+	process_hist(cmd, instance, event, keys, vals, sort, ascend, desc);
+}
+--
+
+FILES
+-----
+[verse]
+--
+*tracefs.h*
+	Header file to include in order to have access to the library APIs.
+*-ltracefs*
+	Linker switch to add when building a program that uses the library.
+--
+
+SEE ALSO
+--------
+_libtracefs(3)_,
+_libtraceevent(3)_,
+_trace-cmd(1)_,
+_tracefs_hist_pause(3)_,
+_tracefs_hist_continue(3)_,
+_tracefs_hist_reset(3)_
+
+AUTHOR
+------
+[verse]
+--
+*Steven Rostedt* <[email protected]>
+*Tzvetomir Stoyanov* <[email protected]>
+*sameeruddin shaik* <[email protected]>
+--
+REPORTING BUGS
+--------------
+Report bugs to  <[email protected]>
+
+LICENSE
+-------
+libtracefs is Free Software licensed under the GNU LGPL 2.1
+
+RESOURCES
+---------
+https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
+
+COPYING
+-------
+Copyright \(C) 2020 VMware, Inc. Free use of this software is granted under
+the terms of the GNU Public License (GPL).
Documentation/libtracefs-hist.txt +2 -128

157 lines not on this page · raw message

Signature · 1 line
2.33.0
#2 lore raw

PATCH 2/3 libtracefs: Split up libtracefs-synth2.txt man page

In reply to Steven Rostedt

Man page generation appears to not allow more than 9 functions to be described before it starts spitting out errors. As libtracefs-synth2.txt has 14 functions (and it did not even include tracefs_synth_save() to make it 15), split out the functions:

tracefs_synth_echo_cmd()
tracefs_synth_get_start_hist()
tracefs_synth_get_name()
tracefs_synth_raw_fmt()
tracefs_synth_show_event()
tracefs_synth_show_start_hist()
tracefs_synth_show_end_hist()
tracefs_synth_get_event()

into their own man page: libtracefs-synth-info.txt

And this makes the errors for libtracefs-synth2.txt go away.

Also add some documentation about how tracefs_synth_create() needs tracefs_synth_alloc() to create the synthetic event first.

---
 Documentation/libtracefs-synth-info.txt | 298 ++++++++++++++++++++++++
 Documentation/libtracefs-synth.txt      |  14 ++
 Documentation/libtracefs-synth2.txt     |  82 ++-----
 3 files changed, 333 insertions(+), 61 deletions(-)
 create mode 100644 Documentation/libtracefs-synth-info.txt
Documentation/libtracefs-synth-info.txt new file +298 -0
new file mode 100644
index 000000000000..1bfee20608d3
@@ -0,0 +1,298 @@
+libtracefs(3)
+=============
+
+NAME
+----
+tracefs_synth_echo_cmd, tracefs_synth_get_start_hist, tracefs_synth_get_name,
+tracefs_synth_raw_fmt, tracefs_synth_show_event, tracefs_synth_show_start_hist, tracefs_synth_show_end_hist,
+tracefs_synth_get_event - Retrieve data of synthetic events.
+
+SYNOPSIS
+--------
+[verse]
+--
+*#include <tracefs.h>*
+
+int *tracefs_synth_echo_cmd*(struct trace_seq pass:[*]_seq_, struct tracefs_synth pass:[*]_synth_);
+struct tracefs_hist pass:[*]*tracefs_synth_get_start_hist*(struct tracefs_synth pass:[*]_synth_);
+
+const char pass:[*]*tracefs_synth_get_name*(struct tracefs_synth pass:[*]_synth_);
+int *tracefs_synth_raw_fmt*(struct trace_seq pass:[*]_seq_, struct tracefs_synth pass:[*]_synth_);
+const char pass:[*]*tracefs_synth_show_event*(struct tracefs_synth pass:[*]_synth_);
+const char pass:[*]*tracefs_synth_show_start_hist*(struct tracefs_synth pass:[*]_synth_);
+const char pass:[*]*tracefs_synth_show_end_hist*(struct tracefs_synth pass:[*]_synth_);
+struct tep_event pass:[*]*tracefs_synth_get_event*(struct tep_handle pass:[*]_tep_, struct tracefs_synth pass:[*]_synth_);
+
+--
+
+DESCRIPTION
+-----------
+Synthetic events are dynamic events that are created by matching
+two other events which triggers a synthetic event. One event is the starting
+event which some field is recorded, and when the second event is executed,
+if it has a field (or fields) that matches the starting event's field (or fields)
+then it will trigger the synthetic event. The field values other than the matching
+fields may be passed from the starting event to the end event to perform calculations
+on, or to simply pass as a parameter to the synthetic event.
+
+One common use case is to set "sched_waking" as the starting event. This event is
+triggered when a process is awoken. Then set "sched_switch" as the ending event.
+This event is triggered when a new task is scheduled on the CPU. By setting
+the "common_pid" of both events as the matching fields, the time between the
+two events is considered the wake up latency of that process. Use *TRACEFS_TIMESTAMP*
+as a field for both events to calculate the delta in nanoseconds, or use
+*TRACEFS_TIMESTAMP_USECS* as the compare fields for both events to calculate the
+delta in microseconds. This is used as the example below.
+
+See *tracefs_synth_alloc*(3) for allocation of synthetic events, and
+*tracefs_synth_create*() for creating the synthetic event on the system.
+
+*tracefs_synth_echo_cmd*() acts like *tracefs_synth_create*(), but instead of creating
+the synthetic event in the system, it will write the echo commands to manually create
+it in the _seq_ given.
+
+*tracefs_synth_get_start_hist*() returns a struct tracefs_hist descriptor describing
+the histogram used to create the synthetic event.
+
+[verse]
+--
+enum tracefs_synth_handler {
+	*TRACEFS_SYNTH_HANDLE_MATCH*,
+	*TRACEFS_SYNTH_HANDLE_MAX*,
+	*TRACEFS_SYNTH_HANDLE_CHANGE*,
+};
+--
+
+*tracefs_synth_get_name*() returns the name of the synthetic event or NULL on error.
+The returned string belongs to the synth event object and is freed with the event
+by *tracefs_synth_free*().
+
+*tracefs_synth_raw_fmt*() writes the raw format strings (dynamic event and histograms) of
+the synthetic event in the _seq_ given.
+
+*tracefs_synth_show_event*() returns the format of the dynamic event used by the synthetic
+event or NULL on error. The returned string belongs to the synth event object and is freed
+with the event by *tracefs_synth_free*().
+
+*tracefs_synth_show_start_hist*() returns the format of the start histogram used by the
+synthetic event or NULL on error. The returned string belongs to the synth event object
+and is freed with the event by *tracefs_synth_free*().
+
+*tracefs_synth_show_end_hist*() returns the format of the end histogram used by the
+synthetic event or NULL on error. The returned string belongs to the synth event object
+and is freed with the event by *tracefs_synth_free*().
+
+The *tracefs_synth_get_event*() function returns a tep event, describing the given synthetic
+event. The API detects any newly created or removed dynamic events. The returned pointer to
+tep event is controlled by @tep and must not be freed.
+
+RETURN VALUE
+------------
+*tracefs_synth_get_name*(), *tracefs_synth_show_event*(), *tracefs_synth_show_start_hist*()
+and *tracefs_synth_show_end_hist*()  return a string owned by the synth event object.
+
+The *tracefs_synth_get_event*() function returns a pointer to a tep event or NULL in case of an
+error or if the requested synthetic event is missing. The returned pointer to tep event is
+controlled by @tep and must not be freed.
+
+All other functions return zero on success or -1 on error.
+
+ERRORS
+------
+The following errors are for all the above calls:
+
+*EPERM* Not run as root user when required.
+
+*EINVAL* Either a parameter is not valid (NULL when it should not be)
+  or a field that is not compatible for calculations.
+
+*ENODEV* An event or one of its fields is not found.
+
+*EBADE* The fields of the start and end events are not compatible for
+  either matching or comparing.
+
+*ENOMEM* not enough memory is available.
+
+And more errors may have happened from the system calls to the system.
+
+EXAMPLE
+-------
+See *tracefs_sql*(3) for a more indepth use of some of this code.
+
+[source,c]
+--
+#include <stdlib.h>
+#include <tracefs.h>
+
+#define start_event "sched_waking"
+#define start_field "pid"
+
+#define end_event "sched_switch"
+#define end_field "next_pid"
+
+#define match_name "pid"
+
+static struct tracefs_synth *synth;
+
+static void make_event(void)
+{
+	struct tep_handle *tep;
+
+	/* Load all events from the system */
+	tep = tracefs_local_events(NULL);
+
+	/* Initialize the synthetic event */
+	synth = tracefs_synth_alloc(tep, "wakeup_lat",
+				    NULL, start_event,
+				    NULL, end_event,
+				    start_field, end_field,
+				    match_name);
+
+	/* The tep is no longer needed */
+	tep_free(tep);
+
+
+	/* Save the "prio" field as "prio" from the start event */
+	tracefs_synth_add_start_field(synth, "prio", NULL);
+
+	/* Save the "next_comm" as "comm" from the end event */
+	tracefs_synth_add_end_field(synth, "next_comm", "comm");
+
+	/* Save the "prev_prio" as "prev_prio" from the end event */
+	tracefs_synth_add_end_field(synth, "prev_prio", NULL);
+
+	/*
+	 * Take a microsecond time difference between end and start
+	 * and record as "delta"
+	 */
+	tracefs_synth_add_compare_field(synth, TRACEFS_TIMESTAMP_USECS,
+					TRACEFS_TIMESTAMP_USECS,
+					TRACEFS_SYNTH_DELTA_END, "delta");
+
+	/* Only record if start event "prio" is less than 100 */
+	tracefs_synth_append_start_filter(synth, TRACEFS_FILTER_COMPARE,
+					  "prio", TRACEFS_COMPARE_LT, "100");
+
+	/*
+	 * Only record if end event "next_prio" is less than 50
+	 * or the previous task's prio was not greater than or equal to 100.
+	 *   next_prio < 50 || !(prev_prio >= 100)
+	 */
+	tracefs_synth_append_end_filter(synth, TRACEFS_FILTER_COMPARE,
+					"next_prio", TRACEFS_COMPARE_LT, "50");
+	tracefs_synth_append_end_filter(synth, TRACEFS_FILTER_OR, NULL, 0, NULL);
+	tracefs_synth_append_end_filter(synth, TRACEFS_FILTER_NOT, NULL, 0, NULL);
+	tracefs_synth_append_end_filter(synth, TRACEFS_FILTER_OPEN_PAREN, NULL, 0, NULL);
+	tracefs_synth_append_end_filter(synth, TRACEFS_FILTER_COMPARE,
+					"prev_prio", TRACEFS_COMPARE_GE, "100");
+	/*
+	 * Note, the above only added: "next_prio < 50 || !(prev_prio >= 100"
+	 * That's because, when the synth is executed, the remaining close parenthesis
+	 * will be added. That is, the string will end up being:
+	 * "next_prio < 50 || !(prev_prio >= 100)" when one of tracefs_sync_create()
+	 * or tracefs_sync_echo_cmd() is run.
+	 */
+}
+
+/* Display how to create the synthetic event */
+static void show_event(void)
+{
+	struct trace_seq s;
+
+	trace_seq_init(&s);
+
+	tracefs_synth_echo_cmd(&s, synth);
+	trace_seq_terminate(&s);
+	trace_seq_do_printf(&s);
+	trace_seq_destroy(&s);
+}
+
+int main (int argc, char **argv)
+{
+	make_event();
+
+	if (argc > 1) {
+		if (!strcmp(argv[1], "create")) {
+			/* Create the synthetic event */
+			tracefs_synth_create(synth);
+		} else if (!strcmp(argv[1], "delete")) {
+			/* Delete the synthetic event */
+			tracefs_synth_destroy(synth);
+		} else {
+			printf("usage: %s [create|delete]\n", argv[0]);
+			exit(-1);
+		}
+	} else
+		show_event();
+
+	tracefs_synth_free(synth);
+
+	return 0;
+}
+--
+
+FILES
+-----
+[verse]
+--
+*tracefs.h*
+	Header file to include in order to have access to the library APIs.
+*-ltracefs*
+	Linker switch to add when building a program that uses the library.
+--
+
+SEE ALSO
+--------
+_libtracefs(3)_,
+_libtraceevent(3)_,
+_trace-cmd(1)_,
+_tracefs_hist_alloc(3)_,
+_tracefs_hist_alloc_2d(3)_,
+_tracefs_hist_alloc_nd(3)_,
+_tracefs_hist_free(3)_,
+_tracefs_hist_add_key(3)_,
+_tracefs_hist_add_value(3)_,
+_tracefs_hist_add_name(3)_,
+_tracefs_hist_start(3)_,
+_tracefs_hist_destory(3)_,
+_tracefs_hist_add_sort_key(3)_,
+_tracefs_hist_sort_key_direction(3)_
+_tracefs_synth_alloc(3)_
+_tracefs_synth_add_match_field(3)_
+_tracefs_synth_add_compare_field(3)_
+_tracefs_synth_add_start_field(3)_
+_tracefs_synth_add_end_field(3)_
+_tracefs_synth_append_start_filter(3)_
+_tracefs_synth_append_end_filter(3)_
+_tracefs_synth_free(3)_
+_tracefs_synth_create(3)_
+_tracefs_synth_destroy(3)_
+_tracefs_synth_complete(3)_
+_tracefs_synth_trace(3)_
+_tracefs_synth_snapshot(3)_
+_tracefs_synth_save(3)_
+
+AUTHOR
+------
+[verse]
+--
+*Steven Rostedt* <[email protected]>
+*Tzvetomir Stoyanov* <[email protected]>
+*sameeruddin shaik* <[email protected]>
+--
+REPORTING BUGS
+--------------
+Report bugs to  <[email protected]>
+
+LICENSE
+-------
+libtracefs is Free Software licensed under the GNU LGPL 2.1
+
+RESOURCES
+---------
+https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
+
+COPYING
+-------
+Copyright \(C) 2020 VMware, Inc. Free use of this software is granted under
+the terms of the GNU Public License (GPL).
Documentation/libtracefs-synth.txt +14 -0
index fe28060a2fe5..e847d6d3e9d7 100644
@@ -327,6 +327,20 @@ _tracefs_hist_start(3)_,
 _tracefs_hist_destory(3)_,
 _tracefs_hist_add_sort_key(3)_,
 _tracefs_hist_sort_key_direction(3)_
+_tracefs_synth_create(3)_
+_tracefs_synth_destroy(3)_
+_tracefs_synth_complete(3)_
+_tracefs_synth_trace(3)_
+_tracefs_synth_snapshot(3)_
+_tracefs_synth_save(3)_
+_tracefs_synth_echo_cmd(3)_
+_tracefs_synth_get_start_hist(3)_
+_tracefs_synth_get_name(3)_
+_tracefs_synth_raw_fmt(3)_
+_tracefs_synth_show_event(3)_
+_tracefs_synth_show_start_hist(3)_
+_tracefs_synth_show_end_hist(3)_
+_tracefs_synth_get_event(3)_
 
 AUTHOR
 ------
Documentation/libtracefs-synth2.txt +21 -61

128 lines not on this page · raw message

Signature · 1 line
2.33.0
#3 lore raw

PATCH 3/3 libtracefs/Documentation: Referencing commands should be bold not underlined

In reply to Steven Rostedt

When referencing other commands "trace-cmd(3)", the command name should be bold and not underlined, and the "(3)" should be normal text.

Update all the man pages to use this format. This mostly affects the "SEE ALSO" section.

---
 Documentation/libtracefs-dynevents.txt        |  6 +-
 Documentation/libtracefs-eprobes.txt          |  6 +-
 Documentation/libtracefs-error.txt            |  6 +-
 Documentation/libtracefs-events-tep.txt       |  8 +--
 Documentation/libtracefs-events.txt           |  6 +-
 Documentation/libtracefs-files.txt            |  6 +-
 Documentation/libtracefs-filter.txt           | 28 ++++-----
 Documentation/libtracefs-function-filter.txt  |  6 +-
 Documentation/libtracefs-hist-cont.txt        | 28 ++++-----
 Documentation/libtracefs-hist-mod.txt         | 12 ++--
 Documentation/libtracefs-hist.txt             | 12 ++--
 .../libtracefs-instances-affinity.txt         |  8 +--
 .../libtracefs-instances-file-manip.txt       |  6 +-
 Documentation/libtracefs-instances-files.txt  |  6 +-
 Documentation/libtracefs-instances-manage.txt |  6 +-
 Documentation/libtracefs-instances-utils.txt  |  6 +-
 Documentation/libtracefs-kprobes.txt          |  6 +-
 Documentation/libtracefs-log.txt              |  6 +-
 Documentation/libtracefs-marker.txt           |  6 +-
 Documentation/libtracefs-marker_raw.txt       |  6 +-
 Documentation/libtracefs-option-get.txt       |  6 +-
 Documentation/libtracefs-option-misc.txt      |  6 +-
 Documentation/libtracefs-options.txt          |  6 +-
 Documentation/libtracefs-sql.txt              | 52 ++++++++--------
 Documentation/libtracefs-stream.txt           |  6 +-
 Documentation/libtracefs-synth-info.txt       | 56 ++++++++---------
 Documentation/libtracefs-synth.txt            | 62 +++++++++----------
 Documentation/libtracefs-synth2.txt           | 60 +++++++++---------
 Documentation/libtracefs-traceon.txt          |  6 +-
 Documentation/libtracefs-tracer.txt           |  6 +-
 Documentation/libtracefs-utils.txt            |  6 +-
 Documentation/libtracefs.txt                  |  4 +-
 32 files changed, 228 insertions(+), 228 deletions(-)
Documentation/libtracefs-dynevents.txt +3 -3
index bec31f10c904..b8cb8d40bf7a 100644
@@ -253,9 +253,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-eprobes.txt +3 -3
index 4155544c174a..a96ad1b81783 100644
@@ -157,9 +157,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-error.txt +3 -3
index 60e755421eaa..a45332dc742e 100644
@@ -108,9 +108,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-events-tep.txt +4 -4
index af5f1d63db6f..22d3dd5fdfd0 100644
@@ -59,7 +59,7 @@ RETURN VALUE
 ------------
 The *tracefs_local_events()* and *tracefs_local_events_system()* functions
 return pointer to allocated and initialized _tep_ handler, or NULL in
-case of an error. The returned _tep_ handler must be freed with *tep_free(3)*.
+case of an error. The returned _tep_ handler must be freed with *tep_free*(3).
 
 The *tracefs_fill_local_events()* function returns -1 in case of an error or
 0 otherwise.
@@ -119,9 +119,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-events.txt +3 -3
index eabce96404d3..a3d7a11acf4b 100644
@@ -160,9 +160,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-files.txt +3 -3
index 00f12c37611e..13e251ddd465 100644
@@ -73,9 +73,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-filter.txt +14 -14
index 0bb88e2a6df4..501f093134df 100644
@@ -304,20 +304,20 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_,
-_tracefs_hist_alloc(3)_,
-_tracefs_hist_alloc_2d(3)_,
-_tracefs_hist_alloc_nd(3)_,
-_tracefs_hist_free(3)_,
-_tracefs_hist_add_key(3)_,
-_tracefs_hist_add_value(3)_,
-_tracefs_hist_add_name(3)_,
-_tracefs_hist_start(3)_,
-_tracefs_hist_destory(3)_,
-_tracefs_hist_add_sort_key(3)_,
-_tracefs_hist_sort_key_direction(3)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1),
+*tracefs_hist_alloc*(3),
+*tracefs_hist_alloc_2d*(3),
+*tracefs_hist_alloc_nd*(3),
+*tracefs_hist_free*(3),
+*tracefs_hist_add_key*(3),
+*tracefs_hist_add_value*(3),
+*tracefs_hist_add_name*(3),
+*tracefs_hist_start*(3),
+*tracefs_hist_destory*(3),
+*tracefs_hist_add_sort_key*(3),
+*tracefs_hist_sort_key_direction*(3)
 
 AUTHOR
 ------
Documentation/libtracefs-function-filter.txt +3 -3
index 1a77d778bfab..d12f61406448 100644
@@ -208,9 +208,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-hist-cont.txt +14 -14
index b32a2cc9165e..651aa0efe1f7 100644
@@ -180,20 +180,20 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_,
-_tracefs_hist_alloc(3)_,
-_tracefs_hist_alloc_2d(3)_,
-_tracefs_hist_alloc_nd(3)_,
-_tracefs_hist_free(3)_,
-_tracefs_hist_add_key(3)_,
-_tracefs_hist_add_value(3)_,
-_tracefs_hist_add_name(3)_,
-_tracefs_hist_start(3)_,
-_tracefs_hist_destory(3)_,
-_tracefs_hist_add_sort_key(3)_,
-_tracefs_hist_sort_key_direction(3)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1),
+*tracefs_hist_alloc*(3),
+*tracefs_hist_alloc_2d*(3),
+*tracefs_hist_alloc_nd*(3),
+*tracefs_hist_free*(3),
+*tracefs_hist_add_key*(3),
+*tracefs_hist_add_value*(3),
+*tracefs_hist_add_name*(3),
+*tracefs_hist_start*(3),
+*tracefs_hist_destory*(3),
+*tracefs_hist_add_sort_key*(3),
+*tracefs_hist_sort_key_direction*(3)
 
 AUTHOR
 ------
Documentation/libtracefs-hist-mod.txt +6 -6
index 732ae2b62e88..1f4587b50903 100644
@@ -507,12 +507,12 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_,
-_tracefs_hist_pause(3)_,
-_tracefs_hist_continue(3)_,
-_tracefs_hist_reset(3)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1),
+*tracefs_hist_pause*(3),
+*tracefs_hist_continue*(3),
+*tracefs_hist_reset*(3)
 
 AUTHOR
 ------
Documentation/libtracefs-hist.txt +6 -6
index 9a86df52923a..858782b70dc2 100644
@@ -459,12 +459,12 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_,
-_tracefs_hist_pause(3)_,
-_tracefs_hist_continue(3)_,
-_tracefs_hist_reset(3)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1),
+*tracefs_hist_pause*(3),
+*tracefs_hist_continue*(3),
+*tracefs_hist_reset*(3)
 
 AUTHOR
 ------
Documentation/libtracefs-instances-affinity.txt +4 -4
index f3e16d972812..c5fa2d8b820c 100644
@@ -35,7 +35,7 @@ The numbers do not need to be in order except for ranges, where the second numbe
 must be equal to or greater than the first.
 
 The *tracefs_instance_set_affinity_set()* function takes a CPU set defined by
-*CPU_SET(3)*. The size of the set defined by _set_size_ is the size in bytes of
+*CPU_SET*(3). The size of the set defined by _set_size_ is the size in bytes of
 _set_. If _set_ is NULL then all the CPUs on the system will be set, and _set_size_
 is ignored.
 
@@ -140,9 +140,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-instances-file-manip.txt +3 -3
index 369059482a56..8c04240523d3 100644
@@ -170,9 +170,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-instances-files.txt +3 -3
index c289c82bc4e8..e2985578a5a5 100644
@@ -144,9 +144,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-instances-manage.txt +3 -3
index 2b0b662f7730..31e77a39c594 100644
@@ -109,9 +109,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-instances-utils.txt +3 -3
index 8a2b6149073f..a79cc3447d80 100644
@@ -98,9 +98,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-kprobes.txt +3 -3
index e488f9a151b8..593ef9ee11fb 100644
@@ -243,9 +243,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-log.txt +3 -3
index 7b562c77d11d..4b72df115e50 100644
@@ -47,9 +47,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-marker.txt +3 -3
index fdab4a46030f..adc5419c44dc 100644
@@ -86,9 +86,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_,
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1),
 Documentation/trace/ftrace.rst from the Linux kernel tree
 
 AUTHOR
Documentation/libtracefs-marker_raw.txt +3 -3
index e4ebadc2b655..9682f2088592 100644
@@ -72,9 +72,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_,
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1),
 Documentation/trace/ftrace.rst from the Linux kernel tree
 
 AUTHOR
Documentation/libtracefs-option-get.txt +3 -3
index 815e77f84505..dce5afab4894 100644
@@ -105,9 +105,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-option-misc.txt +3 -3
index 552aaed56ce3..c690bfdf503b 100644
@@ -71,9 +71,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-options.txt +3 -3
index b8f0edff52b4..2c720f2fc220 100644
@@ -129,9 +129,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_,
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1),
 _Documentation/trace/ftrace.rst_ from the Linux kernel tree.
 
 AUTHOR
Documentation/libtracefs-sql.txt +26 -26

58 lines not on this page · raw message

Documentation/libtracefs-stream.txt +3 -3
index d8c61c6b2993..8008be810a33 100644
@@ -96,9 +96,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_,
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1),
 Documentation/trace/ftrace.rst from the Linux kernel tree
 
 AUTHOR
Documentation/libtracefs-synth-info.txt +28 -28

62 lines not on this page · raw message

Documentation/libtracefs-synth.txt +31 -31

68 lines not on this page · raw message

Documentation/libtracefs-synth2.txt +30 -30

66 lines not on this page · raw message

Documentation/libtracefs-traceon.txt +3 -3
index 2b720c2ce368..8f64928e3b60 100644
@@ -122,9 +122,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-tracer.txt +3 -3
index cca0e33af6ca..ea57962d9163 100644
@@ -191,9 +191,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs-utils.txt +3 -3
index aa8284a1ab1e..9478911afbae 100644
@@ -79,9 +79,9 @@ FILES
 
 SEE ALSO
 --------
-_libtracefs(3)_,
-_libtraceevent(3)_,
-_trace-cmd(1)_
+*libtracefs*(3),
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Documentation/libtracefs.txt +2 -2
index 0123c0bbf47f..e7eb090b8268 100644
@@ -237,8 +237,8 @@ FILES
 
 SEE ALSO
 --------
-_libtraceevent(3)_
-_trace-cmd(1)_
+*libtraceevent*(3),
+*trace-cmd*(1)
 
 AUTHOR
 ------
Signature · 1 line
2.33.0