[PATCH v4 00/19] Add 'version' to other exported types

[Victor Toso]

Hi,

On Tue, Apr 26, 2022 at 04:06:08PM +0000, Andrea Bolognani wrote:
> On Fri, Apr 22, 2022 at 09:23:25PM +0200, Victor Toso wrote:
> > - For exported version of functions, the syms file are the source of
> >   truth apart from 4 functions (Peter)
> >   https://listman.redhat.com/archives/libvir-list/2022-April/230236.html
> >
> > - Variable's comments are now properly sanitized (Andrea)
> >   https://listman.redhat.com/archives/libvir-list/2022-April/230352.html
> >
> > - Removed an extra line in the block of comments (Andrea)
> >   https://listman.redhat.com/archives/libvir-list/2022-April/230291.html
> 
> Pushed the remaining patches as well. Thanks a lot for tackling this!

Thank you for your careful review and fixes.

> Ideas for follow-up work:
> 
>   * improve the generator so that multi-line comments attached to
>     enum values and macros get all newlines stripped before ending up
>     in the XML. Right now it's done very inconsistently;
> 
>   * include version information in the HTML documentation;
> 
>   * whatever can be done to make apibuild.py at least somewhat sane :)

Would you mind opening an issue for those and cc me there? I
don't mind working on it later on.

> One more thing. Right now version tags look like
> 
>   Since: v1.2.3
> 
> but the "v" part doesn't really need to be there IMO, and in fact it
> has to be stripped when generating the XML. How would you feel about
> not having it in the documentation in the first place?

IIRC, I used the 'v' because it was easier to write match
patterns with the leading 'v' but was considering removing as
well.  I don't mind stripping it.

Another suggestion of mine, was adding other metadata tags to the
documentation, for example, @deprecated: <version>, or info
related to APIs that might be hypervisor specific... don't know.

Cheers,
Victor
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20220426/186f227c/attachment.sig>