On Tue, Apr 05, 2022 at 05:36:51PM +0200, Victor Toso wrote: > On Tue, Apr 05, 2022 at 04:52:09PM +0200, Michal Prívozník wrote: > > On 4/5/22 13:43, Victor Toso wrote: > > > This patch adds 'version' parameter to the generated XML API for > > > typedefs > > > > > > It'll require, for new additions, to add a comment with the version > > > that the typedef value was added. An example bellow of code diff and > > > the change in the generated XML. > > > > > > Note that the Since tag is removed from the comment as there is a > > > proper field for it in the XML. > > > > > > ```diff > > > --- a/include/libvirt/libvirt-host.h > > > +++ b/include/libvirt/libvirt-host.h > > > @@ -41,6 +41,8 @@ typedef struct _virConnect virConnect; > > > * > > > * a virConnectPtr is pointer to a virConnect private structure, this is the > > > * type used to reference a connection to the Hypervisor in the API. > > > + * > > > + * Since 0.0.1 > > > */ > > > typedef virConnect *virConnectPtr; > > > ``` > > > > I'm not exactly sure why, but this diff in commit message causes my git > > to think this is a broken patch. Maybe it's trying to parse it as an > > actual patch? Funnily enough, there's no problem with 1/4. > > When I send a v2, I'll make both examples above quoted, that is, > prefixed with: " > ". Not sure why I actually used ```diff and > ```xml, gitlab does nothing with it x) I think you can leave the examples out entirely. The "Since x.y.z" comments are already a known quantity, and you're just extending their applicability to more public symbols. -- Andrea Bolognani / Red Hat / Virtualization
