xref: /netbsd-src/external/bsd/elftoolchain/dist/libdwarf/dwarf_reset_section_bytes.3 (revision 5ac3bc719ce6e70593039505b491894133237d12)
1*5ac3bc71Schristos.\"	$NetBSD: dwarf_reset_section_bytes.3,v 1.6 2024/03/03 17:37:32 christos Exp $
2e81373b4Schristos.\"
39dd9d0cfSchristos.\" Copyright (c) 2011 Kai Wang
49dd9d0cfSchristos.\" All rights reserved.
59dd9d0cfSchristos.\"
69dd9d0cfSchristos.\" Redistribution and use in source and binary forms, with or without
79dd9d0cfSchristos.\" modification, are permitted provided that the following conditions
89dd9d0cfSchristos.\" are met:
99dd9d0cfSchristos.\" 1. Redistributions of source code must retain the above copyright
109dd9d0cfSchristos.\"    notice, this list of conditions and the following disclaimer.
119dd9d0cfSchristos.\" 2. Redistributions in binary form must reproduce the above copyright
129dd9d0cfSchristos.\"    notice, this list of conditions and the following disclaimer in the
139dd9d0cfSchristos.\"    documentation and/or other materials provided with the distribution.
149dd9d0cfSchristos.\"
159dd9d0cfSchristos.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
169dd9d0cfSchristos.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
179dd9d0cfSchristos.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
189dd9d0cfSchristos.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
199dd9d0cfSchristos.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
209dd9d0cfSchristos.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
219dd9d0cfSchristos.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
229dd9d0cfSchristos.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
239dd9d0cfSchristos.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
249dd9d0cfSchristos.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
259dd9d0cfSchristos.\" SUCH DAMAGE.
269dd9d0cfSchristos.\"
27cdbf1fe1Sjkoshy.\" Id: dwarf_reset_section_bytes.3 3963 2022-03-12 16:07:32Z jkoshy
289dd9d0cfSchristos.\"
299dd9d0cfSchristos.Dd September 3, 2011
309dd9d0cfSchristos.Dt DWARF_RESET_SECTION_BYTES 3
31604b0842Sjkoshy.Os
329dd9d0cfSchristos.Sh NAME
339dd9d0cfSchristos.Nm dwarf_reset_section_bytes
349dd9d0cfSchristos.Nd reset the internal state of a producer instance
359dd9d0cfSchristos.Sh LIBRARY
369dd9d0cfSchristos.Lb libdwarf
379dd9d0cfSchristos.Sh SYNOPSIS
389dd9d0cfSchristos.In libdwarf.h
399dd9d0cfSchristos.Ft void
409dd9d0cfSchristos.Fo dwarf_reset_section_bytes
419dd9d0cfSchristos.Fa "Dwarf_P_Debug dbg"
429dd9d0cfSchristos.Fc
439dd9d0cfSchristos.Sh DESCRIPTION
449dd9d0cfSchristosFunction
459dd9d0cfSchristos.Fn dwarf_reset_section_bytes
469dd9d0cfSchristosresets the internal state of a DWARF producer instance, so that the
479dd9d0cfSchristosnext call to the function
489dd9d0cfSchristos.Xr dwarf_get_section_bytes 3
499dd9d0cfSchristoswill return the byte stream for the first generated section, and
509dd9d0cfSchristosthe next call to the function
519dd9d0cfSchristos.Xr dwarf_get_relocation_info 3
529dd9d0cfSchristoswill return the first relocation array for the DWARF producer
539dd9d0cfSchristosinstance.
549dd9d0cfSchristos.Pp
559dd9d0cfSchristosArgument
56cdbf1fe1Sjkoshy.Fa dbg
579dd9d0cfSchristosshould reference a DWARF producer instance allocated using
589dd9d0cfSchristos.Xr dwarf_producer_init 3
599dd9d0cfSchristosor
609dd9d0cfSchristos.Xr dwarf_producer_init_b 3 .
619dd9d0cfSchristos.Sh RETURN VALUES
629dd9d0cfSchristosFunction
639dd9d0cfSchristos.Fn dwarf_reset_section_bytes
649dd9d0cfSchristoshas no return value.
659dd9d0cfSchristos.Sh SEE ALSO
669dd9d0cfSchristos.Xr dwarf 3 ,
679dd9d0cfSchristos.Xr dwarf_get_relocation_info 3 ,
689dd9d0cfSchristos.Xr dwarf_get_section_bytes 3 ,
699dd9d0cfSchristos.Xr dwarf_producer_init 3 ,
709dd9d0cfSchristos.Xr dwarf_producer_init_b 3 ,
719dd9d0cfSchristos.Xr dwarf_transform_to_disk_form 3
72