Adding more information about the structure of the data returned by `…

…Inspector.lookup()`. Signed-off-by: Andre Holzner <[email protected]>
libbpf · Sep 5, 2024 · 5e9d8cb · 5e9d8cb
1 parent b170887
commit 5e9d8cb
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/inspect/inspector.rs b/src/inspect/inspector.rs
@@ -69,6 +69,10 @@ impl Inspector {
     /// Look up information (address etc.) about a list of symbols,
     /// given their names.
     ///
+    /// On success, this returns a vector of vectors of symbol information.
+    /// For each symbol name, a vector of addresses is returned, i.e. a given
+    /// symbol name can correspond to more than one address.
+    ///
     /// # Notes
     /// - no symbol name demangling is performed currently
     /// - for the [`Breakpad`](Source::Breakpad) source: