[libvirt PATCH v2 1/2] docs: coding-style: Clarify on virXXXPtr types

Tim Wiederhake twiederh at redhat.com
Mon Jan 17 10:19:02 UTC 2022

This partially reverts commit 9ccbed6afb.

Signed-off-by: Tim Wiederhake <twiederh at redhat.com>
 docs/coding-style.rst | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/coding-style.rst b/docs/coding-style.rst
index 37e6009db4..ee4d551805 100644
--- a/docs/coding-style.rst
+++ b/docs/coding-style.rst
@@ -53,10 +53,15 @@ 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.
+   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 virHashTable *virHashTablePtr;
      struct _virHashTable {

More information about the libvir-list mailing list