External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-22 04:25:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Use definition list instead of table in coding style

Browse Source 
This format is much easier to tweak and update.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Andrea Bolognani 2020-05-07 14:38:35 +02:00
parent 842d3712ed
commit f42be8a2ef
1 changed files with 26 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
docs/coding-style.rst
View File

@ -547,27 +547,32 @@ Attribute annotations
Use the following annotations to help the compiler and/or static Use the following annotations to help the compiler and/or static
analysis tools understand the code better: analysis tools understand the code better:
+-------------------------------+------------------------------------------------------------+ ``ATTRIBUTE_NONNULL``
| Macro | Meaning | passing NULL for this parameter is not allowed
+===============================+============================================================+
| ``ATTRIBUTE_NONNULL`` | passing NULL for this parameter is not allowed | ``ATTRIBUTE_PACKED``
+-------------------------------+------------------------------------------------------------+ force a structure to be packed
| ``ATTRIBUTE_PACKED`` | force a structure to be packed |
+-------------------------------+------------------------------------------------------------+ ``G_GNUC_FALLTHROUGH``
| ``G_GNUC_FALLTHROUGH`` | allow code reuse by multiple switch cases | allow code reuse by multiple switch cases
+-------------------------------+------------------------------------------------------------+
| ``G_GNUC_NO_INLINE`` | the function is mocked in the test suite | ``G_GNUC_NO_INLINE``
+-------------------------------+------------------------------------------------------------+ the function is mocked in the test suite
| ``G_GNUC_NORETURN`` | the function never returns |
+-------------------------------+------------------------------------------------------------+ ``G_GNUC_NORETURN``
| ``G_GNUC_NULL_TERMINATED`` | last parameter must be NULL | the function never returns
+-------------------------------+------------------------------------------------------------+
| ``G_GNUC_PRINTF`` | validate that the formatting string matches parameters | ``G_GNUC_NULL_TERMINATED``
+-------------------------------+------------------------------------------------------------+ last parameter must be NULL
| ``G_GNUC_UNUSED`` | parameter is unused in this implementation of the function |
+-------------------------------+------------------------------------------------------------+ ``G_GNUC_PRINTF``
| ``G_GNUC_WARN_UNUSED_RESULT`` | the return value must be checked | validate that the formatting string matches parameters
+-------------------------------+------------------------------------------------------------+
``G_GNUC_UNUSED``
parameter is unused in this implementation of the function
``G_GNUC_WARN_UNUSED_RESULT``
the return value must be checked
File handling File handling
------------- -------------