All of lore.kernel.org
 help / color / mirror / Atom feed
From: David Vrabel <david.vrabel@citrix.com>
To: Ian Campbell <ian.campbell@citrix.com>
Cc: xen-devel@lists.xensource.com
Subject: Re: [PATCH 8 of 8 DOCDAY] docs: hypercall: document mmuext_op using Doxygen
Date: Wed, 26 Oct 2011 14:43:08 +0100	[thread overview]
Message-ID: <4EA80E6C.20403@citrix.com> (raw)
In-Reply-To: <78d2ade5f1fc301ad60e.1319634167@cosworth.uk.xensource.com>

On 26/10/11 14:02, Ian Campbell wrote:
> 
> + * An additional MMU hypercall provides an `extended command'
> + * interface. This provides additional functionality beyond the basic
> + * table updating commands. This hypercall is used to perform
> + * additional MMU operations. These include updating cr3 (or just
> + * re-installing it for a TLB flush), requesting various kinds of TLB
> + * flush, flushing the cache, installing a new LDT, or pinning &
> + * unpinning page-table pages (to ensure their reference count doesn’t
> + * drop to zero which would require a revalidation of all entries).

Bullet points linked to the docs for the specific op might be more
useful here (rather than the long comma-separated list).


> +/** \ingroup HYPERVISOR_mmuext_op

Consider using the @{ @} markers to put adjacent items into the same
group rather than having \ingroup for each item.

David

  reply	other threads:[~2011-10-26 13:43 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-10-26 13:02 [PATCH 0 of 8 DOCDAY] setup Doxygen for use with hypercall interface headers Ian Campbell
2011-10-26 13:02 ` [PATCH 1 of 8 DOCDAY] docs: rename python Doxygen files to allow for other Doxygen uses Ian Campbell
2011-10-26 13:02 ` [PATCH 2 of 8 DOCDAY] docs: python: add quotes to PROJECT_NAME Ian Campbell
2011-10-26 13:02 ` [PATCH 3 of 8 DOCDAY] docs: python: strip build directory prefix from python modules Ian Campbell
2011-10-26 13:02 ` [PATCH 4 of 8 DOCDAY] docs: python: run "doxygen -u docs/python.Doxyfile" Ian Campbell
2011-10-26 13:02 ` [PATCH 5 of 8 DOCDAY] docs: hypercall: initial autogenerated version of hypercall.Doxyfile Ian Campbell
2011-10-26 13:02 ` [PATCH 6 of 8 DOCDAY] docs: hypercall: tailor doxygen configuration and hook into build Ian Campbell
2011-10-26 13:02 ` [PATCH 7 of 8 DOCDAY] docs: hypercall: generate docs for latest API Ian Campbell
2011-10-26 13:02 ` [PATCH 8 of 8 DOCDAY] docs: hypercall: document mmuext_op using Doxygen Ian Campbell
2011-10-26 13:43   ` David Vrabel [this message]
2011-10-26 13:50 ` [PATCH 0 of 8 DOCDAY] setup Doxygen for use with hypercall interface headers Ian Jackson
2011-10-26 13:56   ` Ian Campbell

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4EA80E6C.20403@citrix.com \
    --to=david.vrabel@citrix.com \
    --cc=ian.campbell@citrix.com \
    --cc=xen-devel@lists.xensource.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.