From: Mauro Carvalho Chehab <mchehab@infradead•org>
To: Christophe Leroy <christophe.leroy@c-s•fr>
Cc: "Andrew Lunn" <andrew@lunn•ch>,
"Thomas Preston" <thomas.preston@codethink•co.uk>,
"Wolfram Sang" <wsa@the-dreams•de>,
"Catalin Marinas" <catalin.marinas@arm•com>,
"Linus Walleij" <linus.walleij@linaro•org>,
"Will Deacon" <will.deacon@arm•com>,
"Russell King" <linux@armlinux•org.uk>,
"Paul Mackerras" <paulus@samba•org>,
"Alessia Mantegazza" <amantegazza@vaga•pv.it>,
"Jakub Wilk" <jwilk@jwilk•net>,
"AKASHI Takahiro" <takahiro.akashi@linaro•org>,
"Kevin Hilman" <khilman@baylibre•com>,
"James Morris" <jmorris@namei•org>,
linux-acpi@vger•kernel.org, "Andy Gross" <agross@kernel•org>,
xen-devel@lists•xenproject.org,
"Jason Wang" <jasowang@redhat•com>,
"Alexander Popov" <alex.popov@linux•com>, "Qian Cai" <cai@lca•pw>,
"Al Viro" <viro@zeniv•linux.org.uk>,
"Andy Lutomirski" <luto@kernel•org>,
"Thomas Gleixner" <tglx@linutronix•de>,
"Kairui Song" <kasong@redhat•com>,
"Quentin Perret" <quentin.perret@arm•com>,
"Greg Kroah-Hartman" <gregkh@linuxfoundation•org>,
"Rafael J. Wysocki" <rjw@rjwysocki•net>,
linux-kernel@vger•kernel.org,
"Paul Burton" <paul.burton@mips•com>,
"Jiri Kosina" <jkosina@suse•cz>,
"Casey Schaufler" <casey@schaufler-ca•com>,
"Andrew Morton" <akpm@linux-foundation•org>,
"Lu Baolu" <baolu.lu@linux•intel.com>,
"Mark Rutland" <mark.rutland@arm•com>,
"Feng Tang" <feng.tang@intel•com>,
"Linux Doc Mailing List" <linux-doc@vger•kernel.org>,
"Dave Hansen" <dave.hansen@linux•intel.com>,
"Mimi Zohar" <zohar@linux•ibm.com>,
"Kamalesh Babulal" <kamalesh@linux•vnet.ibm.com>,
"Masahiro Yamada" <yamada.masahiro@socionext•com>,
"Yannik Sembritzki" <yannik@sembritzki•me>,
"Harry Wei" <harryxiyou@gmail•com>,
linux-i2c@vger•kernel.org, "Shuah Khan" <shuah@kernel•org>,
"Stephen Rothwell" <sfr@canb•auug.org.au>,
"Paul E. McKenney" <paulmck@linux•ibm.com>,
"Alexandre Ghiti" <alex@ghiti•fr>,
YueHaibing <yuehaibing@huawei•com>,
"Robert Moore" <robert.moore@intel•com>,
"Bartosz Golaszewski" <bgolaszewski@baylibre•com>,
"Len Brown" <lenb@kernel•org>,
"David Brown" <david.brown@linaro•org>,
"Joerg Roedel" <jroedel@suse•de>,
linux-arm-msm@vger•kernel.org, linux-gpio@vger•kernel.org,
"Claudiu Manoil" <claudiu.manoil@nxp•com>,
"Florian Fainelli" <f.fainelli@gmail•com>,
"Jacek Anaszewski" <jacek.anaszewski@gmail•com>,
"Bjorn Helgaas" <bhelgaas@google•com>,
linux-amlogic@lists•infradead.org,
"Boris Ostrovsky" <boris.ostrovsky@oracle•com>,
"Mika Westerberg" <mika.westerberg@linux•intel.com>,
linux-arm-kernel@lists•infradead.org,
"Tony Luck" <tony.luck@intel•com>,
"Sean Christopherson" <sean.j.christopherson@intel•com>,
"Rob Herring" <robh+dt@kernel•org>,
"James Morse" <james.morse@arm•com>,
"Robin Murphy" <robin.murphy@arm•com>,
"Samuel Mendoza-Jonas" <sam@mendozajonas•com>,
linux-pci@vger•kernel.org, "Bhupesh Sharma" <bhsharma@redhat•com>,
"Josh Poimboeuf" <jpoimboe@redhat•com>,
platform-driver-x86@vger•kernel.org,
"Ding Xiang" <dingxiang@cmss•chinamobile.com>,
linux-kselftest@vger•kernel.org,
"Alex Shi" <alex.shi@linux•alibaba.com>,
"Lorenzo Pieralisi" <lorenzo.pieralisi@arm•com>,
"Baoquan He" <bhe@redhat•com>, "Jonathan Corbet" <corbet@lwn•net>,
"Raphael Gault" <raphael.gault@arm•com>,
"Joel Stanley" <joel@jms•id.au>,
"Federico Vaga" <federico.vaga@vaga•pv.it>,
"Darren Hart" <dvhart@infradead•org>,
"Erik Schmauss" <erik.schmauss@intel•com>,
"Serge E. Hallyn" <serge@hallyn•com>,
"Palmer Dabbelt" <palmer@sifive•com>,
"Kees Cook" <keescook@chromium•org>,
"Bartlomiej Zolnierkiewicz" <b.zolnierkie@samsung•com>,
"Jonathan Neuschäfer" <j.neuschaefer@gmx•net>,
"SeongJae Park" <sj38.park@gmail•com>,
"Mark Brown" <broonie@kernel•org>,
"Borislav Petkov" <bp@alien8•de>,
"Sunil Muthuswamy" <sunilmut@microsoft•com>,
virtualization@lists•linux-foundation.org, devel@acpica•org,
"Ard Biesheuvel" <ard.biesheuvel@linaro•org>,
"Liam Girdwood" <lgirdwood@gmail•com>,
"Sakari Ailus" <sakari.ailus@linux•intel.com>,
"Olof Johansson" <olof@lixom•net>,
"Logan Gunthorpe" <logang@deltatee•com>,
"David S. Miller" <davem@davemloft•net>,
"Kirill A. Shutemov" <kirill.shutemov@linux•intel.com>,
"Sven Van Asbroeck" <thesven73@gmail•com>,
"Michal Hocko" <mhocko@suse•com>,
kvm@vger•kernel.org, "Michael S. Tsirkin" <mst@redhat•com>,
"Peter Zijlstra" <peterz@infradead•org>,
"Thorsten Leemhuis" <linux@leemhuis•info>,
"David Howells" <dhowells@redhat•com>,
linux-mm@kvack•org, "H. Peter Anvin" <hpa@zytor•com>,
devel@driverdev•osuosl.org,
"Manfred Spraul" <manfred@colorfullife•com>,
"Luis Chamberlain" <mcgrof@kernel•org>,
x86@kernel•org, "Pavel Tatashin" <pasha.tatashin@oracle•com>,
"Mike Rapoport" <rppt@linux•ibm.com>,
"Ingo Molnar" <mingo@redhat•com>,
"Dave Young" <dyoung@redhat•com>,
devicetree@vger•kernel.org,
"Arnaldo Carvalho de Melo" <acme@redhat•com>,
"Jerome Glisse" <jglisse@redhat•com>,
"Stefano Stabellini" <sstabellini@kernel•org>,
"Jonathan Cameron" <Jonathan.Cameron@huawei•com>,
"Dmitry Vyukov" <dvyukov@google•com>,
linux-edac@vger•kernel.org, "Juergen Gross" <jgross@suse•com>,
"Denis Efremov" <efremov@ispras•ru>,
netdev@vger•kernel.org,
"Nicolas Ferre" <nicolas.ferre@microchip•com>,
"Changbin Du" <changbin.du@intel•com>,
linux-security-module@vger•kernel.org,
linuxppc-dev@lists•ozlabs.org,
"Andy Shevchenko" <andy@infradead•org>
Subject: Re: [PATCH 22/22] docs: fix broken documentation links
Date: Tue, 4 Jun 2019 06:58:02 -0300 [thread overview]
Message-ID: <20190604065802.47a9d24b@coco.lan> (raw)
In-Reply-To: <20190604064614.67cde821@coco.lan>
Em Tue, 4 Jun 2019 06:46:14 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel•org> escreveu:
> Em Mon, 3 Jun 2019 09:34:15 +0200
> Christophe Leroy <christophe.leroy@c-s•fr> escreveu:
>
> > [...]
> >
> > > diff --git a/arch/powerpc/Kconfig b/arch/powerpc/Kconfig
> > > index 8c1c636308c8..e868d2bd48b8 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/x86/protection-keys.rst
> >
> > It looks strange to reference an x86 file, for powerpc arch.
>
> Indeed. Yet, seeking for the API documented there:
>
> $ git grep -l pkey_mprotect
> Documentation/x86/protection-keys.rst
> arch/alpha/kernel/syscalls/syscall.tbl
> arch/arm/tools/syscall.tbl
> arch/arm64/include/asm/unistd32.h
> arch/ia64/kernel/syscalls/syscall.tbl
> arch/m68k/kernel/syscalls/syscall.tbl
> arch/microblaze/kernel/syscalls/syscall.tbl
> arch/mips/kernel/syscalls/syscall_n32.tbl
> arch/mips/kernel/syscalls/syscall_n64.tbl
> arch/mips/kernel/syscalls/syscall_o32.tbl
> arch/parisc/kernel/syscalls/syscall.tbl
> arch/powerpc/kernel/syscalls/syscall.tbl
> arch/s390/kernel/syscalls/syscall.tbl
> arch/sh/kernel/syscalls/syscall.tbl
> arch/sparc/kernel/syscalls/syscall.tbl
> arch/x86/entry/syscalls/syscall_32.tbl
> arch/x86/entry/syscalls/syscall_64.tbl
> arch/xtensa/kernel/syscalls/syscall.tbl
> include/linux/syscalls.h
> include/uapi/asm-generic/unistd.h
> kernel/sys_ni.c
> mm/mprotect.c
> tools/include/uapi/asm-generic/unistd.h
> tools/perf/arch/powerpc/entry/syscalls/syscall.tbl
> tools/perf/arch/x86/entry/syscalls/syscall_64.tbl
> tools/perf/builtin-trace.c
> tools/testing/selftests/x86/protection_keys.c
>
> Despite being used on several archs, the only documentation for it
> is inside the x86 directory, as it seems that this is not
> arch-specific.
>
> Perhaps the file should, instead, be moved to another book.
I guess the best is to have this inside the core-api book.
Patch enclosed.
Regards,
Mauro
[PATCH] docs: move protection-keys.rst to the core-api book
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>
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 8c1c636308c8..3b795a0cab62 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 2bbbd4d1ba31..d87d53fcd261 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
next prev parent reply other threads:[~2019-06-04 10:33 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-29 23:23 [PATCH 00/22] Some documentation fixes Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 09/22] docs: mark orphan documents as such Mauro Carvalho Chehab
2019-05-30 8:30 ` Paolo Bonzini
2019-06-03 7:32 ` Christophe Leroy
2019-06-04 10:10 ` Mauro Carvalho Chehab
2019-05-29 23:23 ` [PATCH 22/22] docs: fix broken documentation links Mauro Carvalho Chehab
2019-05-30 7:21 ` Wolfram Sang
2019-05-30 20:17 ` Federico Vaga
2019-05-30 22:49 ` Michael S. Tsirkin
2019-06-03 7:34 ` Christophe Leroy
2019-06-04 9:46 ` Mauro Carvalho Chehab
2019-06-04 9:58 ` Mauro Carvalho Chehab [this message]
2019-06-03 15:41 ` Mark Brown
2019-06-04 6:12 ` Bhupesh Sharma
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=20190604065802.47a9d24b@coco.lan \
--to=mchehab@infradead$(echo .)org \
--cc=Jonathan.Cameron@huawei$(echo .)com \
--cc=acme@redhat$(echo .)com \
--cc=agross@kernel$(echo .)org \
--cc=akpm@linux-foundation$(echo .)org \
--cc=alex.popov@linux$(echo .)com \
--cc=alex.shi@linux$(echo .)alibaba.com \
--cc=alex@ghiti$(echo .)fr \
--cc=amantegazza@vaga$(echo .)pv.it \
--cc=andrew@lunn$(echo .)ch \
--cc=andy@infradead$(echo .)org \
--cc=ard.biesheuvel@linaro$(echo .)org \
--cc=b.zolnierkie@samsung$(echo .)com \
--cc=baolu.lu@linux$(echo .)intel.com \
--cc=bgolaszewski@baylibre$(echo .)com \
--cc=bhe@redhat$(echo .)com \
--cc=bhelgaas@google$(echo .)com \
--cc=bhsharma@redhat$(echo .)com \
--cc=boris.ostrovsky@oracle$(echo .)com \
--cc=bp@alien8$(echo .)de \
--cc=broonie@kernel$(echo .)org \
--cc=cai@lca$(echo .)pw \
--cc=casey@schaufler-ca$(echo .)com \
--cc=catalin.marinas@arm$(echo .)com \
--cc=changbin.du@intel$(echo .)com \
--cc=christophe.leroy@c-s$(echo .)fr \
--cc=claudiu.manoil@nxp$(echo .)com \
--cc=corbet@lwn$(echo .)net \
--cc=dave.hansen@linux$(echo .)intel.com \
--cc=davem@davemloft$(echo .)net \
--cc=david.brown@linaro$(echo .)org \
--cc=devel@acpica$(echo .)org \
--cc=devel@driverdev$(echo .)osuosl.org \
--cc=devicetree@vger$(echo .)kernel.org \
--cc=dhowells@redhat$(echo .)com \
--cc=dingxiang@cmss$(echo .)chinamobile.com \
--cc=dvhart@infradead$(echo .)org \
--cc=dvyukov@google$(echo .)com \
--cc=dyoung@redhat$(echo .)com \
--cc=efremov@ispras$(echo .)ru \
--cc=erik.schmauss@intel$(echo .)com \
--cc=f.fainelli@gmail$(echo .)com \
--cc=federico.vaga@vaga$(echo .)pv.it \
--cc=feng.tang@intel$(echo .)com \
--cc=gregkh@linuxfoundation$(echo .)org \
--cc=harryxiyou@gmail$(echo .)com \
--cc=hpa@zytor$(echo .)com \
--cc=j.neuschaefer@gmx$(echo .)net \
--cc=jacek.anaszewski@gmail$(echo .)com \
--cc=james.morse@arm$(echo .)com \
--cc=jasowang@redhat$(echo .)com \
--cc=jglisse@redhat$(echo .)com \
--cc=jgross@suse$(echo .)com \
--cc=jkosina@suse$(echo .)cz \
--cc=jmorris@namei$(echo .)org \
--cc=joel@jms$(echo .)id.au \
--cc=jpoimboe@redhat$(echo .)com \
--cc=jroedel@suse$(echo .)de \
--cc=jwilk@jwilk$(echo .)net \
--cc=kamalesh@linux$(echo .)vnet.ibm.com \
--cc=kasong@redhat$(echo .)com \
--cc=keescook@chromium$(echo .)org \
--cc=khilman@baylibre$(echo .)com \
--cc=kirill.shutemov@linux$(echo .)intel.com \
--cc=kvm@vger$(echo .)kernel.org \
--cc=lenb@kernel$(echo .)org \
--cc=lgirdwood@gmail$(echo .)com \
--cc=linus.walleij@linaro$(echo .)org \
--cc=linux-acpi@vger$(echo .)kernel.org \
--cc=linux-amlogic@lists$(echo .)infradead.org \
--cc=linux-arm-kernel@lists$(echo .)infradead.org \
--cc=linux-arm-msm@vger$(echo .)kernel.org \
--cc=linux-doc@vger$(echo .)kernel.org \
--cc=linux-edac@vger$(echo .)kernel.org \
--cc=linux-gpio@vger$(echo .)kernel.org \
--cc=linux-i2c@vger$(echo .)kernel.org \
--cc=linux-kernel@vger$(echo .)kernel.org \
--cc=linux-kselftest@vger$(echo .)kernel.org \
--cc=linux-mm@kvack$(echo .)org \
--cc=linux-pci@vger$(echo .)kernel.org \
--cc=linux-security-module@vger$(echo .)kernel.org \
--cc=linux@armlinux$(echo .)org.uk \
--cc=linux@leemhuis$(echo .)info \
--cc=linuxppc-dev@lists$(echo .)ozlabs.org \
--cc=logang@deltatee$(echo .)com \
--cc=lorenzo.pieralisi@arm$(echo .)com \
--cc=luto@kernel$(echo .)org \
--cc=manfred@colorfullife$(echo .)com \
--cc=mark.rutland@arm$(echo .)com \
--cc=mcgrof@kernel$(echo .)org \
--cc=mhocko@suse$(echo .)com \
--cc=mika.westerberg@linux$(echo .)intel.com \
--cc=mingo@redhat$(echo .)com \
--cc=mst@redhat$(echo .)com \
--cc=netdev@vger$(echo .)kernel.org \
--cc=nicolas.ferre@microchip$(echo .)com \
--cc=olof@lixom$(echo .)net \
--cc=palmer@sifive$(echo .)com \
--cc=pasha.tatashin@oracle$(echo .)com \
--cc=paul.burton@mips$(echo .)com \
--cc=paulmck@linux$(echo .)ibm.com \
--cc=paulus@samba$(echo .)org \
--cc=peterz@infradead$(echo .)org \
--cc=platform-driver-x86@vger$(echo .)kernel.org \
--cc=quentin.perret@arm$(echo .)com \
--cc=raphael.gault@arm$(echo .)com \
--cc=rjw@rjwysocki$(echo .)net \
--cc=robert.moore@intel$(echo .)com \
--cc=robh+dt@kernel$(echo .)org \
--cc=robin.murphy@arm$(echo .)com \
--cc=rppt@linux$(echo .)ibm.com \
--cc=sakari.ailus@linux$(echo .)intel.com \
--cc=sam@mendozajonas$(echo .)com \
--cc=sean.j.christopherson@intel$(echo .)com \
--cc=serge@hallyn$(echo .)com \
--cc=sfr@canb$(echo .)auug.org.au \
--cc=shuah@kernel$(echo .)org \
--cc=sj38.park@gmail$(echo .)com \
--cc=sstabellini@kernel$(echo .)org \
--cc=sunilmut@microsoft$(echo .)com \
--cc=takahiro.akashi@linaro$(echo .)org \
--cc=tglx@linutronix$(echo .)de \
--cc=thesven73@gmail$(echo .)com \
--cc=thomas.preston@codethink$(echo .)co.uk \
--cc=tony.luck@intel$(echo .)com \
--cc=viro@zeniv$(echo .)linux.org.uk \
--cc=virtualization@lists$(echo .)linux-foundation.org \
--cc=will.deacon@arm$(echo .)com \
--cc=wsa@the-dreams$(echo .)de \
--cc=x86@kernel$(echo .)org \
--cc=xen-devel@lists$(echo .)xenproject.org \
--cc=yamada.masahiro@socionext$(echo .)com \
--cc=yannik@sembritzki$(echo .)me \
--cc=yuehaibing@huawei$(echo .)com \
--cc=zohar@linux$(echo .)ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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