mirror of
https://github.com/xen-project/xen.git
synced 2026-10-28 02:01:24 +01:00
Andrew Cooper
8410fcb54a
The original intent of this patch was to rename xen-vbd-interface.markdown.7 to xen-vbd-interface.pandoc.7 to remove the final markdown file from the docs/ tree. The DOC_MANx lists are broken. They contain MANxSRC-y twice, the first half with a partial %.pod substituation, and the second half with a partial %.markdown substitution. This is also the root cause behind the filtering activity in the uninstall-man$(i)-pages rule. Furthermore, the logic for generating the manpage targets is unnecesserily repetative, owing to the layout of source files in the man/ directory. Therefore, tackle the problem by renaming all of our manpage source files from "$FORMAT.$SECTION" to "$SECTION.$FORMAT". For the two xl.cfg.5 and xl.1 which are preprocessed by autoconf to contain path information, this requires updating configure.ac and .gitignore. The markdown to pandoc conversion is performed as well, as it is also a straight rename. An ancillary benefit of this renaming is that text editors stand a chance of being able to work out the correct mode to use. As for the makefile: 1) Break the MAN_SECTIONS list out of the GENERATE_MANPAGE_RULES loop, as we are going to use it a second time. 2) Do away with the individaul MANxSRC-y variables. Use a single list, derived from all *.pod and *.pandoc files, with their format suffixes removed. 3) Use a $(foreach ...) to generate the DOC_MANx lists, filling them with the correct content. 4) The DOC_HTML and DOC_TXT can now include all manpages with a single substitution, as they don't need to separate the manpages by section-numbered-directory. 5) Fix up the filenames in the manpage metarule to match the renaming. No functional change. Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com> Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
47 lines
1.4 KiB
INI
47 lines
1.4 KiB
INI
=head1 NAME
|
|
|
|
xentrace_format - pretty-print Xen trace data
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<xentrace_format> [ I<DEFS-FILE> ]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
B<xentrace_format> parses trace data in B<xentrace> binary format from
|
|
standard input and reformats it according to the rules in a file of
|
|
definitions (I<DEFS-FILE>), printing to standard output.
|
|
|
|
The rules in I<DEFS-FILE> should have the format shown below:
|
|
|
|
I<event_id> I<whitespace> I<format>
|
|
|
|
Each rule should start on a new line.
|
|
|
|
The format string may include format specifiers, such as:
|
|
%(cpu)d, %(tsc)d, %(event)d, %(1)d, %(2)d, %(3)d, %(4)d, %(5)d
|
|
|
|
[ the `d' format specifier output in decimal, alternatively `x'
|
|
will output in hexadecimal and `o' will output in octal ]
|
|
|
|
These correspond to the CPU number, event ID, timestamp counter and
|
|
the 5 data fields from the trace record. There should be one such
|
|
rule for each type of event to be pretty-printed (events which do not
|
|
have formatting rules are ignored).
|
|
|
|
A sample format file for Xen's predefined trace events is available
|
|
in the file tools/xentrace/formats in the Xen source tree.
|
|
|
|
Depending on your system and the rate at which trace data is produced,
|
|
this script may not be able to keep up with the output of
|
|
B<xentrace> if it is piped directly. In these circumstances you
|
|
should have B<xentrace> output to a file for processing off-line.
|
|
|
|
=head1 AUTHOR
|
|
|
|
Mark A. Williamson <mark.a.williamson@intel.com>
|
|
|
|
=head1 SEE ALSO
|
|
|
|
xentrace(8)
|