* [PATCH 00/10] Documentation build warning fixes
@ 2021-05-19 8:51 Mauro Carvalho Chehab
2021-05-19 8:51 ` [PATCH 02/10] docs: vcpu-requests.rst: fix reference for atomic ops Mauro Carvalho Chehab
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2021-05-19 8:51 UTC (permalink / raw)
To: Linux Doc Mailing List, Jonathan Corbet
Cc: Mauro Carvalho Chehab, linux-kernel, Greg Kroah-Hartman,
Daniel Thompson, Jingoo Han, Jonathan Cameron,
Lars-Peter Clausen, Lee Jones, Linus Walleij, alsa-devel,
dri-devel, kvm, linux-gpio, linux-iio, patches
Hi Jon,
This small series contain a series of fixes for the documentation. it is
against your docs-next branch.
Three of the patches fix duplicated symbols at the ABI documents.
There are still some ABI warnings from IIO, but all but one were
already fixed at linux-next. So, hopefully, after having everything
merged, the ABI warnings will be solved.
Mauro Carvalho Chehab (10):
docs: update sysfs-platform_profile.rst reference
docs: vcpu-requests.rst: fix reference for atomic ops
docs: translations/zh_CN: fix a typo at 8.Conclusion.rst
docs: sched-bwc.rst: fix a typo on a doc name
docs: update pin-control.rst references
docs: virt: api.rst: fix a pointer to SGX documentation
docs: ABI: iommu: remove duplicated definition for
sysfs-kernel-iommu_groups
docs: ABI: sysfs-class-backlight: unify ambient light zone nodes
docs: ABI: sysfs-class-led-trigger-pattern: remove repeat duplication
iio: documentation: fix a typo
Documentation/ABI/testing/sysfs-bus-iio | 4 +-
.../ABI/testing/sysfs-class-backlight | 100 ++++++++++++++++++
.../ABI/testing/sysfs-class-backlight-adp5520 | 31 ------
.../ABI/testing/sysfs-class-backlight-adp8860 | 37 -------
.../sysfs-class-backlight-driver-adp8870 | 32 ------
.../testing/sysfs-class-led-driver-el15203000 | 9 --
.../testing/sysfs-class-led-trigger-pattern | 3 +
.../ABI/testing/sysfs-kernel-iommu_groups | 12 +--
Documentation/scheduler/sched-bwc.rst | 2 +-
.../zh_CN/process/8.Conclusion.rst | 2 +-
Documentation/virt/kvm/api.rst | 2 +-
Documentation/virt/kvm/vcpu-requests.rst | 2 +-
include/linux/device.h | 2 +-
include/linux/mfd/madera/pdata.h | 2 +-
include/linux/pinctrl/pinconf-generic.h | 2 +-
include/linux/platform_profile.h | 2 +-
16 files changed, 117 insertions(+), 127 deletions(-)
delete mode 100644 Documentation/ABI/testing/sysfs-class-backlight-adp5520
delete mode 100644 Documentation/ABI/testing/sysfs-class-backlight-adp8860
delete mode 100644 Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870
delete mode 100644 Documentation/ABI/testing/sysfs-class-led-driver-el15203000
--
2.31.1
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH 02/10] docs: vcpu-requests.rst: fix reference for atomic ops
2021-05-19 8:51 [PATCH 00/10] Documentation build warning fixes Mauro Carvalho Chehab
@ 2021-05-19 8:51 ` Mauro Carvalho Chehab
2021-05-19 8:51 ` [PATCH 06/10] docs: virt: api.rst: fix a pointer to SGX documentation Mauro Carvalho Chehab
2021-05-20 20:00 ` [PATCH 00/10] Documentation build warning fixes Jonathan Corbet
2 siblings, 0 replies; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2021-05-19 8:51 UTC (permalink / raw)
To: Linux Doc Mailing List, Jonathan Corbet
Cc: Mauro Carvalho Chehab, Paolo Bonzini, Peter Zijlstra, kvm, linux-kernel
Changeset f0400a77ebdc ("atomic: Delete obsolete documentation")
got rid of atomic_ops.rst, pointing that this was superseded by
Documentation/atomic_*.txt.
Update its reference accordingly.
Fixes: f0400a77ebdc ("atomic: Delete obsolete documentation")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/virt/kvm/vcpu-requests.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/virt/kvm/vcpu-requests.rst b/Documentation/virt/kvm/vcpu-requests.rst
index 5feb3706a7ae..5f8798e7fdf8 100644
--- a/Documentation/virt/kvm/vcpu-requests.rst
+++ b/Documentation/virt/kvm/vcpu-requests.rst
@@ -302,6 +302,6 @@ VCPU returns from the call.
References
==========
-.. [atomic-ops] Documentation/core-api/atomic_ops.rst
+.. [atomic-ops] Documentation/atomic_bitops.txt and Documentation/atomic_t.txt
.. [memory-barriers] Documentation/memory-barriers.txt
.. [lwn-mb] https://lwn.net/Articles/573436/
--
2.31.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH 06/10] docs: virt: api.rst: fix a pointer to SGX documentation
2021-05-19 8:51 [PATCH 00/10] Documentation build warning fixes Mauro Carvalho Chehab
2021-05-19 8:51 ` [PATCH 02/10] docs: vcpu-requests.rst: fix reference for atomic ops Mauro Carvalho Chehab
@ 2021-05-19 8:51 ` Mauro Carvalho Chehab
2021-05-20 20:00 ` [PATCH 00/10] Documentation build warning fixes Jonathan Corbet
2 siblings, 0 replies; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2021-05-19 8:51 UTC (permalink / raw)
To: Linux Doc Mailing List, Jonathan Corbet
Cc: Mauro Carvalho Chehab, Paolo Bonzini, kvm, linux-kernel
The document which describes the SGX kernel architecture was added at
commit 3fa97bf00126 ("Documentation/x86: Document SGX kernel architecture")
but the reference at virt/kvm/api.rst is pointing to some
non-existing document.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/virt/kvm/api.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 22d077562149..e86fe3481574 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -6360,7 +6360,7 @@ system fingerprint. To prevent userspace from circumventing such restrictions
by running an enclave in a VM, KVM prevents access to privileged attributes by
default.
-See Documentation/x86/sgx/2.Kernel-internals.rst for more details.
+See Documentation/x86/sgx.rst for more details.
8. Other capabilities.
======================
--
2.31.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH 00/10] Documentation build warning fixes
2021-05-19 8:51 [PATCH 00/10] Documentation build warning fixes Mauro Carvalho Chehab
2021-05-19 8:51 ` [PATCH 02/10] docs: vcpu-requests.rst: fix reference for atomic ops Mauro Carvalho Chehab
2021-05-19 8:51 ` [PATCH 06/10] docs: virt: api.rst: fix a pointer to SGX documentation Mauro Carvalho Chehab
@ 2021-05-20 20:00 ` Jonathan Corbet
2 siblings, 0 replies; 4+ messages in thread
From: Jonathan Corbet @ 2021-05-20 20:00 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Greg Kroah-Hartman,
Daniel Thompson, Jingoo Han, Jonathan Cameron,
Lars-Peter Clausen, Lee Jones, Linus Walleij, alsa-devel,
dri-devel, kvm, linux-gpio, linux-iio, patches
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> Hi Jon,
>
> This small series contain a series of fixes for the documentation. it is
> against your docs-next branch.
>
> Three of the patches fix duplicated symbols at the ABI documents.
> There are still some ABI warnings from IIO, but all but one were
> already fixed at linux-next. So, hopefully, after having everything
> merged, the ABI warnings will be solved.
>
> Mauro Carvalho Chehab (10):
> docs: update sysfs-platform_profile.rst reference
> docs: vcpu-requests.rst: fix reference for atomic ops
> docs: translations/zh_CN: fix a typo at 8.Conclusion.rst
> docs: sched-bwc.rst: fix a typo on a doc name
> docs: update pin-control.rst references
> docs: virt: api.rst: fix a pointer to SGX documentation
> docs: ABI: iommu: remove duplicated definition for
> sysfs-kernel-iommu_groups
> docs: ABI: sysfs-class-backlight: unify ambient light zone nodes
> docs: ABI: sysfs-class-led-trigger-pattern: remove repeat duplication
> iio: documentation: fix a typo
Seems like good stuff. The last patch in the series, though, adds a
warning:
Documentation/ABI/testing/sysfs-bus-iio:799: WARNING: Inline emphasis start-string without end-string.
So I left that one out and applied the rest.
Thanks,
jon
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-05-20 20:00 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-19 8:51 [PATCH 00/10] Documentation build warning fixes Mauro Carvalho Chehab
2021-05-19 8:51 ` [PATCH 02/10] docs: vcpu-requests.rst: fix reference for atomic ops Mauro Carvalho Chehab
2021-05-19 8:51 ` [PATCH 06/10] docs: virt: api.rst: fix a pointer to SGX documentation Mauro Carvalho Chehab
2021-05-20 20:00 ` [PATCH 00/10] Documentation build warning fixes Jonathan Corbet
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).