aboutsummaryrefslogtreecommitdiff
path: root/gprofng/README
diff options
context:
space:
mode:
authorVladimir Mezentsev <vladimir.mezentsev@oracle.com>2022-06-14 14:02:19 -0700
committerVladimir Mezentsev <vladimir.mezentsev@oracle.com>2022-06-14 14:02:19 -0700
commit08328cfbafcebac5dac058e2d568d9b2fd3ee478 (patch)
treea17a176c52f381445dab1d8749a0abb4b9a97ab6 /gprofng/README
parent8e2de6c81a90e98ed95dfc0ffef1e3df9cfff6b7 (diff)
downloadbinutils-08328cfbafcebac5dac058e2d568d9b2fd3ee478.zip
binutils-08328cfbafcebac5dac058e2d568d9b2fd3ee478.tar.gz
binutils-08328cfbafcebac5dac058e2d568d9b2fd3ee478.tar.bz2
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.
Diffstat (limited to 'gprofng/README')
-rw-r--r--gprofng/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/gprofng/README b/gprofng/README
index 66d2e7c..fe6f33f 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.