* Patch: document sessions
@ 2001-06-11 20:10 Tom Tromey
2001-06-12 7:39 ` Fernando Nasser
2001-06-12 7:56 ` Keith Seitz
0 siblings, 2 replies; 6+ messages in thread
From: Tom Tromey @ 2001-06-11 20:10 UTC (permalink / raw)
To: Insight List
This patch adds some rudimentary documentation for sessions. Is this
ok to check in?
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.
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>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Patch: document sessions
2001-06-11 20:10 Patch: document sessions Tom Tromey
@ 2001-06-12 7:39 ` Fernando Nasser
2001-06-12 9:22 ` Tom Tromey
2001-06-12 7:56 ` Keith Seitz
1 sibling, 1 reply; 6+ messages in thread
From: Fernando Nasser @ 2001-06-12 7:39 UTC (permalink / raw)
To: tromey; +Cc: Insight List
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
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Patch: document sessions
2001-06-11 20:10 Patch: document sessions Tom Tromey
2001-06-12 7:39 ` Fernando Nasser
@ 2001-06-12 7:56 ` Keith Seitz
1 sibling, 0 replies; 6+ messages in thread
From: Keith Seitz @ 2001-06-12 7:56 UTC (permalink / raw)
To: Tom Tromey; +Cc: Insight List
On 11 Jun 2001, Tom Tromey wrote:
> This patch adds some rudimentary documentation for sessions. Is this
> ok to check in?
Please do check it in.
> 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.
Texinfo would be okay, but it was originally my intent that this online
help system be simple, "how do I..." help. No pictures, no huge
explanations of what things do. Unfortunately others did not share a
cohesive view of the help, and proceeded to add in all sorts of random
pictures (often with conflicting styles).
Eventually, it has grown into a more publishable format. I would rather
see the current (online) documentation get shoved into a paper user manual
and the whole "online" system re-written.
One concern I have with texinfo, though... From my (limited) experience,
it doesn't handle pictures very well. Although this would be fine for the
online docs (as I see them), I would not be very enthused to make a paper
user's guide using it...
Keith
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Patch: document sessions
2001-06-12 7:39 ` Fernando Nasser
@ 2001-06-12 9:22 ` Tom Tromey
2001-06-12 10:28 ` Keith Seitz
2001-06-12 10:41 ` Andrew Cagney
0 siblings, 2 replies; 6+ messages in thread
From: Tom Tromey @ 2001-06-12 9:22 UTC (permalink / raw)
To: Fernando Nasser; +Cc: Insight List
>> This patch adds some rudimentary documentation for sessions. Is
>> this ok to check in?
Fernando> Yes!
Done.
Fernando> I believe you. What about GIFs though? Can we include GIFs
Fernando> in texinfo documents? It is just a TeX variant isn't it?
Texinfo is a TeX variant, but I don't think it looks much like TeX.
Anyway you can have images. There is an @image{} command.
Tom
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Patch: document sessions
2001-06-12 9:22 ` Tom Tromey
@ 2001-06-12 10:28 ` Keith Seitz
2001-06-12 10:41 ` Andrew Cagney
1 sibling, 0 replies; 6+ messages in thread
From: Keith Seitz @ 2001-06-12 10:28 UTC (permalink / raw)
To: Tom Tromey; +Cc: Fernando Nasser, Insight List
On 12 Jun 2001, Tom Tromey wrote:
> Fernando> I believe you. What about GIFs though? Can we include GIFs
> Fernando> in texinfo documents? It is just a TeX variant isn't it?
>
> Texinfo is a TeX variant, but I don't think it looks much like TeX.
> Anyway you can have images. There is an @image{} command.
Yeah -- that is exactly what scares me.... I've used the "@image{}" stuff
before. It is, to put it mildly, entertaining.
Keith
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: Patch: document sessions
2001-06-12 9:22 ` Tom Tromey
2001-06-12 10:28 ` Keith Seitz
@ 2001-06-12 10:41 ` Andrew Cagney
1 sibling, 0 replies; 6+ messages in thread
From: Andrew Cagney @ 2001-06-12 10:41 UTC (permalink / raw)
To: tromey; +Cc: Fernando Nasser, Insight List
> >> This patch adds some rudimentary documentation for sessions. Is
> >> this ok to check in?
>
> Fernando> Yes!
>
> Done.
>
> Fernando> I believe you. What about GIFs though? Can we include GIFs
> Fernando> in texinfo documents? It is just a TeX variant isn't it?
>
> Texinfo is a TeX variant, but I don't think it looks much like TeX.
> Anyway you can have images. There is an @image{} command.
Yes, the document I just posted was built using texinfo. I've also a
hypertext PDF file if you want. The output is pretty good.
The problem is creating that output (I suspect this is what Keith was
refering to). You can find yourself having to climb over all sorts of
hurdles just to build the document. Depending on the input files used
and the final output used you may need to install all sorts of querky
and obscure utilities. For instance given a .fig file (created using
xfig :-) would need to convert it into .pdf for PDF, .eps for DVI/PS
and .jpg for HTML.
Andrew
PS: GNU projects do not use GIF's.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2001-06-12 10:41 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2001-06-11 20:10 Patch: document sessions Tom Tromey
2001-06-12 7:39 ` Fernando Nasser
2001-06-12 9:22 ` Tom Tromey
2001-06-12 10:28 ` Keith Seitz
2001-06-12 10:41 ` Andrew Cagney
2001-06-12 7:56 ` Keith Seitz
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).