external/bsd/elftoolchain/dist/libdwarf/dwarf_add_varname.3

   1 .\"     $NetBSD: dwarf_add_varname.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_varname.3 2072 2011-10-27 03:26:49Z jkoshy
  28 .\"
  29 .Dd September 24, 2011
  30 .Os
  31 .Dt DWARF_ADD_VARNAME 3
  32 .Sh NAME
  33 .Nm dwarf_add_varname
  34 .Nd add information about a static variable to a DWARF producer instance
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft "Dwarf_Unsigned"
  40 .Fo dwarf_add_varname
  41 .Fa "Dwarf_P_Debug dbg"
  42 .Fa "Dwarf_P_Die die"
  43 .Fa "char *name"
  44 .Fa "Dwarf_Error *err"
  45 .Fc
  46 .Sh DESCRIPTION
  47 Function
  48 .Fn dwarf_add_varname
  49 adds information about a static variable to a DWARF 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 die
  60 specifies the debugging information entry associated with the static
  61 variable.
  62 .Pp
  63 Argument
  64 .Ar name
  65 should point to a NUL-terminated string containing the name
  66 of the static variable.
  67 .Pp
  68 If argument
  69 .Ar err
  70 is not NULL, it will be used to store error information in case of an
  71 error.
  72 .Sh RETURN VALUES
  73 On success, function
  74 .Fn dwarf_add_varname
  75 returns a non-zero value.
  76 In case of an error, function
  77 .Fn dwarf_add_varname
  78 returns 0 and sets
  79 the argument
  80 .Ar err .
  81 .Sh ERRORS
  82 Function
  83 .Fn dwarf_add_varname
  84 can fail with:
  85 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  86 .It Bq Er DW_DLE_ARGUMENT
  87 One of the arguments
  88 .Ar dbg ,
  89 .Ar die
  90 or
  91 .Ar name
  92 was NULL.
  93 .It Bq Er DW_DLE_MEMORY
  94 An out of memory condition was encountered during the execution of the
  95 function.
  96 .El
  97 .Sh SEE ALSO
  98 .Xr dwarf 3 ,
  99 .Xr dwarf_add_funcname 3 ,
 100 .Xr dwarf_add_pubname 3 ,
 101 .Xr dwarf_add_typename 3 ,
 102 .Xr dwarf_add_weakname 3 ,
 103 .Xr dwarf_new_die 3 ,
 104 .Xr dwarf_producer_init 3 ,
 105 .Xr dwarf_producer_init_b 3