Skip to content

Commit 44b1189

Browse files
committed
Refining the wording about GNU debuglink.
modified: doc/checkexamples.c modified: src/lib/libdwarf/libdwarf.h
1 parent 416d9da commit 44b1189

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

doc/checkexamples.c

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2014,7 +2014,12 @@ void examplezb(void)
20142014
}
20152015
}
20162016

2017-
/* @brief exampledebuglink An example useing debuglink
2017+
/*! @defgroup exampledebuglink Example using GNU debuglink
2018+
@brief exampledebuglink Showing dwarf_add_debuglink_global_path
2019+
2020+
An example using both dwarf_add_debuglink_global_path
2021+
and dwarf_gnu_debuglink .
2022+
@code
20182023
*/
20192024
int exampledebuglink(Dwarf_Debug dbg, Dwarf_Error* error)
20202025
{
@@ -2089,6 +2094,8 @@ int exampledebuglink(Dwarf_Debug dbg, Dwarf_Error* error)
20892094
free(paths);
20902095
return DW_DLV_OK;
20912096
}
2097+
/*! @endcode */
2098+
20922099
int example_raw_rnglist(Dwarf_Debug dbg,Dwarf_Error *error)
20932100
{
20942101
Dwarf_Unsigned count = 0;

src/lib/libdwarf/libdwarf.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6600,9 +6600,14 @@ DW_API int dwarf_weak_name_offsets(Dwarf_Weak dw_weak,
66006600
Dwarf_Off * dw_cu_offset,
66016601
Dwarf_Error* dw_error);
66026602
/*! @brief A flag for dwarfdump on pubnames, pubtypes etc.
6603+
66036604
Sets a flag in the dbg. Always returns DW_DLV_OK
66046605
and never touches error. The error argument should
6605-
be deleted. Applies to all the sections of this sort.
6606+
be deleted. Applies to all the sections of this kind:
6607+
pubnames, pubtypes, funcs, typenames,vars, weaks.
6608+
Ensures empty content (meaning no
6609+
offset/name tuples) for a CU shows up rather than
6610+
being suppressed.
66066611
66076612
@link dw_pubnames Pubnames and Pubtypes overview @endlink
66086613
@@ -6614,7 +6619,6 @@ DW_API int dwarf_weak_name_offsets(Dwarf_Weak dw_weak,
66146619
Unused,
66156620
@return
66166621
Returns DW_DLV_OK. Always.
6617-
66186622
*/
66196623
DW_API int dwarf_return_empty_pubnames(Dwarf_Debug dw_dbg,
66206624
int dw_flag,
@@ -6879,6 +6883,7 @@ DW_API int dwarf_get_debugfission_for_key(Dwarf_Debug /*dbg*/,
68796883
.gnu_debuglink and/or the section .note.gnu.build-id.
68806884
68816885
@see https://sourceware.org/gdb/onlinedocs/gdb/Separate-Debug-Files.html
6886+
68826887
@see exampledebuglink
68836888
68846889
If no debuglink then name_returned,crc_returned and

0 commit comments

Comments
 (0)