public inbox for libabigail@sourceware.org
 help / color / mirror / Atom feed
* [PATCH] abg-reader: fix comment of function
@ 2022-09-19 10:03 Xiaole He
  2022-09-20  8:22 ` Dodji Seketeli
  0 siblings, 1 reply; 2+ messages in thread
From: Xiaole He @ 2022-09-19 10:03 UTC (permalink / raw)
  To: libabigail; +Cc: Xiaole He, Xiaole He

In 'src/abg-reader.cc', the function
'walk_xml_node_to_map_type_ids(read_context& ctxt, xmlNodePtr node)'
find all of the child nodes of 'node' that has the 'id' attribute,
and then put the child node into map where the 'id' of the child node
as key and the child node itself as the value.
But the comment for this function writes:
/* src/abg-reader.cc begin */
/// Walk an entire XML sub-tree to build a map where the key is the
/// the value of the 'id' attribute (for type definitions) and the key
/// is the xml node containing the 'id' attribute.
...
static void
walk_xml_node_to_map_type_ids(read_context& ctxt,
                              xmlNodePtr node)
...
/* src/abg-reader.cc end */
The second and third lines of the comment above says the the child node
as the key of the map, but it should be the value of the map.
This patch fix the problematic comment described above, from
'and the key is the xml node' to 'and the value is the xml node'.

        * src/abg-reader.cc (walk_xml_node_to_map_type_ids): fix comment

Signed-off-by: Xiaole He <hexiaole@kylinos.cn>
---
 src/abg-reader.cc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/abg-reader.cc b/src/abg-reader.cc
index be2b8c13..b6372e50 100644
--- a/src/abg-reader.cc
+++ b/src/abg-reader.cc
@@ -1538,7 +1538,7 @@ advance_cursor(read_context& ctxt)
 }
 
 /// Walk an entire XML sub-tree to build a map where the key is the
-/// the value of the 'id' attribute (for type definitions) and the key
+/// the value of the 'id' attribute (for type definitions) and the value
 /// is the xml node containing the 'id' attribute.
 ///
 /// @param ctxt the context of the reader.
-- 
2.27.0


^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2022-09-20  8:22 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-09-19 10:03 [PATCH] abg-reader: fix comment of function Xiaole He
2022-09-20  8:22 ` Dodji Seketeli

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).