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

[Daniel P. Berrangé]

On Fri, Jan 14, 2022 at 09:24:23AM -0800, Andrea Bolognani wrote:
> On Fri, Jan 14, 2022 at 04:43:58PM +0100, Ján Tomko wrote:
> > On a Friday in 2022, Tim Wiederhake wrote:
> > > +   Historically, libvirt declared pointer types 'virXXXPtr' for
> > > +   both public and internal types. Do not introduce new such
> > > +   typedefs for internal types.
> >
> > This weakly suggests that they should be introduced for new public
> > types. I have no preference, but I think we should mention it here
> > if we're mentioning internal types.
> 
> Agreed. More specifically, I think we should encourage defining the
> Ptr alias for public types because, much as I dislike their
> existence, having a mix of both conventions in the public API would
> be IMO worse than sticking with the status quo.

Yes, the public API must carry on using its existing practice. Only
the internal usage is eliminated.

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|