From: Vladimir Mezentsev <vladimir.mezentsev@oracle.com>
Date: Tue, 14 Jun 2022 21:02:19 +0000 (-0700)
Subject: gprofng docs: mention HTML / PDF in the gprofng README
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=08328cfbafcebac5dac058e2d568d9b2fd3ee478;p=binutils-gdb.git

gprofng docs: mention HTML / PDF in the gprofng README

The HTML and PDF formats are described in the gprofng tutorial (info
topic "Other Document Formats"). In addition, describe them in the
README because: they are important; they are easily searchable; and the
README is primarily oriented to the person who is installing gprofng,
who may differ from the person who follows a user tutorial.
---

diff --git a/gprofng/README b/gprofng/README
index 66d2e7c86ac..fe6f33fed8d 100644
--- a/gprofng/README
+++ b/gprofng/README
@@ -72,6 +72,26 @@ Getting started
   To start using gprofng, see the tutorial available by saying:
       info gprofng
 
+HTML and PDF documentation
+
+   You may want to generate an HTML or PDF version of the manual in addition
+   to the above info pages.  These versions may be easier to read and easier
+   to search.  To generate HTML:
+
+      cd build        # the same build directory you created above
+      cd gprofng/doc
+      make html
+      sudo make install-html
+
+   If you would like PDF documentation, you will need the texi2dvi utility.
+   If it is not already included in the texinfo package mentioned above, try
+   installing package texinfo-tex.  To generate PDF:
+
+      cd build        # the same build directory you created above
+      cd gprofng/doc
+      make pdf
+      sudo make install-pdf
+
 Hints and tips for building binutils
 
   - Use the script(1) command to write a log of your build.