This is the mail archive of the
insight@sources.redhat.com
mailing list for the Insight project.
Re: Patch: document sessions
- To: tromey at redhat dot com
- Subject: Re: Patch: document sessions
- From: Fernando Nasser <fnasser at cygnus dot com>
- Date: Tue, 12 Jun 2001 10:39:09 -0400
- CC: Insight List <insight at sourceware dot cygnus dot com>
- Organization: Red Hat , Inc. - Toronto
- References: <87lmmyjs75.fsf@creche.redhat.com>
Tom Tromey wrote:
>
> This patch adds some rudimentary documentation for sessions. Is this
> ok to check in?
>
Yes!
Thank you for writing it.
> This is probably flamable, but I think it would make sense to rewrite
> the Insight docs in Texinfo. One nice thing about Texinfo is that you
> can generate fairly nice HTML from it. (Take a look at
> http://sources.redhat.com/autobook/ if you don't believe me.)
> This would be a win over the current situation; for instance we would
> get in-document navigation on every page.
>
I believe you. What about GIFs though? Can we include GIFs in texinfo documents? It is just a TeX variant isn't it?
P.S.: I guess we can add navigation to the HTML pages easily. I don't know if the itcl widget can handle them, so we may have to add it only to the on-line manual (not the on-line help). Of course, I don't think it will be easy to get a decently printed copy of the manual. But an Insight manual should not be large (if a GUI needs a long manual something is wrong), so printing the pages may be enough.
Sorry, I am just thinking aloud...
Cheers,
Fernando
> 2001-06-11 Tom Tromey <tromey@redhat.com>
>
> * library/help/session.html: New file.
> * library/help/index.html: Added link.
>
> Tom
>
> Index: library/help/index.html
> ===================================================================
> RCS file: /cvs/src/src/gdb/gdbtk/library/help/index.html,v
> retrieving revision 1.1.1.1
> diff -u -r1.1.1.1 index.html
> --- index.html 2000/02/07 00:19:42 1.1.1.1
> +++ index.html 2001/06/12 03:06:12
> @@ -43,6 +43,9 @@
> <LI>
> <A HREF="watch.html">Watch Window</A></LI>
>
> +<LI>
> +<A HREF="session.html">Sessions</A></LI>
> +
> </UL>
> <A HREF="license.html">GNU General Public License</A>
> </BODY>
> Index: library/help/session.html
> ===================================================================
> RCS file: session.html
> diff -N session.html
> --- /dev/null Tue May 5 13:32:27 1998
> +++ session.html Mon Jun 11 20:06:12 2001
> @@ -0,0 +1,40 @@
> +<html>
> +<head>
> +<title>Sessions</title>
> +</head>
> +<body>
> +
> +<center><h2>Sessions</h2></center>
> +
> +Insight will save your session for you automatically. The ``session''
> +is essentially a group of settings which are keyed by the name of the
> +inferior which you are debugging.<p>
> +
> +Insight will show a list of the five most recent previous sessions on
> +the <tt>File</tt> menu. Choosing an item from this list will cause
> +Insight to load the indicated executable and restore all the settings
> +saved in the session.<p>
> +
> +The settings stored in a session are:
> +<ul>
> +<li> The name of the executable.
> +
> +<li> The inferior's command-line arguments.
> +
> +<li> The target.
> +
> +<li> The path used when searching for source files.
> +
> +<li> The current working directory.
> +
> +<li> The breakpoints and watchpoints, including conditions, actions,
> + and the like.
> +</ul>
> +<p>
> +
> +More items may be added to this list as the need arises.<p>
> +
> +At present there is no way to disable session saving.<p>
> +
> +</body>
> +</html>
--
Fernando Nasser
Red Hat - Toronto E-Mail: fnasser@redhat.com
2323 Yonge Street, Suite #300
Toronto, Ontario M4P 2C9