[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: [libvirt] [PATCH 0/2] docs: Fix enum documentation



On Sun, Jul 23, 2017 at 11:16:21PM +0200, Tomáš Golembiovský wrote:
On Sat, 22 Jul 2017 11:04:32 +0200
Michal Privoznik <mprivozn redhat com> wrote:

So this patch sent to the list got me roll up my sleeves and get working:

https://www.redhat.com/archives/libvir-list/2017-July/msg00835.html

It wasn't that bad after all.


Thanks for giving it a try!

There is a slight progress, if we can call it so, but we're not there
yet. Looking at the generated docs for virDomainMemoryStatTags, there is
an issue, although different from the original.

The comment for VIR_DOMAIN_MEMORY_STAT_SWAP_IN is now picked up
correctly. But VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT has now the comment
that belongs to VIR_DOMAIN_MEMORY_STAT_UNUSED.


Yeah, it doesn't fix everything, but thankfully it is strictly better
than before.

Reviewed-by: Martin Kletzander <mkletzan redhat com>

What Tomas is explaining here looks like a problem with parsing or
cleaning up the comments.  It happens when there is a multiline comment
for one enum value and the next one does not have any.  I tried looking
at the code yet again and it hurts my brain.  But I'd still rather fix
that than just work around it (add missing comments where it doesn't
make much sense).

   Tomas

Michal Privoznik (2):
  apibuild.py: Handle enum comments properly
  docs: Span cells if there's not doc text for enum val

 docs/apibuild.py |  8 +++++++-
 docs/newapi.xsl  | 25 +++++++++++++++----------
 2 files changed, 22 insertions(+), 11 deletions(-)

--
2.13.0



--
Tomáš Golembiovský <tgolembi redhat com>

--
libvir-list mailing list
libvir-list redhat com
https://www.redhat.com/mailman/listinfo/libvir-list

Attachment: signature.asc
Description: Digital signature


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]