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

   1 .\"     $NetBSD: dwarf_vendor_ext.3,v 1.2 2014/03/09 16:58:04 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_vendor_ext.3 2075 2011-10-27 03:47:28Z jkoshy
  28 .\"
  29 .Dd September 25, 2011
  30 .Os
  31 .Dt DWARF_VENDOR_EXT 3
  32 .Sh NAME
  33 .Nm dwarf_vendor_ext
  34 .Nd add vendor-specific macro information to a DWARF producer instance
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft "int"
  40 .Fo dwarf_vendor_ext
  41 .Fa "Dwarf_P_Debug dbg"
  42 .Fa "Dwarf_Unsigned constant"
  43 .Fa "char *string"
  44 .Fa "Dwarf_Error *err"
  45 .Fc
  46 .Sh DESCRIPTION
  47 Function
  48 .Fn dwarf_vendor_ext
  49 adds a vendor-specific macro information entry to a DWARF producer
  50 instance.
  51 .Pp
  52 Argument
  53 .Ar dbg
  54 should reference a DWARF producer instance allocated using
  55 .Xr dwarf_producer_init 3
  56 or
  57 .Xr dwarf_producer_init_b 3 .
  58 .Pp
  59 Argument
  60 .Ar constant
  61 specifies a constant value for the macro information entry.
  62 .Pp
  63 Argument
  64 .Ar string
  65 point to a NUL-terminated string containing the string value
  66 for the macro information entry.
  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 .Pp
  73 The meaning of the arguments
  74 .Ar constant
  75 and
  76 .Ar string
  77 are not defined by the DWARF specification, but are instead governed
  78 by application and vendor conventions.
  79 .Sh RETURN VALUES
  80 On success, function
  81 .Fn dwarf_vendor_ext
  82 returns
  83 .Dv DW_DLV_OK .
  84 In case of an error, function
  85 .Fn dwarf_vendor_ext
  86 returns
  87 .Dv DW_DLV_ERROR
  88 and sets the argument
  89 .Ar err .
  90 .Sh ERRORS
  91 Function
  92 .Fn dwarf_vendor_ext
  93 can fail with:
  94 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  95 .It Bq Er DW_DLE_ARGUMENT
  96 Either arguments
  97 .Ar dbg
  98 or
  99 .Ar string
 100 was NULL.
 101 .It Bq Er DW_DLE_MEMORY
 102 An out of memory condition was encountered during the execution of the
 103 function.
 104 .El
 105 .Sh SEE ALSO
 106 .Xr dwarf 3 ,
 107 .Xr dwarf_def_macro 3 ,
 108 .Xr dwarf_end_macro_file 3 ,
 109 .Xr dwarf_producer_init 3 ,
 110 .Xr dwarf_producer_init_b 3 ,
 111 .Xr dwarf_start_macro_file 3 ,
 112 .Xr dwarf_undef_macro 3