1.\"	$NetBSD: dwarf_add_die_to_debug.3,v 1.2 2014/03/09 16:58:03 christos Exp $
2.\"
3.\" Copyright (c) 2011 Kai Wang
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" Id: dwarf_add_die_to_debug.3 2938 2013-04-27 05:09:17Z jkoshy
28.\"
29.Dd August 21, 2011
30.Os
31.Dt DWARF_ADD_DIE_TO_DEBUG 3
32.Sh NAME
33.Nm dwarf_add_die_to_debug
34.Nd set the root debugging information entry
35.Sh LIBRARY
36.Lb libdwarf
37.Sh SYNOPSIS
38.In libdwarf.h
39.Ft Dwarf_Unsigned
40.Fo dwarf_add_die_to_debug
41.Fa "Dwarf_P_Debug dbg"
42.Fa "Dwarf_P_Die first_die"
43.Fa "Dwarf_Error *err"
44.Fc
45.Sh DESCRIPTION
46Function
47.Fn dwarf_add_die_to_debug
48sets the root debugging information entry of a DWARF producer
49instance.
50All debugging information entries linked to the root entry will also
51be added to the producer instance.
52.Pp
53Argument
54.Ar dbg
55should reference a DWARF producer instance allocated using
56.Xr dwarf_producer_init 3
57or
58.Xr dwarf_producer_init_b 3 .
59.Pp
60Argument
61.Ar first_die
62should hold the debugging information entry which will become
63the root DIE.
64.Pp
65If argument
66.Ar err
67is not NULL, it will be used to store error information in case
68of an error.
69.Sh RETURN VALUES
70On success, function
71.Fn dwarf_add_die_to_debug
72returns
73.Dv DW_DLV_OK .
74In case of an error, function
75.Fn dwarf_add_die_to_debug
76returns
77.Dv DW_DLV_NOCOUNT
78and sets the argument
79.Ar err .
80.Sh ERRORS
81Function
82.Fn dwarf_add_die_to_debug
83can fail with:
84.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
85.It Bq Er DW_DLE_ARGUMENT
86Either of the arguments
87.Ar dbg
88or
89.Ar first_die
90was NULL.
91.El
92.Sh SEE ALSO
93.Xr dwarf 3 ,
94.Xr dwarf_die_link 3 ,
95.Xr dwarf_new_die 3 ,
96.Xr dwarf_producer_init 3 ,
97.Xr dwarf_producer_init_b 3
98