Re: Questions regarding debuginfod.h API

2022-04-16 Thread Frank Ch. Eigler via Elfutils-devel
Hi -

> > > My `debuginfod.h` also does not show any (useful) inline API
> > > documentation for most of that file. Could this please be improved?
> > > The doxygen for dwfl is great and can be read directly together with
> > > the code,
> > 
> > As they say, patches welcome. :-) The header contains some curt
> > comments documenting each function.
> 
> Would you be OK with me simply copying over the contents from the man page 
> over to doxygen? Or is there a better process in place to prevent such kind 
> of 
> documentation duplication? I would have expected that the man pages for API 
> documentation are generated from e.g. doxygen which does not seem to be the 
> case here?

Correct, elfutils does not have much API documentation generally.  The
debuginfod parts are a recent addition that buck that trend. :-) I
don't have a strong opinion about doxygen syntax markup or tooling
dependence, per se.  OTOH I would not want to see documentation
duplication or loss of man pages.

- FChE



[COMMITTED] libdw: Remove unused atomics.h include from libdwP.h

2022-04-16 Thread Mark Wielaard
Signed-off-by: Mark Wielaard 
---
 libdw/ChangeLog | 4 
 libdw/libdwP.h  | 1 -
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/libdw/ChangeLog b/libdw/ChangeLog
index 38f3a7e2..631f2f2a 100644
--- a/libdw/ChangeLog
+++ b/libdw/ChangeLog
@@ -1,3 +1,7 @@
+2022-04-16  Mark Wielaard  
+
+   * libdwP.h: Remove atomics.h include.
+
 2022-04-13  Mark Wielaard  
 
* dwarf.h: Add DWARF5 package file section identifiers,
diff --git a/libdw/libdwP.h b/libdw/libdwP.h
index 360ad01a..56b388c1 100644
--- a/libdw/libdwP.h
+++ b/libdw/libdwP.h
@@ -35,7 +35,6 @@
 
 #include 
 #include 
-#include "atomics.h"
 
 
 /* Known location expressions already decoded.  */
-- 
2.30.2