gprofng: Update documentation
authorVladimir Mezentsev <vladimir.mezentsev@oracle.com>
Sun, 16 Apr 2023 00:54:15 +0000 (17:54 -0700)
committerVladimir Mezentsev <vladimir.mezentsev@oracle.com>
Mon, 17 Apr 2023 20:00:03 +0000 (13:00 -0700)
commit7a515757db9681e86926b7068b3a4a6a2df70299
tree8a5bb26811ee6277e7eaa100b7f54ad8678f7477
parent66cf935043fba24919043a62b430da9c51609133
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.
15 files changed:
gprofng/doc/Makefile.am
gprofng/doc/Makefile.in
gprofng/doc/gp-archive.texi [new file with mode: 0644]
gprofng/doc/gp-collect-app.texi [new file with mode: 0644]
gprofng/doc/gp-display-html.texi [new file with mode: 0644]
gprofng/doc/gp-display-src.texi [new file with mode: 0644]
gprofng/doc/gp-display-text.texi [new file with mode: 0644]
gprofng/doc/gp-macros.texi [new file with mode: 0644]
gprofng/doc/gprofng.texi
gprofng/doc/gprofng_ug.texi [new file with mode: 0644]
gprofng/doc/version.texi
gprofng/gp-display-html/Makefile.am
gprofng/gp-display-html/Makefile.in
gprofng/src/Makefile.am
gprofng/src/Makefile.in