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

   1 .\"     $NetBSD: dwarf_add_directory_decl.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_directory_decl.3 2072 2011-10-27 03:26:49Z jkoshy
  28 .\"
  29 .Dd September 17, 2011
  30 .Os
  31 .Dt DWARF_ADD_DIRECTORY_DECL 3
  32 .Sh NAME
  33 .Nm dwarf_add_directory_decl
  34 .Nd add a directory name to a producer instance
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft "Dwarf_Unsigned"
  40 .Fo dwarf_add_directory_decl
  41 .Fa "Dwarf_P_Debug dbg"
  42 .Fa "char *name"
  43 .Fa "Dwarf_Error *err"
  44 .Fc
  45 .Sh DESCRIPTION
  46 Function
  47 .Fn dwarf_add_directory_decl
  48 adds a source directory name to a producer instance and returns the
  49 index value generated for the directory name.
  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 name
  60 should point a NUL-terminated string containing the name of
  61 the directory.
  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_directory_decl
  70 returns the index value generated for the directory.
  71 In case of an error, function
  72 .Fn dwarf_add_directory_decl
  73 returns
  74 .Dv DW_DLV_NOCOUNT
  75 and sets the argument
  76 .Ar err .
  77 .Sh ERRORS
  78 Function
  79 .Fn dwarf_add_directory_decl
  80 can fail with:
  81 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
  82 .It Bq Er DW_DLE_ARGUMENT
  83 Either of the arguments
  84 .Ar dbg
  85 or
  86 .Ar name
  87 was NULL.
  88 .It Bq Er DW_DLE_MEMORY
  89 An out of memory condition was encountered during the execution of the
  90 function.
  91 .El
  92 .Sh SEE ALSO
  93 .Xr dwarf 3 ,
  94 .Xr dwarf_add_file_decl 3 ,
  95 .Xr dwarf_add_line_entry 3 ,
  96 .Xr dwarf_lne_end_sequence 3 ,
  97 .Xr dwarf_lne_set_address 3 ,
  98 .Xr dwarf_producer_init 3 ,
  99 .Xr dwarf_producer_init_b 3