libctf: fix comment above ctf_dict_t

It is perfectly possible to have dynamically allocated data owned by a
specific dict: you just have to teach ctf_serialize about it.

libctf/ChangeLog
2021-03-18  Nick Alcock  <nick.alcock@oracle.com>

	* ctf-impl.h (ctf_dict_t): Fix comment.

diff --git a/libctf/ChangeLog b/libctf/ChangeLog
index bd2563da18edade56ebfb4e9c561c67559ba38a2..58c0ed434fffa7e5238a266738eee0ccd6f54bdd 100644 (file)
--- a/libctf/ChangeLog
+++ b/libctf/ChangeLog
@@ -1,3 +1,7 @@
+2021-03-18  Nick Alcock  <nick.alcock@oracle.com>
+
+       * ctf-impl.h (ctf_dict_t): Fix comment.
+
 2021-03-18  Nick Alcock  <nick.alcock@oracle.com>
 
        * ctf-create.c (symtypetab_delete_nonstatic_vars): Move

diff --git a/libctf/ctf-impl.h b/libctf/ctf-impl.h
index 78a41ff49321ad53c89648d2b6c223baee76cdd3..5567b4c61f5106e11f0d17eb04863212e7abdb07 100644 (file)
--- a/libctf/ctf-impl.h
+++ b/libctf/ctf-impl.h
@@ -372,11 +372,12 @@ typedef struct ctf_dedup
    ctf_dict_t typedef appears in <ctf-api.h> and declares a forward tag.
    (A ctf_file_t typedef also appears there, for historical reasons.)
 
-   NOTE: ctf_serialize() requires that everything inside of ctf_dict either be
-   an immediate value, a pointer to dynamically allocated data *outside* of the
-   ctf_dict itself, or a pointer to statically allocated data.  If you add a
-   pointer to ctf_dict that points to something within the ctf_dict itself, you
-   must make corresponding changes to ctf_serialize().  */
+   NOTE: ctf_serialize requires that everything inside of ctf_dict either be an
+   immediate value, a pointer to dynamically allocated data *outside* of the
+   ctf_dict itself, a pointer to statically allocated data, or specially handled
+   in ctf_serialize.  If you add a pointer to ctf_dict that points to something
+   within the ctf_dict itself, you must make corresponding changes to
+   ctf_serialize.  */
 
 struct ctf_dict
 {