* [PATCH v2 06/22] docs: mark orphan documents as such [not found] <cover.1559656538.git.mchehab+samsung@kernel.org> @ 2019-06-04 14:17 ` Mauro Carvalho Chehab 2019-06-05 6:16 ` Andrew Donnellan 2019-06-04 14:17 ` [PATCH v2 18/22] docs: move protection-keys.rst to the core-api book Mauro Carvalho Chehab 1 sibling, 1 reply; 3+ messages in thread From: Mauro Carvalho Chehab @ 2019-06-04 14:17 UTC (permalink / raw) To: Linux Doc Mailing List Cc: Maxime Ripard, dri-devel, platform-driver-x86, Paul Mackerras, Mauro Carvalho Chehab, linux-stm32, Alexandre Torgue, Jonathan Corbet, David Airlie, Andrew Donnellan, linux-pm, Maarten Lankhorst, Matan Ziv-Av, Mauro Carvalho Chehab, Daniel Vetter, Sean Paul, linux-arm-kernel, linux-kernel, Maxime Coquelin, Frederic Barrat, linuxppc-dev, Georgi Djakov Sphinx doesn't like orphan documents: Documentation/accelerators/ocxl.rst: WARNING: document isn't included in any toctree Documentation/arm/stm32/overview.rst: WARNING: document isn't included in any toctree Documentation/arm/stm32/stm32f429-overview.rst: WARNING: document isn't included in any toctree Documentation/arm/stm32/stm32f746-overview.rst: WARNING: document isn't included in any toctree Documentation/arm/stm32/stm32f769-overview.rst: WARNING: document isn't included in any toctree Documentation/arm/stm32/stm32h743-overview.rst: WARNING: document isn't included in any toctree Documentation/arm/stm32/stm32mp157-overview.rst: WARNING: document isn't included in any toctree Documentation/gpu/msm-crash-dump.rst: WARNING: document isn't included in any toctree Documentation/interconnect/interconnect.rst: WARNING: document isn't included in any toctree Documentation/laptops/lg-laptop.rst: WARNING: document isn't included in any toctree Documentation/powerpc/isa-versions.rst: WARNING: document isn't included in any toctree Documentation/virtual/kvm/amd-memory-encryption.rst: WARNING: document isn't included in any toctree Documentation/virtual/kvm/vcpu-requests.rst: WARNING: document isn't included in any toctree So, while they aren't on any toctree, add :orphan: to them, in order to silent this warning. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> --- Documentation/accelerators/ocxl.rst | 2 ++ Documentation/arm/stm32/overview.rst | 2 ++ Documentation/arm/stm32/stm32f429-overview.rst | 2 ++ Documentation/arm/stm32/stm32f746-overview.rst | 2 ++ Documentation/arm/stm32/stm32f769-overview.rst | 2 ++ Documentation/arm/stm32/stm32h743-overview.rst | 2 ++ Documentation/arm/stm32/stm32mp157-overview.rst | 2 ++ Documentation/gpu/msm-crash-dump.rst | 2 ++ Documentation/interconnect/interconnect.rst | 2 ++ Documentation/laptops/lg-laptop.rst | 2 ++ Documentation/powerpc/isa-versions.rst | 2 ++ 11 files changed, 22 insertions(+) diff --git a/Documentation/accelerators/ocxl.rst b/Documentation/accelerators/ocxl.rst index 14cefc020e2d..b1cea19a90f5 100644 --- a/Documentation/accelerators/ocxl.rst +++ b/Documentation/accelerators/ocxl.rst @@ -1,3 +1,5 @@ +:orphan: + ======================================================== OpenCAPI (Open Coherent Accelerator Processor Interface) ======================================================== diff --git a/Documentation/arm/stm32/overview.rst b/Documentation/arm/stm32/overview.rst index 85cfc8410798..f7e734153860 100644 --- a/Documentation/arm/stm32/overview.rst +++ b/Documentation/arm/stm32/overview.rst @@ -1,3 +1,5 @@ +:orphan: + ======================== STM32 ARM Linux Overview ======================== diff --git a/Documentation/arm/stm32/stm32f429-overview.rst b/Documentation/arm/stm32/stm32f429-overview.rst index 18feda97f483..65bbb1c3b423 100644 --- a/Documentation/arm/stm32/stm32f429-overview.rst +++ b/Documentation/arm/stm32/stm32f429-overview.rst @@ -1,3 +1,5 @@ +:orphan: + STM32F429 Overview ================== diff --git a/Documentation/arm/stm32/stm32f746-overview.rst b/Documentation/arm/stm32/stm32f746-overview.rst index b5f4b6ce7656..42d593085015 100644 --- a/Documentation/arm/stm32/stm32f746-overview.rst +++ b/Documentation/arm/stm32/stm32f746-overview.rst @@ -1,3 +1,5 @@ +:orphan: + STM32F746 Overview ================== diff --git a/Documentation/arm/stm32/stm32f769-overview.rst b/Documentation/arm/stm32/stm32f769-overview.rst index 228656ced2fe..f6adac862b17 100644 --- a/Documentation/arm/stm32/stm32f769-overview.rst +++ b/Documentation/arm/stm32/stm32f769-overview.rst @@ -1,3 +1,5 @@ +:orphan: + STM32F769 Overview ================== diff --git a/Documentation/arm/stm32/stm32h743-overview.rst b/Documentation/arm/stm32/stm32h743-overview.rst index 3458dc00095d..c525835e7473 100644 --- a/Documentation/arm/stm32/stm32h743-overview.rst +++ b/Documentation/arm/stm32/stm32h743-overview.rst @@ -1,3 +1,5 @@ +:orphan: + STM32H743 Overview ================== diff --git a/Documentation/arm/stm32/stm32mp157-overview.rst b/Documentation/arm/stm32/stm32mp157-overview.rst index 62e176d47ca7..2c52cd020601 100644 --- a/Documentation/arm/stm32/stm32mp157-overview.rst +++ b/Documentation/arm/stm32/stm32mp157-overview.rst @@ -1,3 +1,5 @@ +:orphan: + STM32MP157 Overview =================== diff --git a/Documentation/gpu/msm-crash-dump.rst b/Documentation/gpu/msm-crash-dump.rst index 757cd257e0d8..240ef200f76c 100644 --- a/Documentation/gpu/msm-crash-dump.rst +++ b/Documentation/gpu/msm-crash-dump.rst @@ -1,3 +1,5 @@ +:orphan: + ===================== MSM Crash Dump Format ===================== diff --git a/Documentation/interconnect/interconnect.rst b/Documentation/interconnect/interconnect.rst index c3e004893796..56e331dab70e 100644 --- a/Documentation/interconnect/interconnect.rst +++ b/Documentation/interconnect/interconnect.rst @@ -1,5 +1,7 @@ .. SPDX-License-Identifier: GPL-2.0 +:orphan: + ===================================== GENERIC SYSTEM INTERCONNECT SUBSYSTEM ===================================== diff --git a/Documentation/laptops/lg-laptop.rst b/Documentation/laptops/lg-laptop.rst index aa503ee9b3bc..f2c2ffe31101 100644 --- a/Documentation/laptops/lg-laptop.rst +++ b/Documentation/laptops/lg-laptop.rst @@ -1,5 +1,7 @@ .. SPDX-License-Identifier: GPL-2.0+ +:orphan: + LG Gram laptop extra features ============================= diff --git a/Documentation/powerpc/isa-versions.rst b/Documentation/powerpc/isa-versions.rst index 812e20cc898c..66c24140ebf1 100644 --- a/Documentation/powerpc/isa-versions.rst +++ b/Documentation/powerpc/isa-versions.rst @@ -1,3 +1,5 @@ +:orphan: + CPU to ISA Version Mapping ========================== -- 2.21.0 ^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2 06/22] docs: mark orphan documents as such 2019-06-04 14:17 ` [PATCH v2 06/22] docs: mark orphan documents as such Mauro Carvalho Chehab @ 2019-06-05 6:16 ` Andrew Donnellan 0 siblings, 0 replies; 3+ messages in thread From: Andrew Donnellan @ 2019-06-05 6:16 UTC (permalink / raw) To: Mauro Carvalho Chehab, Linux Doc Mailing List Cc: Maxime Ripard, dri-devel, platform-driver-x86, Paul Mackerras, linux-stm32, Jonathan Corbet, David Airlie, Alexandre Torgue, linux-pm, Maarten Lankhorst, Matan Ziv-Av, Mauro Carvalho Chehab, Daniel Vetter, Sean Paul, linux-arm-kernel, linux-kernel, Maxime Coquelin, Frederic Barrat, linuxppc-dev, Georgi Djakov On 5/6/19 12:17 am, Mauro Carvalho Chehab wrote: > Sphinx doesn't like orphan documents: > > Documentation/accelerators/ocxl.rst: WARNING: document isn't included in any toctree > Documentation/arm/stm32/overview.rst: WARNING: document isn't included in any toctree > Documentation/arm/stm32/stm32f429-overview.rst: WARNING: document isn't included in any toctree > Documentation/arm/stm32/stm32f746-overview.rst: WARNING: document isn't included in any toctree > Documentation/arm/stm32/stm32f769-overview.rst: WARNING: document isn't included in any toctree > Documentation/arm/stm32/stm32h743-overview.rst: WARNING: document isn't included in any toctree > Documentation/arm/stm32/stm32mp157-overview.rst: WARNING: document isn't included in any toctree > Documentation/gpu/msm-crash-dump.rst: WARNING: document isn't included in any toctree > Documentation/interconnect/interconnect.rst: WARNING: document isn't included in any toctree > Documentation/laptops/lg-laptop.rst: WARNING: document isn't included in any toctree > Documentation/powerpc/isa-versions.rst: WARNING: document isn't included in any toctree > Documentation/virtual/kvm/amd-memory-encryption.rst: WARNING: document isn't included in any toctree > Documentation/virtual/kvm/vcpu-requests.rst: WARNING: document isn't included in any toctree > > So, while they aren't on any toctree, add :orphan: to them, in order > to silent this warning. > > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> ocxl: Acked-by: Andrew Donnellan <ajd@linux.ibm.com> We should find somewhere to put it... > --- > Documentation/accelerators/ocxl.rst | 2 ++ > Documentation/arm/stm32/overview.rst | 2 ++ > Documentation/arm/stm32/stm32f429-overview.rst | 2 ++ > Documentation/arm/stm32/stm32f746-overview.rst | 2 ++ > Documentation/arm/stm32/stm32f769-overview.rst | 2 ++ > Documentation/arm/stm32/stm32h743-overview.rst | 2 ++ > Documentation/arm/stm32/stm32mp157-overview.rst | 2 ++ > Documentation/gpu/msm-crash-dump.rst | 2 ++ > Documentation/interconnect/interconnect.rst | 2 ++ > Documentation/laptops/lg-laptop.rst | 2 ++ > Documentation/powerpc/isa-versions.rst | 2 ++ > 11 files changed, 22 insertions(+) > > diff --git a/Documentation/accelerators/ocxl.rst b/Documentation/accelerators/ocxl.rst > index 14cefc020e2d..b1cea19a90f5 100644 > --- a/Documentation/accelerators/ocxl.rst > +++ b/Documentation/accelerators/ocxl.rst > @@ -1,3 +1,5 @@ > +:orphan: > + > ======================================================== > OpenCAPI (Open Coherent Accelerator Processor Interface) > ======================================================== > diff --git a/Documentation/arm/stm32/overview.rst b/Documentation/arm/stm32/overview.rst > index 85cfc8410798..f7e734153860 100644 > --- a/Documentation/arm/stm32/overview.rst > +++ b/Documentation/arm/stm32/overview.rst > @@ -1,3 +1,5 @@ > +:orphan: > + > ======================== > STM32 ARM Linux Overview > ======================== > diff --git a/Documentation/arm/stm32/stm32f429-overview.rst b/Documentation/arm/stm32/stm32f429-overview.rst > index 18feda97f483..65bbb1c3b423 100644 > --- a/Documentation/arm/stm32/stm32f429-overview.rst > +++ b/Documentation/arm/stm32/stm32f429-overview.rst > @@ -1,3 +1,5 @@ > +:orphan: > + > STM32F429 Overview > ================== > > diff --git a/Documentation/arm/stm32/stm32f746-overview.rst b/Documentation/arm/stm32/stm32f746-overview.rst > index b5f4b6ce7656..42d593085015 100644 > --- a/Documentation/arm/stm32/stm32f746-overview.rst > +++ b/Documentation/arm/stm32/stm32f746-overview.rst > @@ -1,3 +1,5 @@ > +:orphan: > + > STM32F746 Overview > ================== > > diff --git a/Documentation/arm/stm32/stm32f769-overview.rst b/Documentation/arm/stm32/stm32f769-overview.rst > index 228656ced2fe..f6adac862b17 100644 > --- a/Documentation/arm/stm32/stm32f769-overview.rst > +++ b/Documentation/arm/stm32/stm32f769-overview.rst > @@ -1,3 +1,5 @@ > +:orphan: > + > STM32F769 Overview > ================== > > diff --git a/Documentation/arm/stm32/stm32h743-overview.rst b/Documentation/arm/stm32/stm32h743-overview.rst > index 3458dc00095d..c525835e7473 100644 > --- a/Documentation/arm/stm32/stm32h743-overview.rst > +++ b/Documentation/arm/stm32/stm32h743-overview.rst > @@ -1,3 +1,5 @@ > +:orphan: > + > STM32H743 Overview > ================== > > diff --git a/Documentation/arm/stm32/stm32mp157-overview.rst b/Documentation/arm/stm32/stm32mp157-overview.rst > index 62e176d47ca7..2c52cd020601 100644 > --- a/Documentation/arm/stm32/stm32mp157-overview.rst > +++ b/Documentation/arm/stm32/stm32mp157-overview.rst > @@ -1,3 +1,5 @@ > +:orphan: > + > STM32MP157 Overview > =================== > > diff --git a/Documentation/gpu/msm-crash-dump.rst b/Documentation/gpu/msm-crash-dump.rst > index 757cd257e0d8..240ef200f76c 100644 > --- a/Documentation/gpu/msm-crash-dump.rst > +++ b/Documentation/gpu/msm-crash-dump.rst > @@ -1,3 +1,5 @@ > +:orphan: > + > ===================== > MSM Crash Dump Format > ===================== > diff --git a/Documentation/interconnect/interconnect.rst b/Documentation/interconnect/interconnect.rst > index c3e004893796..56e331dab70e 100644 > --- a/Documentation/interconnect/interconnect.rst > +++ b/Documentation/interconnect/interconnect.rst > @@ -1,5 +1,7 @@ > .. SPDX-License-Identifier: GPL-2.0 > > +:orphan: > + > ===================================== > GENERIC SYSTEM INTERCONNECT SUBSYSTEM > ===================================== > diff --git a/Documentation/laptops/lg-laptop.rst b/Documentation/laptops/lg-laptop.rst > index aa503ee9b3bc..f2c2ffe31101 100644 > --- a/Documentation/laptops/lg-laptop.rst > +++ b/Documentation/laptops/lg-laptop.rst > @@ -1,5 +1,7 @@ > .. SPDX-License-Identifier: GPL-2.0+ > > +:orphan: > + > LG Gram laptop extra features > ============================= > > diff --git a/Documentation/powerpc/isa-versions.rst b/Documentation/powerpc/isa-versions.rst > index 812e20cc898c..66c24140ebf1 100644 > --- a/Documentation/powerpc/isa-versions.rst > +++ b/Documentation/powerpc/isa-versions.rst > @@ -1,3 +1,5 @@ > +:orphan: > + > CPU to ISA Version Mapping > ========================== > > -- Andrew Donnellan OzLabs, ADL Canberra ajd@linux.ibm.com IBM Australia Limited ^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH v2 18/22] docs: move protection-keys.rst to the core-api book [not found] <cover.1559656538.git.mchehab+samsung@kernel.org> 2019-06-04 14:17 ` [PATCH v2 06/22] docs: mark orphan documents as such Mauro Carvalho Chehab @ 2019-06-04 14:17 ` Mauro Carvalho Chehab 1 sibling, 0 replies; 3+ messages in thread From: Mauro Carvalho Chehab @ 2019-06-04 14:17 UTC (permalink / raw) To: Linux Doc Mailing List Cc: Michal Hocko, Dave Hansen, Paul Mackerras, linux-kselftest, H. Peter Anvin, Mauro Carvalho Chehab, Shuah Khan, Jonathan Corbet, x86, Matthew Wilcox, Ingo Molnar, Kent Overstreet, Arnd Bergmann, Jonathan Neuschäfer, Mauro Carvalho Chehab, Mike Rapoport, Borislav Petkov, Thomas Gleixner, Randy Dunlap, linux-kernel, Changbin Du, Andrew Morton, linuxppc-dev This document is used by multiple architectures: $ echo $(git grep -l pkey_mprotect arch|cut -d'/' -f 2|sort|uniq) alpha arm arm64 ia64 m68k microblaze mips parisc powerpc s390 sh sparc x86 xtensa So, let's move it to the core book and adjust the links to it accordingly. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> --- Documentation/core-api/index.rst | 1 + Documentation/{x86 => core-api}/protection-keys.rst | 0 Documentation/x86/index.rst | 1 - arch/powerpc/Kconfig | 2 +- arch/x86/Kconfig | 2 +- tools/testing/selftests/x86/protection_keys.c | 2 +- 6 files changed, 4 insertions(+), 4 deletions(-) rename Documentation/{x86 => core-api}/protection-keys.rst (100%) diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst index ee1bb8983a88..2466a4c51031 100644 --- a/Documentation/core-api/index.rst +++ b/Documentation/core-api/index.rst @@ -34,6 +34,7 @@ Core utilities timekeeping boot-time-mm memory-hotplug + protection-keys Interfaces for kernel debugging diff --git a/Documentation/x86/protection-keys.rst b/Documentation/core-api/protection-keys.rst similarity index 100% rename from Documentation/x86/protection-keys.rst rename to Documentation/core-api/protection-keys.rst diff --git a/Documentation/x86/index.rst b/Documentation/x86/index.rst index ae36fc5fc649..f2de1b2d3ac7 100644 --- a/Documentation/x86/index.rst +++ b/Documentation/x86/index.rst @@ -19,7 +19,6 @@ x86-specific Documentation tlb mtrr pat - protection-keys intel_mpx amd-memory-encryption pti diff --git a/arch/powerpc/Kconfig b/arch/powerpc/Kconfig index 1120ff8ac715..e437aa3e78b4 100644 --- a/arch/powerpc/Kconfig +++ b/arch/powerpc/Kconfig @@ -898,7 +898,7 @@ config PPC_MEM_KEYS page-based protections, but without requiring modification of the page tables when an application changes protection domains. - For details, see Documentation/vm/protection-keys.rst + For details, see Documentation/core-api/protection-keys.rst If unsure, say y. diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig index 23de3b9da480..61244bdb886f 100644 --- a/arch/x86/Kconfig +++ b/arch/x86/Kconfig @@ -1911,7 +1911,7 @@ config X86_INTEL_MEMORY_PROTECTION_KEYS page-based protections, but without requiring modification of the page tables when an application changes protection domains. - For details, see Documentation/x86/protection-keys.txt + For details, see Documentation/core-api/protection-keys.rst If unsure, say y. diff --git a/tools/testing/selftests/x86/protection_keys.c b/tools/testing/selftests/x86/protection_keys.c index 5d546dcdbc80..480995bceefa 100644 --- a/tools/testing/selftests/x86/protection_keys.c +++ b/tools/testing/selftests/x86/protection_keys.c @@ -1,6 +1,6 @@ // SPDX-License-Identifier: GPL-2.0 /* - * Tests x86 Memory Protection Keys (see Documentation/x86/protection-keys.txt) + * Tests x86 Memory Protection Keys (see Documentation/core-api/protection-keys.rst) * * There are examples in here of: * * how to set protection keys on memory -- 2.21.0 ^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-06-05 6:20 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <cover.1559656538.git.mchehab+samsung@kernel.org>
2019-06-04 14:17 ` [PATCH v2 06/22] docs: mark orphan documents as such Mauro Carvalho Chehab
2019-06-05 6:16 ` Andrew Donnellan
2019-06-04 14:17 ` [PATCH v2 18/22] docs: move protection-keys.rst to the core-api book Mauro Carvalho Chehab
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox