Files
binutils-gdb/gprofng/doc/gp-macros.texi
Vladimir Mezentsev 7a515757db gprofng: Update documentation
This patch addresses bugzilla 29521:
Bug 29521 - [docs] man pages are not in the release tarball

The dependence on help2man to create the man pages has been eliminated.
All man pages are now written in Texinfo. Texi2pod and pod2man are used
to generate the man pages from the source.

The user guide has been significantly expanded. It also includes all
the man pages. These are formatted appropriately in the INFO, PDF, and
HTML formats.

The index in the user guide has been enhanced to include an overview
of all options and commands that have been documented so far.

The work on the documentation has not been completed, but this is
a significant step forward.

gprofng/ChangeLog
2023-04-15  Vladimir Mezentsev  <vladimir.mezentsev@oracle.com>

	PR gprofng/29521
	* doc/Makefile.am: Build documentation.
	* doc/gprofng.texi: Update documentation.
	* doc/version.texi: Likewise.
	* src/Makefile.am: Move the man pages generation to doc/Makefile.am.
	* gp-display-html/Makefile.am: Likewise.
	* doc/gp-archive.texi: New file.
	* doc/gp-collect-app.texi: New file.
	* doc/gp-display-html.texi: New file.
	* doc/gp-display-src.texi: New file.
	* doc/gp-display-text.texi: New file.
	* doc/gp-macros.texi: New file.
	* doc/gprofng_ug.texi: New file.
	* doc/Makefile.in: Rebuild.
	* gp-display-html/Makefile.in: Rebuild.
	* src/Makefile.in" Rebuild.
2023-04-17 13:00:03 -07:00

73 lines
1.3 KiB
Plaintext

@c -- Macro definitions -------------------------------------------------------
@c
@c Since only letters can be used, we use capitalization to distinguish
@c different words.
@c ----------------------------------------------------------------------------
@macro CollectApp{}
@command{gprofng collect app}
@end macro
@macro DisplayHTML{}
@command{gprofng display html}
@end macro
@macro DisplayText{}
@command{gprofng display text}
@end macro
@macro DisplaySRC{}
@command{gprofng display src}
@end macro
@macro Archive{}
@command{gprofng archive}
@end macro
@macro Driver{}
@command{gprofng}
@end macro
@macro ProductName{}
gprofng
@end macro
@macro ToolName{}
@command{gprofng}
@end macro
@macro IndexSubentry{label, string}
@c -- @cindex \label\ @subentry \string\
@cindex \label\, \string\
@end macro
@macro vspace {lines}
@sp \lines\
@end macro
@c -- For some reason ending this macro with @noindent does not work out well.
@macro OptionHeader {lines, option, description}
@sp \lines\
@noindent
@code{\option\} @ @emph{\description\}
@c -- @sp 1
@end macro
@macro gcctabopt{body}
@code{\body\}
@end macro
@macro ManPageStart{headername}
@ifclear man
@sp 1
@noindent @b{\headername\}
@indentedblock
@end ifclear
@end macro
@macro ManPageEnd{}
@ifclear man
@end indentedblock
@end ifclear
@end macro