This is the mail archive of the
gdb-prs@sources.redhat.com
mailing list for the GDB project.
gdb/436: Add ``conventions'' section to doco
- From: ac131313 at redhat dot com
- To: gdb-gnats at sources dot redhat dot com
- Date: 20 Mar 2002 21:44:57 -0000
- Subject: gdb/436: Add ``conventions'' section to doco
- Reply-to: ac131313 at redhat dot com
>Number: 436
>Category: gdb
>Synopsis: Add ``conventions'' section to doco
>Confidential: no
>Severity: serious
>Priority: medium
>Responsible: unassigned
>State: open
>Class: doc-bug
>Submitter-Id: net
>Arrival-Date: Wed Mar 20 13:48:01 PST 2002
>Closed-Date:
>Last-Modified:
>Originator: ac131313@redhat.com
>Release: 2002-03-21
>Organization:
>Environment:
>Description:
At present the only mention of conventions followed by GDB's documentation is the single paragraph mentioning ``bold'' in the sample gdb session chapter.
Suggest a new section (at the end of the first chapter) that explains the conventions followed in the manual. Things like:
$ is the shell prompt
(gdb) is the gdb prompt
bold for output (or was that input?)
come to mind. In addition, the section should contain comments explaining how to follow this. Perhaphs the internals manual could include the same section but with all the details.
Andrew
>How-To-Repeat:
>Fix:
>Release-Note:
>Audit-Trail:
>Unformatted: