contrib/elftoolchain/libdwarf/dwarf_add_die_to_debug.3

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