Skip to content

Commit 264bdec

Browse files
committed
Finalise changelog for version 1.7.0
1 parent 7c198ff commit 264bdec

File tree

1 file changed

+46
-29
lines changed

1 file changed

+46
-29
lines changed

docs/history.rst

Lines changed: 46 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ to python 3 (keeping it compatible with python 2).
1111
In Mai 2014, Michka Popoff and the Insight Software Consortium revived pygccxml
1212
by setting up a git repositery on github, hosted along with gccxml.
1313

14-
Version 1.7.0 (Next version, not yet released)
15-
----------------------------------------------
14+
Version 1.7.0
15+
-------------
1616

1717
1. Added support for CastXML (https://github.com/CastXML/CastXML)
1818

@@ -38,60 +38,77 @@ Version 1.7.0 (Next version, not yet released)
3838
xml_generator=generator_name,
3939
)
4040
41-
4. [CastXML] The compiler path can now be passed down to castxml.
41+
``gccxml_configuration_t`` is an alias of ``xml_generator_configuration_t``.
42+
43+
``load_gccxml_configuration`` is an alias of ``load_xml_generator_configuration``.
44+
45+
Both can still be used but will be deprecated.
46+
47+
4. [CastXML] The compiler path can be passed to castxml.
48+
4249
This is done by using the ``compiler_path`` attribute in the configuration.
43-
Note that this may be important because the resulting xml file may be
44-
slightly different depending on the compiler used.
50+
Note that this may be important because the resulting xml file is slightly different
51+
depending on the used compiler.
52+
53+
5. [CastXML] Add support for some fields which have no location.
4554

46-
5. [CastXML] Add support for some fields which have no location (see #19)
55+
These fields are: ``gp_offset``, ``fp_offset``, ``overflow_arg_area``, ``reg_save_area``
4756

48-
6. [CastXML] Mangled names are only available for functions and variables
49-
with CastXML. Getting the mangled attribute on a ``declaration`` will fail.
57+
6. [CastXML] Mangled names are only available for functions and variables with CastXML.
58+
59+
Getting the mangled attribute on a ``declaration`` will fail.
5060

5161
7. [CastXML] Demangled names are not available.
52-
Getting the demangled name will fail.
62+
63+
Getting a demangled name will fail.
5364

5465
8. [CastXML] Add new container traits:
55-
``unordered maps``, ``unordered sets``, ``multimaps``, ``multisets``
5666

57-
9. [CastXML] Instead of using the ``__attribute((gccxml("string")))`` c++ syntax
58-
(see version 0.9.5), the ``__attribute__`` ((annotate ("out"))) can now be used
59-
to annotate code with CastXML.
67+
``unordered maps``, ``unordered sets``, ``multimaps``, ``multisets``
68+
69+
9. [CastXML] Annotations:
70+
71+
Instead of using the ``__attribute((gccxml("string")))`` c++ syntax (see version 0.9.5), the ``__attribute__`` ((annotate ("out"))) can now be used to annotate code with CastXML.
6072

6173
10. [CastXML] Disabled relinking of:
6274

6375
.. code-block:: python
6476
6577
rebind<std::__tree_node<std::basic_string<char>, void *> >
6678
67-
This made the ``find_container_traits_tester`` unit tests fail with ``CastXML``.
68-
This class defintion is present in clangs AST tree, but I don't know why it is
69-
usefull. Please tell us if you need so we can re-enable that featur in pygccxml.
79+
This made the ``find_container_traits_tester`` unit tests fail with ``CastXML``.
80+
This class defintion is present in clangs AST tree, but I don't know why it is
81+
usefull. Please tell us if you need it so we can re-enable that featur in pygccxml.
7082

71-
11. Deprecated the ``compiler`` attribute and replaced it with global ``utils.xml_generator`` variable.
83+
11. Deprecated the ``compiler`` attribute and replaced it with a global ``utils.xml_generator`` variable.
7284

73-
The ``compiler`` attribute was misleading; it was sometimes confused with
74-
the name and version of the xml generator.
75-
This change also fixes some internal problems with the algorithms cache.
85+
The ``compiler`` attribute was misleading; it was sometimes confused with the name and version of the xml generator.
7686

87+
This change also fixes some internal problems with the algorithms cache.
7788

7889
12. ``declarations.has_trivial_copy`` was defintevely removed.
79-
Please use ``declarations.has_copy_constructor``.
80-
This was deprecated since version 0.9.5.
90+
91+
Please use ``declarations.has_copy_constructor``.
92+
93+
This was deprecated since version 0.9.5.
8194

8295
13. Remove ``gccxml`` logger from logger class (was deprecated).
83-
Please use ``cxx_parser`` instead.
8496

85-
14. Removed ``gccxml_runtime_error_t`` class. This one was probably only used internally.
86-
Please use RuntimeError instead.
97+
Please use ``cxx_parser`` instead.
98+
99+
14. Removed ``gccxml_runtime_error_t`` class. This was only used internally.
100+
101+
Please use a normal ``RuntimeError`` instead.
102+
103+
15. [Misc] Documentation was moved to readthedocs.org
87104

88-
15. [Misc] Add option to keep or not xml files after errors, useful for debugging purposes.
105+
https://readthedocs.org/projects/pygccxml/
89106

90-
16. [Misc] Documentation was moved to readthedocs.org (https://readthedocs.org/projects/pygccxml/)
107+
16. [Misc] Add quantifiedcode check
91108

92-
17. [Misc] Add quantifiedcode check
109+
https://www.quantifiedcode.com/app/project/117af14ef32a455fb7b3762e21083fb3
93110

94-
https://www.quantifiedcode.com/app/project/117af14ef32a455fb7b3762e21083fb3
111+
17. [Misc] Add option to keep xml files after errors, which is useful for debugging purposes.
95112

96113
18. [Misc] Fix new pep8 warnings, clean up and simplify some code and comments
97114

0 commit comments

Comments
 (0)