On Wed, Dec 09, 2020 at 10:50:29AM +0000, Alex Bennée wrote:
>
> Claudio Fontana <cfont...@suse.de> writes:
>
> > From: Eduardo Habkost <ehabk...@redhat.com>
> >
> > Signed-off-by: Eduardo Habkost <ehabk...@redhat.com>
> > [claudio: wrapped in CONFIG_TCG]
> > Signed-off-by: Claudio Fontana <cfont...@suse.de>
> > Reviewed-by: Philippe Mathieu-Daudé <phi...@redhat.com>
> > ---
[...]
> > @@ -20,6 +17,17 @@ typedef struct TcgCpuOperations {
> > * Called when the first CPU is realized.
> > */
> > void (*initialize)(void);
> > + /**
> > + * @synchronize_from_tb: Synchronize state from a TCG #TranslationBlock
> > + *
> > + * This is called when we abandon execution of a TB before
> > + * starting it, and must set all parts of the CPU state which
> > + * the previous TB in the chain may not have updated. This
> > + * will need to do more. If this hook is not implemented then
> > + * the default is to call
> > + * @set_pc(tb->pc).
> > + */
>
> We could clean-up the comment here to better fit the javadoc style API
> documentation format, i.e.:
>
> /**
> * synchronize_from_tb: Synchronize current TCG execution state
> * @cpu: current cpu
> * @tb: about to be executed #TranslationBlock
> *
> * This is called when we abandon execution of a TB before
> * starting it, and must set all parts of the CPU state which
> * the previous TB in the chain may not have updated. This
> * will need to do more. If this hook is not implemented then
> * the default is to call @set_pc(tb->pc).
> */
Would this work with kernel-doc? This will be parsed as a
portion of the documentation of struct TcgCpuOperations, so I was
not expecting kernel-doc to treat the "@cpu: ..." and "@tb: ..."
lines as valid.
--
Eduardo
