public inbox for gdb-cvs@sourceware.org
help / color / mirror / Atom feed
From: Vladimir Mezentsev <vmezents@sourceware.org>
To: bfd-cvs@sourceware.org, gdb-cvs@sourceware.org
Subject: [binutils-gdb] gprofng docs: mention HTML / PDF in the gprofng README
Date: Tue, 14 Jun 2022 21:26:22 +0000 (GMT)	[thread overview]
Message-ID: <20220614212622.C15E43856DD4@sourceware.org> (raw)

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=08328cfbafcebac5dac058e2d568d9b2fd3ee478

commit 08328cfbafcebac5dac058e2d568d9b2fd3ee478
Author: Vladimir Mezentsev <vladimir.mezentsev@oracle.com>
Date:   Tue Jun 14 14:02:19 2022 -0700

    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:
---
 gprofng/README | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

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.


                 reply	other threads:[~2022-06-14 21:26 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220614212622.C15E43856DD4@sourceware.org \
    --to=vmezents@sourceware.org \
    --cc=bfd-cvs@sourceware.org \
    --cc=gdb-cvs@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).