summaryrefslogtreecommitdiffstats
path: root/contrib/elftoolchain/libdwarf/dwarf_die_link.3
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/elftoolchain/libdwarf/dwarf_die_link.3')
-rw-r--r--contrib/elftoolchain/libdwarf/dwarf_die_link.3118
1 files changed, 118 insertions, 0 deletions
diff --git a/contrib/elftoolchain/libdwarf/dwarf_die_link.3 b/contrib/elftoolchain/libdwarf/dwarf_die_link.3
new file mode 100644
index 0000000..89ddb5b
--- /dev/null
+++ b/contrib/elftoolchain/libdwarf/dwarf_die_link.3
@@ -0,0 +1,118 @@
+.\" Copyright (c) 2011 Kai Wang
+.\" 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 THE AUTHOR AND CONTRIBUTORS ``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 THE AUTHOR OR CONTRIBUTORS 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_die_link.3 2073 2011-10-27 03:30:47Z jkoshy $
+.\"
+.Dd September 4, 2011
+.Os
+.Dt DWARF_DIE_LINK 3
+.Sh NAME
+.Nm dwarf_die_link
+.Nd link a debugging information entry
+.Sh LIBRARY
+.Lb libdwarf
+.Sh SYNOPSIS
+.In libdwarf.h
+.Ft Dwarf_P_Die
+.Fo dwarf_die_link
+.Fa "Dwarf_P_Die die"
+.Fa "Dwarf_P_Die parent"
+.Fa "Dwarf_P_Die child"
+.Fa "Dwarf_P_Die left"
+.Fa "Dwarf_P_Die right"
+.Fa "Dwarf_Error *err"
+.Fc
+.Sh DESCRIPTION
+Function
+.Fn dwarf_die_link
+links debugging information entries together.
+.Pp
+Argument
+.Ar die
+should specify the debugging information entry to be updated.
+.Pp
+Argument
+.Ar parent
+specifies the new parent link for the debugging information entry.
+.Pp
+Argument
+.Ar child
+specifies the new first child link for the debugging information entry.
+.Pp
+Argument
+.Ar left
+specifies the new left sibling link for the debugging information entry.
+.Pp
+Argument
+.Ar right
+specifies the new right sibling link for the debugging information entry.
+.Pp
+Only one of arguments
+.Ar parent ,
+.Ar child ,
+.Ar left
+and
+.Ar right
+is allowed to be non-NULL.
+Existing links to parent, child, left or right debugging information
+entries, if any, will be unlinked before the specified link is
+established.
+.Pp
+If argument
+.Ar err
+is not NULL, it will be used to store error information in case
+of an error.
+.Sh RETURN VALUES
+On success, function
+.Fn dwarf_die_link
+returns the debugging information entry provided in argument
+.Ar die .
+In case of an error, function
+.Fn dwarf_die_link
+returns
+.Dv DW_DLV_BADADDR
+and sets the argument
+.Ar err .
+.Sh ERRORS
+The function
+.Fn dwarf_die_link
+can fail with:
+.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
+.It Bq Er DW_DLE_ARGUMENT
+Argument
+.Ar die
+was NULL.
+.It Bq Er DW_DLE_ARGUMENT
+More than one of the arguments
+.Ar parent ,
+.Ar child ,
+.Ar left
+and
+.Ar right
+were non-NULL.
+.El
+.Sh SEE ALSO
+.Xr dwarf 3 ,
+.Xr dwarf_add_die_to_debug 3 ,
+.Xr dwarf_new_die 3
OpenPOWER on IntegriCloud