7f27984ee0
release, and about the README file.
69 lines
2.4 KiB
Text
69 lines
2.4 KiB
Text
GDB Internals documentation
|
|
|
|
This needs to be wrapped in texinfo stuff...
|
|
|
|
Cleanups
|
|
|
|
Cleanups are a structured way to deal with things that need to be done
|
|
later. When your code does something (like malloc some memory, or open
|
|
a file) that needs to be undone later (e.g. free the memory or close
|
|
the file), it can make a cleanup. The cleanup will be done at some
|
|
future point: when the command is finished, when an error occurs, or
|
|
when your code decides it's time to do cleanups.
|
|
|
|
You can also discard cleanups, that is, throw them away without doing
|
|
what they say. This is only done if you ask that it be done.
|
|
|
|
Syntax:
|
|
|
|
old_chain = make_cleanup (function, arg);
|
|
|
|
This makes a cleanup which will cause FUNCTION to be called with ARG
|
|
(a char *) later. The result, OLD_CHAIN, is a handle that can be
|
|
passed to do_cleanups or discard_cleanups later. Unless you are
|
|
going to call do_cleanups or discard_cleanups yourself,
|
|
you can ignore the result from make_cleanup.
|
|
|
|
do_cleanups (old_chain);
|
|
|
|
Performs all cleanups done since make_cleanup returned OLD_CHAIN.
|
|
E.g.: make_cleanup (a, 0); old = make_cleanup (b, 0); do_cleanups (old);
|
|
will call b() but will not call a(). The cleanup that calls a() will remain
|
|
in the cleanup chain, and will be done later unless otherwise discarded.
|
|
|
|
discard_cleanups (old_chain);
|
|
|
|
Same as do_cleanups except that it just removes the cleanups from the
|
|
chain and does not call the specified functions.
|
|
|
|
|
|
Some functions, e.g. fputs_filtered() or error(), specify that they
|
|
"should not be called when cleanups are not in place". This means
|
|
that any actions you need to reverse in the case of an error or
|
|
interruption must be on the cleanup chain before you call these functions,
|
|
since they might never return to your code (they "longjmp" instead).
|
|
|
|
|
|
|
|
Configuring GDB for release
|
|
|
|
|
|
GDB should be released after doing "config.gdb none" in the top level
|
|
directory. This will leave a makefile there, but no tm- or xm- files.
|
|
The makefile is needed, for example, for "make gdb.tar.Z"... If you
|
|
have tm- or xm-files in the main source directory, C's include rules
|
|
cause them to be used in preference to tm- and xm-files in the
|
|
subdirectories where the user will actually configure and build the
|
|
binaries.
|
|
|
|
"config.gdb none" is also a good way to rebuild the top level Makefile
|
|
after changing Makefile.dist, alldeps.mak, etc.
|
|
|
|
|
|
|
|
|
|
The README file
|
|
|
|
|
|
Check the README file, it often has useful information that does not
|
|
appear anywhere else in the directory.
|