RepoMirrors/libabigail
1
0
Fork 0
mirror of git://sourceware.org/git/libabigail.git synced 2024-12-18 07:54:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Talk about mandatory properties in suppress_* directives

Browse Source 
The documentation doesn't talk about the mandatory properties in the
suppress_type, suppress_function and suppress_variable sections.

Fixed thus.

	* doc/manuals/libabigail-concepts.rst: Talk about the mandatory
	properties for suppress_type, suppress_function and
	suppress_variable directives.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
This commit is contained in:
Dodji Seketeli 2016-02-11 11:41:42 +01:00
parent 21a85fbbdf
commit 0cb928083d
1 changed files with 38 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/manuals/libabigail-concepts.rst
View File

@ -159,8 +159,18 @@ suppress diff reports for a particular kind of ABI artifact.
``[suppress_type]``
$$$$$$$$$$$$$$$$$$$
This directive suppresses report messages about a type change. The
potential properties of this sections are:
This directive suppresses report messages about a type change.
Note that for the ``[suppress_type]`` directive to work, at least one
of the following properties must be provided:
``name``, ``name_regexp``, ``type_kind``,
``source_location_not_in``, ``source_location_not_regexp``.
If none of the following properties are provided, then the
``[suppression_type]`` directive is simply ignored.
The potential properties of this sections are listed below:
* ``file_name_regexp``
@ -430,7 +440,19 @@ potential properties of this sections are:
$$$$$$$$$$$$$$$$$$$$$$$$
This directive suppresses report messages about changes on a set of
functions. The potential properties of this sections are:
functions.
Note that for the ``[suppress_function]`` directive to work, at least
one of the following properties must be provided:
``label``, ``name``, ``name_regexp``, ``parameter``,
``return_type_name``, ``symbol_name``, ``symbol_name_regexp``,
``symbol_version``, ``symbol_version_regexp``.
If none of the following properties are provided, then the
``[suppression_function]`` directive is simply ignored.
The potential properties of this sections are:
* ``label``
@ -620,7 +642,19 @@ functions. The potential properties of this sections are:
$$$$$$$$$$$$$$$$$$$$$$$$
This directive suppresses report messages about changes on a set of
variables. The potential properties of this sections are:
variables.
Note that for the ``[suppress_variable]`` directive to work, at least
one of the following properties must be provided:
``label``, ``name``, ``name_regexp``, ``symbol_name``,
``symbol_name_regexp``, ``symbol_version``,
``symbol_version_regexp``.
If none of the following properties are provided, then the
``[suppres_variable]`` directive is simply ignored.
The potential properties of this sections are:
* ``label``