aboutsummaryrefslogtreecommitdiff
path: root/gdb/doc
diff options
context:
space:
mode:
authorThomas Lord <lord@cygnus>1993-10-06 20:24:03 +0000
committerThomas Lord <lord@cygnus>1993-10-06 20:24:03 +0000
commit059e8ee2a265baa5b076b2f3929dcdb0db7daef7 (patch)
tree906fafb7abdeacc07feccd6ddd1b5c8fa43d6cf1 /gdb/doc
parent8966221d52bfdc9b9ccced3c02954e6d28674b7b (diff)
downloadgdb-059e8ee2a265baa5b076b2f3929dcdb0db7daef7.zip
gdb-059e8ee2a265baa5b076b2f3929dcdb0db7daef7.tar.gz
gdb-059e8ee2a265baa5b076b2f3929dcdb0db7daef7.tar.bz2
minor formatting tweaks
Diffstat (limited to 'gdb/doc')
-rw-r--r--gdb/doc/ChangeLog4
-rw-r--r--gdb/doc/libgdb.texinfo45
2 files changed, 27 insertions, 22 deletions
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index ac48fed..d9ef9de 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,7 @@
+Wed Oct 6 13:23:01 1993 Tom Lord (lord@rtl.cygnus.com)
+
+ * libgdb.texinfo: added `@' to braces that were unescaped.
+
Mon Oct 4 10:42:18 1993 Tom Lord (lord@rtl.cygnus.com)
* libgdb.texinfo: new file. Spec for the gdb library.
diff --git a/gdb/doc/libgdb.texinfo b/gdb/doc/libgdb.texinfo
index 49df038..c67c3a8 100644
--- a/gdb/doc/libgdb.texinfo
+++ b/gdb/doc/libgdb.texinfo
@@ -119,7 +119,7 @@ type of @code{gdb_error_t}.
@deftypefun {const char *} gdb_error_msg (gdb_error_t @var{error})
returns a reasonable error message for @var{error}.
-@end defun
+@end deftypefun
@heading Blocking I/O
@@ -129,7 +129,7 @@ returns a reasonable error message for @var{error}.
@heading Global Parameters
@subheading the current directory
-@deftypefun error_t gdb_cd (char * @var{dir})
+@deftypefun gdb_error_t gdb_cd (char * @var{dir})
Specify gdb's default directory as well as the working
directory for the inferior (when first started).@*
(cd_command)
@@ -142,7 +142,7 @@ Make a copy of the name of gdb's default directory.@*
@subheading controlling the input/output radix
-@deftypefun error_t gdb_set_base (int)
+@deftypefun gdb_error_t gdb_set_base (int)
Change the default output radix to 10 or 16, or set it to 0
(heuristic). This command is mostly obsolete now that the print
command allows formats to apply to aggregates, but is still handy
@@ -150,9 +150,9 @@ occasionally.@*
(set_base_command)
@end deftypefun
-@deftypefun error_t gdb_set_input_radix (int)
-@deftypefunx error_t gdb_set_output_radix (int)
-@deftypefunx error_t gdb_set_radix (int)
+@deftypefun gdb_error_t gdb_set_input_radix (int)
+@deftypefunx gdb_error_t gdb_set_output_radix (int)
+@deftypefunx gdb_error_t gdb_set_radix (int)
Valid output radixes are only 0 (heuristic), 10, and 16.@*
(set_radix)
@end deftypefun
@@ -240,22 +240,22 @@ The client could use these declarations:
@example
struct my_cback
-{
+@{
struct a_gdb_cback gdb_cback; /* must be first */
float magic_number;
-};
+@};
void
foo_helper (struct a_gdb_cback * callback, int i, char * cp)
-{
+@{
foo ( ((struct my_cback *)callback)->magic_number, i, c);
-}
+@}
struct my_cback
-{
+@{
foo_helper,
1079252848.8
-} the_cback;
+@} the_cback;
@end example
@@ -929,9 +929,9 @@ struct gdb_bp_condition * @var{cond};
typedef int (*gdb_bp_fn) (struct gdb_bp_condition *, int bp_num);
struct gdb_bp_condition
-{
+@{
gdb_bp_fn fn;
-};
+@};
@end example
Add a condition to a breakpoint.
The condition is a callback which should return
@@ -979,9 +979,9 @@ active (or `this_level_only'?? [[[?]]]).
@example
typedef void (*breakpoint_cback_fn) (struct breakpoint_cback *, int bp_num);
struct breakpoint_cback
-{
+@{
breakpoint_cback_fn fn;
-};
+@};
@end example
Breakpoints can have an associated function which is called
@@ -1113,12 +1113,12 @@ selected frame.
instead. */
frame1 = 0;
level = -1;
-if (get_current_frame()) {
+if (get_current_frame()) @{
for (frame1 = get_prev_frame (0);
frame1 && frame1 != frame;
frame1 = get_prev_frame (frame1))
level++;
-}
+@}
@end example
@@ -1331,11 +1331,11 @@ the number of string bytes printed.
-- IDIOM: This prints the values of all convenience variables:
@example
for (var = internalvars; var; var = var->next)
-{
+@{
printf_filtered ("$%s = ", var->name);
value_print (var->value, stdout, 0, Val_pretty_default);
printf_filtered ("\n");
-}
+@}
@end example
@@ -1357,12 +1357,12 @@ First print it as a number. Then perhaps print
-- IDIOM: This is the core of a dissasemble command:
@example
for (pc = low; pc < high; )
-{
+@{
print_address (pc, stdout);
printf_filtered (":\t");
pc += print_insn (pc, stdout);
printf_filtered ("\n");
-}
+@}
@end example
Advice for computing pc extents like @code{low} and @code{high}
can be found in `Symtabs' -- for example, @code{gdb_find_line_pc_range}.@*
@@ -1468,3 +1468,4 @@ If @var{show} is negative, we never show the details of elements' types.
[[[In the long run, we need something to programmaticly read off type
structures in a machine/language independent way.]]]
+@bye