libctf: add a comment explaining how to use ctf_*open
authorNick Alcock <nick.alcock@oracle.com>
Thu, 21 Apr 2022 20:45:21 +0000 (21:45 +0100)
committerNick Alcock <nick.alcock@oracle.com>
Thu, 28 Apr 2022 10:47:11 +0000 (11:47 +0100)
commit44c70fb01ff2ec9bced4676cdde0fa7e49328003
tree7d5f9908c32960c1bca67c8bd2ae29f8826501bd
parent0e12331a9bf980f24e6fe4aa1b22b431950883ba
libctf: add a comment explaining how to use ctf_*open

Specifically, tell users what to pass to those functions that accept raw
section content, since it's fairly involved and easy to get wrong.
(.dynsym / .dynstr when CTF_F_DYNSTR is set, otherwise .symtab / .strtab).

include/ChangeLog:

* ctf-api.h (ctf_*open): Improve comment.
include/ctf-api.h