Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-21 Thread Richard Henderson
On 01/21/2015 10:12 AM, Bastian Koppelmann wrote: > Richard, before I put too much work into this. Are you happy with the general > direction of this documentation? Yes. r~

Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-21 Thread Bastian Koppelmann
On 01/14/2015 03:51 PM, Bastian Koppelmann wrote: There is no overview, that shows all the frontend operation one can use, as found on the wiki. Unfortunatly the wiki is out of date, so let's try to move this documentation to the source files, which has the benefit, that it is easy to update the

Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-15 Thread Lluís Vilanova
Richard Henderson writes: > On 01/14/2015 10:15 AM, Lluís Vilanova wrote: >> Sorry I wasn't clear. I meant that it might be better to remove tcg/README >> and >> instead document all the operations (those in the readme and the additional >> ones) in the header. > If we did that, it would go some

Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-14 Thread Richard Henderson
On 01/14/2015 10:15 AM, Lluís Vilanova wrote: > Sorry I wasn't clear. I meant that it might be better to remove tcg/README and > instead document all the operations (those in the readme and the additional > ones) in the header. If we did that, it would go somewhere else. There are two different (

Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-14 Thread Peter Maydell
On 14 January 2015 at 18:15, Lluís Vilanova wrote: > Sorry I wasn't clear. I meant that it might be better to remove tcg/README and > instead document all the operations (those in the readme and the additional > ones) in the header. I think the IR is worth documenting in itself, rather than mergi

Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-14 Thread Lluís Vilanova
Bastian Koppelmann writes: > On 01/14/2015 03:36 PM, Lluís Vilanova wrote: >> Bastian Koppelmann writes: >> >>> There is no overview, that shows all the frontend operation one can use, as >>> found on the wiki. Unfortunatly the wiki is out of date, so let's try to >>> move >>> this documentation

Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-14 Thread Bastian Koppelmann
On 01/14/2015 03:51 PM, Bastian Koppelmann wrote: There is no overview, that shows all the frontend operation one can use, as found on the wiki. Unfortunatly the wiki is out of date, so let's try to move this documentation to the source files, which has the benefit, that it is easy to update the

Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-14 Thread Bastian Koppelmann
On 01/14/2015 04:55 PM, Thomas Huth wrote: On Wed, 14 Jan 2015 16:36:26 +0100 Lluís Vilanova wrote: ... Also, AFAIR it was decided to use gtk-doc instead of doxygen. If there's a consensus about which source code documentation style should be used for QEMU, could you (or somebody else) maybe

Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-14 Thread Bastian Koppelmann
On 01/14/2015 03:36 PM, Lluís Vilanova wrote: Bastian Koppelmann writes: There is no overview, that shows all the frontend operation one can use, as found on the wiki. Unfortunatly the wiki is out of date, so let's try to move this documentation to the source files, which has the benefit, that

Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-14 Thread Thomas Huth
On Wed, 14 Jan 2015 16:36:26 +0100 Lluís Vilanova wrote: ... > > Also, AFAIR it was decided to use gtk-doc instead of doxygen. If there's a consensus about which source code documentation style should be used for QEMU, could you (or somebody else) maybe add an appropriate paragraph to the CODING

Re: [Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-14 Thread Lluís Vilanova
Bastian Koppelmann writes: > There is no overview, that shows all the frontend operation one can use, as > found on the wiki. Unfortunatly the wiki is out of date, so let's try to move > this documentation to the source files, which has the benefit, that it is easy > to update the documentation, i

[Qemu-devel] [PATCH] tcg: Add doxygen documentation to the tcg frontend

2015-01-14 Thread Bastian Koppelmann
There is no overview, that shows all the frontend operation one can use, as found on the wiki. Unfortunatly the wiki is out of date, so let's try to move this documentation to the source files, which has the benefit, that it is easy to update the documentation, if the frontend is changed. This patc