xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_reset_section_bytes.3 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1.\" Copyright (c) 2011 Kai Wang
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: dwarf_reset_section_bytes.3 3640 2018-10-14 14:09:13Z jkoshy $
26.\"
27.Dd September 3, 2011
28.Dt DWARF_RESET_SECTION_BYTES 3
29.Os
30.Sh NAME
31.Nm dwarf_reset_section_bytes
32.Nd reset the internal state of a producer instance
33.Sh LIBRARY
34.Lb libdwarf
35.Sh SYNOPSIS
36.In libdwarf.h
37.Ft void
38.Fo dwarf_reset_section_bytes
39.Fa "Dwarf_P_Debug dbg"
40.Fc
41.Sh DESCRIPTION
42Function
43.Fn dwarf_reset_section_bytes
44resets the internal state of a DWARF producer instance, so that the
45next call to the function
46.Xr dwarf_get_section_bytes 3
47will return the byte stream for the first generated section, and
48the next call to the function
49.Xr dwarf_get_relocation_info 3
50will return the first relocation array for the DWARF producer
51instance.
52.Pp
53Argument
54.Ar dbg
55should reference a DWARF producer instance allocated using
56.Xr dwarf_producer_init 3
57or
58.Xr dwarf_producer_init_b 3 .
59.Sh RETURN VALUES
60Function
61.Fn dwarf_reset_section_bytes
62has no return value.
63.Sh SEE ALSO
64.Xr dwarf 3 ,
65.Xr dwarf_get_relocation_info 3 ,
66.Xr dwarf_get_section_bytes 3 ,
67.Xr dwarf_producer_init 3 ,
68.Xr dwarf_producer_init_b 3 ,
69.Xr dwarf_transform_to_disk_form 3
70