Re: [RFA/doco] document support for Ravenscar profile

[Joel Brobecker <brobecker at adacore dot com>]

Thanks for the review, Eli.

> > +* Ada task switching is now supported on sparc-elf targets when
> > +  debugging a program using the Ravenscar Profile.
> 
> This part is okay, but please add a sentence pointing to the new
> section in the manual which describes the details.

I've added a quick sentence. Let me know if this enough.  Also,
I should say that I deliberately avoided listing the new commands
in the NEWS files, because I think they are pretty obscure and
only likely to be used in emergency situations.

> > +the use of a specific Runtime.
> 
> Is this important to mention this specific runtime?  If it is
> important, then is it enough to just mention its necessity, without
> any further details?  And why "Runtime" with a capital R?

Actually, not really. I don't even know why I mentioned it.  How
to activate this profile is really a detail that belongs to the
compiler manual...  So I removed it entirely.

> Instead of 2 @cindex entries, I'd just leave one:
> 
>   @cindex task switching with program using Ravenscar Profile

Changed accordingly.  I am wondering whether it would sound better
if we add 'the' before 'Ravenscar Profile'.

    @cindex task switching with program using the Ravenscar Profile

> > +@item set ravenscar task-switching off
> > +Turn off task switching when debugging a program that uses the Ravenscar
> > +Profile.  This is mostly intended to help disable the code that adds
> 
> "help disable" or "disable"?  That is, is this only part of what's
> needed to disable Ravenscar Profile support, or is it the whole thing?

You're right. 'help' is now gone.

> > +properly.  To be completely effective, this command should be run
> > +before the program is started.
> 
> Will it be even partially effective if it is run after the program is
> started?  If not, then I think we should drop the "completely" part.

Agreed as well.

Here is a new version.
-- 
Joel

commit 6c4632b72d07ac50c5482c265ace39fc5d964f26
Author: Joel Brobecker <brobecker@adacore.com>
Date:   Thu Sep 23 13:03:42 2010 -0700

    [doco] document support for Ravenscar profile
    
    This announces the support for debugging Ada programs using
    the Ravenscar Profile, as well as documents the new commands
    introduced as part of this effort.
    
    gdb/ChangeLog:
    
            * NEWS: Announce Ravenscar Profile support.
    
    gdb/doc/ChangeLog:
    
            * gdb.texinfo (Ravenscar Profile): New node.

diff --git a/gdb/NEWS b/gdb/NEWS
index 01d2f46..85059c6 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -67,6 +67,11 @@
   ** GDBserver is now supported on PowerPC LynxOS (versions 4.x and 5.x),
      and i686 LynxOS (version 5.x).
 
+* Ada task switching is now supported on sparc-elf targets when
+  debugging a program using the Ravenscar Profile.  For more information,
+  see the "Tasking Support when using the Ravenscar Profile" section
+  in the GDB user manual.
+
 *** Changes in GDB 7.2
 
 * Shared library support for remote targets by default
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 07f9ad6..0b24718 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -12861,6 +12861,8 @@ to be difficult.
 * Stopping Before Main Program:: Debugging the program during elaboration.
 * Ada Tasks::                   Listing and setting breakpoints in tasks.
 * Ada Tasks and Core Files::    Tasking Support when Debugging Core Files
+* Ravenscar Profile::           Tasking Support when using the Ravenscar
+                                   Profile
 * Ada Glitches::                Known peculiarities of Ada mode.
 @end menu
 
@@ -13411,6 +13413,36 @@ privileges, using the command @samp{"set write on"} (@pxref{Patching}).
 Under these circumstances, you should make a backup copy of the core
 file before inspecting it with @value{GDBN}.
 
+@node Ravenscar Profile
+@subsubsection Tasking Support when using the Ravenscar Profile
+@cindex Ravenscar Profile
+
+The @dfn{Ravenscar Profile} is a subset of the Ada tasking features,
+specifically designed for systems with safety-critical real-time
+requirements.
+
+@table @code
+@kindex set ravenscar task-switching on
+@cindex task switching with program using Ravenscar Profile
+@item set ravenscar task-switching on
+Allows task switching when debugging a program that uses the Ravenscar
+Profile.  This is the default.
+
+@kindex set ravenscar task-switching off
+@item set ravenscar task-switching off
+Turn off task switching when debugging a program that uses the Ravenscar
+Profile.  This is mostly intended to disable the code that adds support
+for the Ravenscar Profile, in case a bug in either @value{GDBN} or in
+the Ravenscar runtime is preventing @value{GDBN} from working properly.
+To be effective, this command should be run before the program is started.
+
+@kindex show ravenscar task-switching
+@item show ravenscar task-switching
+Show whether it is possible to switch from task to task in a program
+using the Ravenscar Profile.
+
+@end table
+
 @node Ada Glitches
 @subsubsection Known Peculiarities of Ada Mode
 @cindex Ada, problems