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

docs: coding-style: Clarify on virXXXPtr types 

This partially reverts commit 9ccbed6afb.

Signed-off-by: Tim Wiederhake <twiederh@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
This commit is contained in:
Tim Wiederhake 2022-01-11 17:10:43 +01:00
parent 1787a77cf8
commit 95c380d410
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/coding-style.rst
View File

@ -53,11 +53,16 @@ Struct type names
All structs should have a 'vir' prefix in their typedef name, All structs should have a 'vir' prefix in their typedef name,
and each following word should have its first letter in and each following word should have its first letter in
uppercase. The struct name should be the same as the typedef uppercase. The struct name should be the same as the typedef
name with a leading underscore. name with a leading underscore. For types that are part of the
public API, a second typedef should be given for a pointer to
the struct with a 'Ptr' suffix. Do not introduce new such
typedefs for internal types.
:: ::
typedef struct _virHashTable virHashTable; typedef struct _virSomeType virSomeType;
struct _virHashTable { typedef virSomeType *virSomeTypePtr;
struct _virSomeType {
... ...
}; };
@ -69,8 +74,8 @@ Function names
name prefix should match the object typedef name, otherwise it name prefix should match the object typedef name, otherwise it
should match the filename. Following this comes the verb / should match the filename. Following this comes the verb /
action name, and finally an optional subject name. For example, action name, and finally an optional subject name. For example,
given an object 'virHashTable', all functions should have a given an object 'virSomeType', all functions should have a
name 'virHashTable$VERB' or 'virHashTable$VERB$SUBJECT", e.g. name 'virSomeType$VERB' or 'virSomeType$VERB$SUBJECT", e.g.
'virHashTableLookup' or 'virHashTableGetValue'. 'virHashTableLookup' or 'virHashTableGetValue'.
Macro names Macro names