qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: "Philippe Mathieu-Daudé" <philmd@redhat.com>
Cc: QEMU Trivial <qemu-trivial@nongnu.org>,
	QEMU Developers <qemu-devel@nongnu.org>
Subject: Re: [PATCH] Makefile: List the sphinx documentation in 'make help'
Date: Thu, 23 Jan 2020 11:53:27 +0000	[thread overview]
Message-ID: <CAFEAcA_4yGD4Tm5LpN3PXP6S_cbFGdVD8jAcnrm2pEyLNteW0w@mail.gmail.com> (raw)
In-Reply-To: <20200122172137.7282-1-philmd@redhat.com>

On Wed, 22 Jan 2020 at 17:21, Philippe Mathieu-Daudé <philmd@redhat.com> wrote:
>
> In commit 5f71eac06e1 we started to support the rST documentation.
> List the build target we need to call to generate the rST files in
> the 'make help' output.
>
> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> ---
>  Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index 6562b0dc97..b777f7fcdd 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -1197,7 +1197,7 @@ endif
>         @echo  '  vm-help         - Help about targets running tests inside VM'
>         @echo  ''
>         @echo  'Documentation targets:'
> -       @echo  '  html info pdf txt'
> +       @echo  '  html info pdf txt sphinxdocs'
>         @echo  '                  - Build documentation in specified format'
>  ifdef CONFIG_GCOV
>         @echo  '  coverage-report - Create code coverage report'

'sphinxdocs' wasn't intended to be a user-facing target.
If you do 'make html' this will build the HTML Sphinx
documentation (as well as any legacy non-Sphinx HTML).

thanks
-- PMM


  parent reply	other threads:[~2020-01-23 13:11 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-22 17:21 [PATCH] Makefile: List the sphinx documentation in 'make help' Philippe Mathieu-Daudé
2020-01-22 19:25 ` Richard Henderson
2020-01-23 11:53 ` Peter Maydell [this message]
2020-01-23 17:48   ` Philippe Mathieu-Daudé

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=CAFEAcA_4yGD4Tm5LpN3PXP6S_cbFGdVD8jAcnrm2pEyLNteW0w@mail.gmail.com \
    --to=peter.maydell@linaro.org \
    --cc=philmd@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-trivial@nongnu.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).