[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v2 01/32] docs: temporarily disable the kernel-doc extension
From: |
Peter Maydell |
Subject: |
Re: [PATCH v2 01/32] docs: temporarily disable the kernel-doc extension |
Date: |
Tue, 1 Dec 2020 11:01:48 +0000 |
On Tue, 1 Dec 2020 at 10:35, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> Preserve bisectability while we update scripts/kernel-doc from Linux.
> Without this patch, building with Sphinx 3 would break while we
> revert our own Sphinx 3 support and replace it with Linux's.
>
> Suggested-by: Peter Maydell <peter.maydell@linaro.org>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
> docs/sphinx/kerneldoc.py | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/docs/sphinx/kerneldoc.py b/docs/sphinx/kerneldoc.py
> index 3ac277d162..9124fcbff1 100644
> --- a/docs/sphinx/kerneldoc.py
> +++ b/docs/sphinx/kerneldoc.py
> @@ -75,6 +75,9 @@ class KernelDocDirective(Directive):
> # Tell sphinx of the dependency
> env.note_dependency(os.path.abspath(filename))
>
> + # Disabled temporarily while scripts/kernel-doc is updated
> + return []
> +
> tab_width = self.options.get('tab-width',
> self.state.document.settings.tab_width)
>
> # FIXME: make this nicer and more robust against errors
Oh, this is nicer than having to comment out every use of the extension :-)
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
thanks
-- PMM
- [PATCH v2 00/32] kernel-doc: update from Linux 5.10, Paolo Bonzini, 2020/12/01
- [PATCH v2 01/32] docs: temporarily disable the kernel-doc extension, Paolo Bonzini, 2020/12/01
- Re: [PATCH v2 01/32] docs: temporarily disable the kernel-doc extension,
Peter Maydell <=
- [PATCH v2 03/32] kernel-doc: add support for ____cacheline_aligned_in_smp attribute, Paolo Bonzini, 2020/12/01
- [PATCH v2 05/32] scripts: kernel-doc: proper handle @foo->bar(), Paolo Bonzini, 2020/12/01
- [PATCH v2 06/32] scripts: kernel-doc: accept negation like !@var, Paolo Bonzini, 2020/12/01
- [PATCH v2 04/32] scripts/kernel-doc: Add support for named variable macro arguments, Paolo Bonzini, 2020/12/01
- [PATCH v2 09/32] scripts/kernel-doc: parse __ETHTOOL_DECLARE_LINK_MODE_MASK, Paolo Bonzini, 2020/12/01
- [PATCH v2 08/32] Replace HTTP links with HTTPS ones: documentation, Paolo Bonzini, 2020/12/01
- [PATCH v2 14/32] scripts: kernel-doc: add support for typedef enum, Paolo Bonzini, 2020/12/01
- [PATCH v2 07/32] scripts: kernel-doc: accept blank lines on parameter description, Paolo Bonzini, 2020/12/01
- [PATCH v2 15/32] Revert "scripts/kerneldoc: For Sphinx 3 use c:macro for macros with arguments", Paolo Bonzini, 2020/12/01
- [PATCH v2 10/32] scripts/kernel-doc: handle function pointer prototypes, Paolo Bonzini, 2020/12/01