public inbox for libabigail@sourceware.org
 help / color / mirror / Atom feed
From: Dodji Seketeli <dodji@seketeli.org>
To: Xiaole He via Libabigail <libabigail@sourceware.org>
Cc: Xiaole He <hexiaole1994@126.com>,  Xiaole He <hexiaole@kylinos.cn>
Subject: Re: [PATCH] abg-reader: fix comment of function
Date: Tue, 20 Sep 2022 10:22:46 +0200	[thread overview]
Message-ID: <875yhi78vd.fsf@seketeli.org> (raw)
In-Reply-To: <20220919100350.9661-1-hexiaole1994@126.com> (Xiaole He via Libabigail's message of "Mon, 19 Sep 2022 18:03:50 +0800")

Hello,

Xiaole He via Libabigail <libabigail@sourceware.org> a écrit:

> 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

Thanks for catching that typo!  You are spot on!

I've applied the patch to the master branch.

[...]

Cheers,

-- 
		Dodji

  reply	other threads:[~2022-09-20  8:22 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-19 10:03 Xiaole He
2022-09-20  8:22 ` Dodji Seketeli [this message]
2022-09-20  9:10   ` Xiaole He

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=875yhi78vd.fsf@seketeli.org \
    --to=dodji@seketeli.org \
    --cc=hexiaole1994@126.com \
    --cc=hexiaole@kylinos.cn \
    --cc=libabigail@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).