Skip to content

Commit d2b8e43

Browse files
committed
Document __va_list_tag declarations in FAQ
1 parent 0824744 commit d2b8e43

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/faq.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,20 @@ Some things you may try (in order of priority):
4545

4646
3) If you want to cache the declarations tree, there is a caching mechanism provided
4747
by pygccxml. You will find an example of this mechanism in the examples section.
48+
49+
50+
\_\_va_list_tag and other hidden declarations
51+
---------------------------------------------
52+
53+
When parsing with CastXML, the XML tree can contain declarations named
54+
``__va_list_tag``. If the compiler is llvm 3.9, ``__NSConstantString_tag``
55+
and ``__NSConstantString`` declarations may also be present.
56+
57+
These declarations are internal declarations, coming from the std c++ library
58+
headers you include, and are often not needed. They are for example polluting
59+
the declarations tree when running pyplusplus.
60+
61+
By default, pygccxml will ignore these declarations.
62+
To still read these declarations from the xml file, a config flag can
63+
be set (``config.flags = ["f1"]``), or a flag can be passed as argument the
64+
config setup (``flags=["f1"]``).

0 commit comments

Comments
 (0)