openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

coding-style: Don't encourage virXXXPtr typedefs 

We don't like virXXXPtr typedefs really and they are going away
shortly, possibly. Do not encourage new code to put in the
typedefs.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Michal Privoznik 2021-03-15 18:49:45 +01:00
parent 53454b7b34
commit 9ccbed6afb
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/coding-style.rst
View File

@ -53,13 +53,10 @@ Struct type names
All structs should have a 'vir' prefix in their typedef name,
and each following word should have its first letter in
uppercase. The struct name should be the same as the typedef
name with a leading underscore. A second typedef should be
given for a pointer to the struct with a 'Ptr' suffix.
name with a leading underscore.
::
typedef struct _virHashTable virHashTable;
typedef virHashTable *virHashTablePtr;
struct _virHashTable {
...
};
@ -426,11 +423,11 @@ Conditional expressions
For readability reasons new code should avoid shortening
comparisons to 0 for numeric types. Boolean and pointer
comparisions may be shortened. All long forms are okay:
comparisons may be shortened. All long forms are okay:
::
virFooPtr foos = NULL;
virFoo *foos = NULL;
size nfoos = 0;
bool hasFoos = false;