1 files changed, 103 insertions, 0 deletions
diff --git a/rtemstoolkit/elftoolchain/libdwarf/dwarf_get_elf.3 b/rtemstoolkit/elftoolchain/libdwarf/dwarf_get_elf.3
new file mode 100644
index 0000000..c93a7ef
--- /dev/null
+++ b/rtemstoolkit/elftoolchain/libdwarf/dwarf_get_elf.3
@@ -0,0 +1,103 @@
+.\" Copyright (c) 2009 Joseph Koshy.  All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" This software is provided by Joseph Koshy ``as is'' and
+.\" any express or implied warranties, including, but not limited to, the
+.\" implied warranties of merchantability and fitness for a particular purpose
+.\" are disclaimed.  in no event shall Joseph Koshy be liable
+.\" for any direct, indirect, incidental, special, exemplary, or consequential
+.\" damages (including, but not limited to, procurement of substitute goods
+.\" or services; loss of use, data, or profits; or business interruption)
+.\" however caused and on any theory of liability, whether in contract, strict
+.\" liability, or tort (including negligence or otherwise) arising in any way
+.\" out of the use of this software, even if advised of the possibility of
+.\" such damage.
+.\"
+.\" $Id: dwarf_get_elf.3 2122 2011-11-09 15:35:14Z jkoshy $
+.\"
+.Dd November 9, 2011
+.Os
+.Dt DWARF_GET_ELF 3
+.Sh NAME
+.Nm dwarf_get_elf
+.Nd retrieve the
+.Vt Elf
+descriptor associated with a
+.Vt Dwarf_Debug
+instance
+.Sh LIBRARY
+.Lb libdwarf
+.Sh SYNOPSIS
+.In libdwarf.h
+.Ft int
+.Fo dwarf_get_elf
+.Fa "Dwarf_Debug dbg"
+.Fa "Elf **elf"
+.Fa "Dwarf_Error *err"
+.Fc
+.Sh DESCRIPTION
+Function
+.Fn dwarf_get_elf
+returns the
+.Vt Elf
+descriptor associated with a
+.Vt Dwarf_Debug
+instance.
+.Pp
+Argument
+.Ar dbg
+should be a handle to a valid
+.Vt Dwarf_Debug
+instance returned by a prior call to
+.Xr dwarf_init 3
+or
+.Xr dwarf_elf_init 3 .
+.Pp
+Argument
+.Ar elf
+points a location into which a handle to an
+.Vt Elf
+descriptor will be written.
+.Pp
+Argument
+.Ar err
+is used to record error information in case of failure.
+.Sh RETURN VALUES
+On success, function
+.Fn dwarf_get_elf
+returns
+.Dv DW_DLV_OK .
+In case of an error, it returns
+.Dv DW_DLV_ERROR
+and sets argument
+.Ar err .
+.Sh EXAMPLES
+To retrieve the
+.Vt Elf
+instance associated with a
+.Vt Dwarf_Debug
+instance use:
+.Bd -literal -offset indent
+Dwarf_Debug dbg;
+Dwarf_Error de;
+Elf *elf;
+
+\&... allocate dbg using dwarf_init() etc ...
+
+if (dwarf_get_elf(dbg, &elf, &de) != DW_DLV_OK)
+	errx(EXIT_FAILURE, "dwarf_get_elf: %s", dwarf_errmsg(de));
+.Ed
+.Sh SEE ALSO
+.Xr dwarf 3 ,
+.Xr dwarf_errmsg 3 ,
+.Xr dwarf_init 3 ,
+.Xr dwarf_finish 3 ,
+.Xr elf 3