Mirror of the gdb mailing list
 help / color / mirror / Atom feed
* Thoughts on the GDB "documentation" web page
@ 2009-11-09 18:48 Joel Brobecker
  2009-11-09 19:39 ` Eli Zaretskii
  2009-11-09 20:09 ` Pedro Alves
  0 siblings, 2 replies; 6+ messages in thread
From: Joel Brobecker @ 2009-11-09 18:48 UTC (permalink / raw)
  To: gdb

This is regarding: http://www.sourceware.org/gdb/documentation/

I find the "documentations page" not as straightforward as I'd like it
to be.  In particular, the "Online GDB Manuals" sections, which looks
like this:

     |  Online GDB manuals
     |  Documentation generated from the <URL: current_cvs>current</URL> 
     |  sources are available online:
     |
     |  <URL: GDB TOC>GDB User Manual<URL> (<URL: PDF>gziped</URL> PDF)
     |      Describes how to use GDB.
     |      Translations are also available:
     |        * Japanese, by Kazuhisa Ichikawa as part of KI's
     |          Unofficial GNU Manual Translation Project.
     |        * Russian, by Dmitry Sivachenko.
     |
     |  <URL: GDB Internals TOC>GDB Internals Manual</URL> (gziped PDF)
     |      Technical details of the internals of GDB.
     |
     |  The documentation is also available for <URL: head-onlinedocs>
     |  download</URL> in a number of different formats including (HTML,
     |  DVI, PS and PDF).
     |
     |  Versions of the documentation generated from the last 
     |  <URL:release-onlinedocs>release</URL> and most recent 
     |  <URL:branch-onlinedocs>branch</URL> are also available.

    What I find confusing is how to get to the "onlinedocs" page
    for the HEAD.  It takes careful reading every single time I go
    to that page to find the link (clicking on "download").  Similarly,
    it takes careful reading to find where the release and branch
    documentation is located.  It would be nice to make everything 
    a little more structured.

I would like to reorganize this a little.  Here is what the entire
page looks like, right now:

    |           GDB Documentation
    |
    |   Printed Manuals
    |   <one-line explaining how to get printed manuals from the GNU Press>
    |
    |   Online GDB Manuals
    |   <see above>
    |
    |   Reference Materials
    |   Additional documentation includes:
    |   [...]
    |
    |   GDB interfaces and standards
    |   [...]

I am not sure I have been able to come up with anything better, so
suggestions always welcome.  Here is what I propose. Revamp the page
as follow:

    |                  GDB Documentation
    |
    |    <URL>GDB User Manual</URL>    <URL>GDB Internals Manual</URL>
    |    (gzipped <URL>PDF</URL>)      (gzipped <URL>PDF</URL>)
    |    Describes how to use GDB.     Technical details of the internals
    |                                  of GDB.
    |
    |    Online GDB Documentation
    |    GDB provides a set of documents (including manuals) that are
    |    available from the links below:
    |      * For the <URL>last release</URL>
    |      * For the <URL>head branch</URL>
    |      * For the currently active <URL>branch</URL>
    |
    |    Printed Manuals
    |    <contents unchanged>
    |
    |    Translated manuals
    |    Translations of the GDB manual are also available:
    |      [...]

Thoughts?



-- 
Joel


^ permalink raw reply	[flat|nested] 6+ messages in thread
end of thread, other threads:[~2009-11-09 22:14 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2009-11-09 18:48 Thoughts on the GDB "documentation" web page Joel Brobecker
2009-11-09 19:39 ` Eli Zaretskii
2009-11-09 20:09 ` Pedro Alves
2009-11-09 22:36   ` Joel Brobecker
2009-11-10  2:12     ` Joel Brobecker
2009-11-10  7:25       ` Pedro Alves

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox