Skip to content

Commit

Permalink
Add docs and CHANGES for C changes
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobandersen committed Jul 14, 2020
1 parent 91f4af5 commit 18b00d8
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Incompatible changes
Deprecated
----------

* C, parsing of pre-v3 style type directives and roles, along with the options
:confval:`c_allow_pre_v3` and :confval:`c_warn_on_allowed_pre_v3`.

Features added
--------------

Expand All @@ -24,6 +27,12 @@ Features added
* #7052: add ``:noindexentry:`` to the Python, C, C++, and Javascript domains.
Update the documentation to better reflect the relationship between this option
and the ``:noindex:`` option.
* #7899: C, add possibility of parsing of some pre-v3 style type directives and
roles and try to convert them to equivalent v3 directives/roles.
Set the new option :confval:`c_allow_pre_v3` to ``True`` to enable this.
The warnings printed from this functionality can be suppressed by setting
:confval:`c_warn_on_allowed_pre_v3`` to ``True``.
The functionality is immediately deprecated.

Bugs fixed
----------
Expand Down
17 changes: 17 additions & 0 deletions doc/usage/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2545,6 +2545,23 @@ Options for the C domain

.. versionadded:: 3.0

.. confval:: c_allow_pre_v3

A boolean (default ``False``) controlling whether to parse and try to
convert pre-v3 style type directives and type roles.

.. versionadded:: 3.2
.. deprecated:: 3.2
Use the directives and roles added in v3.

.. confval:: c_warn_on_allowed_pre_v3

A boolean (default ``True``) controlling whether to warn when a pre-v3
style type directive/role is parsed and converted.

.. versionadded:: 3.2
.. deprecated:: 3.2
Use the directives and roles added in v3.

.. _cpp-config:

Expand Down

0 comments on commit 18b00d8

Please sign in to comment.