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

   1 .\"     $NetBSD: dwarf_reset_section_bytes.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_reset_section_bytes.3 2075 2011-10-27 03:47:28Z jkoshy
  28 .\"
  29 .Dd September 3, 2011
  30 .Os
  31 .Dt DWARF_RESET_SECTION_BYTES 3
  32 .Sh NAME
  33 .Nm dwarf_reset_section_bytes
  34 .Nd reset the internal state of a producer instance
  35 .Sh LIBRARY
  36 .Lb libdwarf
  37 .Sh SYNOPSIS
  38 .In libdwarf.h
  39 .Ft void
  40 .Fo dwarf_reset_section_bytes
  41 .Fa "Dwarf_P_Debug dbg"
  42 .Fc
  43 .Sh DESCRIPTION
  44 Function
  45 .Fn dwarf_reset_section_bytes
  46 resets the internal state of a DWARF producer instance, so that the
  47 next call to the function
  48 .Xr dwarf_get_section_bytes 3
  49 will return the byte stream for the first generated section, and
  50 the next call to the function
  51 .Xr dwarf_get_relocation_info 3
  52 will return the first relocation array for the DWARF producer
  53 instance.
  54 .Pp
  55 Argument
  56 .Ar dbg
  57 should reference a DWARF producer instance allocated using
  58 .Xr dwarf_producer_init 3
  59 or
  60 .Xr dwarf_producer_init_b 3 .
  61 .Sh RETURN VALUES
  62 Function
  63 .Fn dwarf_reset_section_bytes
  64 has no return value.
  65 .Sh SEE ALSO
  66 .Xr dwarf 3 ,
  67 .Xr dwarf_get_relocation_info 3 ,
  68 .Xr dwarf_get_section_bytes 3 ,
  69 .Xr dwarf_producer_init 3 ,
  70 .Xr dwarf_producer_init_b 3 ,
  71 .Xr dwarf_transform_to_disk_form 3