Skip to content

Commit 7327109

Browse files
committed
Clarifying aspects/detail of the library.
modified: doc/jitaccess.dox modified: doc/libdwarf.dox
1 parent 7a903fb commit 7327109

File tree

2 files changed

+120
-103
lines changed

2 files changed

+120
-103
lines changed

doc/jitaccess.dox

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
local arrays
2828
@see jitreader
2929

30-
But the libdwarf feature can be useful in a variety of
30+
But the @e libdwarf feature can be useful in a variety of
3131
circumstances.
3232

3333
For example, the DWARF data were kept
@@ -47,18 +47,18 @@
4747
a small handful of functions and supply
4848
function pointers and code implementing the
4949
functions. These are part of your application
50-
or library, not part of libdwarf.
50+
or library, not part of @e libdwarf.
5151
Your code accesses the data in whatever way
5252
applies and you write code that provides
53-
the interfaces so standard libdwarf can access
53+
the interfaces so standard @e libdwarf can access
5454
your DWARF content.
5555

5656
You set up a little bit of data with that code
5757
(described below)
5858
and then you have essentially written the
5959
dwarf_init_path equivalent and you can access
6060
compilation units, line tables etc and
61-
the standard libdwarf function calls simply work.
61+
the standard @e libdwarf function calls simply work.
6262

6363
Data you need to create involves the following types.
6464
What follows describes how to fill them in
@@ -126,7 +126,7 @@
126126

127127
@b ai_object
128128

129-
Allocate a local struct (libdwarf will not
129+
Allocate a local struct (@e libdwarf will not
130130
touch this struct and will not know
131131
anything of its contents). You will need one
132132
of these for each Dwarf_Debug you open.
@@ -150,10 +150,10 @@
150150
@b Dwarf_Obj_Access_Section_a:
151151

152152
The set of fields here is a set that is sufficient
153-
to describe a single object section to libdwarf.
153+
to describe a single object section to @e libdwarf.
154154
Your implementation of a @b om_get_section_info
155155
must simply fill in a few fields (leaving most zero)
156-
for libdwarf for the section indexed.
156+
for @e libdwarf for the section indexed.
157157
The fields here are standard Elf,
158158
and for most you can just fill in the value zero.
159159
For section index zero as_name should be set to
@@ -174,7 +174,7 @@
174174
@b as_offset: Just fill in zero.
175175

176176
@b as_size: Fill in the size, in bytes,
177-
of the section you are telling libdwarf about.
177+
of the section you are telling @e libdwarf about.
178178

179179
@b as_link: Just fill in zero.
180180

@@ -188,7 +188,7 @@
188188

189189
@b struct Dwarf_Obj_Access_Methods_a_s:
190190

191-
The functions libdwarf needs to access object data
191+
The functions @e libdwarf needs to access object data
192192
are declared here.
193193
Usually the struct is statically defined
194194
and the function pointers are set at
@@ -201,15 +201,15 @@
201201
which is a struct you define to hold data you need
202202
to implement this set of functions. You refer to
203203
it
204-
When libdwarf calls your set of functions (these
204+
When @e libdwarf calls your set of functions (these
205205
described now) it passes the ai_object pointer
206206
you provided to these functions as @b obj parameter .
207207

208-
This is the final part of your work for libdwarf.
208+
This is the final part of your work for @e libdwarf.
209209
In the source file with your code you will be
210210
allocating data, making a provision for
211211
an array (real or conceptual) for per-section data,
212-
and returning values libdwarf needs.
212+
and returning values @e libdwarf needs.
213213
Note that the section array should include
214214
an index zero with all zero field values.
215215
That means interesting fields start with index one.
@@ -240,7 +240,7 @@
240240
Return
241241
DW_DLV_OK - Everything ok.
242242
DW_DLV_ERROR - Error occurred. Use 'error' to determine the
243-
libdwarf defined error.
243+
@e libdwarf defined error.
244244
DW_DLV_NO_ENTRY - No such section.
245245
@endcode
246246

@@ -268,7 +268,7 @@
268268

269269
@code
270270
Get the size of a length field in the underlying object file.
271-
libdwarf currently supports * 4 and 8 byte sizes, but may
271+
@e libdwarf currently supports * 4 and 8 byte sizes, but may
272272
support larger in the future.
273273
Perhaps the return type should be an enumeration?
274274

@@ -286,7 +286,7 @@
286286

287287
@code
288288
Get the size of a pointer field in the underlying object file.
289-
libdwarf currently supports 4 and 8 byte sizes.
289+
@e libdwarf currently supports 4 and 8 byte sizes.
290290
Perhaps the return type should be an enumeration?
291291

292292
Return
@@ -303,9 +303,9 @@
303303
obj - Your data
304304

305305
Return
306-
Must return a value at least as large as any section libdwarf
306+
Must return a value at least as large as any section @e libdwarf
307307
might read. Returns a value that is a sanity check on
308-
offsets libdwarf reads for this DWARF set. It need not be
308+
offsets @e libdwarf reads for this DWARF set. It need not be
309309
a tight bound.
310310
@endcode
311311

0 commit comments

Comments
 (0)