mbox series

[v2,00/22] Some documentation fixes

Message ID cover.1559656538.git.mchehab+samsung@kernel.org
Headers show
Series Some documentation fixes | expand

Message

Mauro Carvalho Chehab June 4, 2019, 2:17 p.m. UTC
Fix several warnings and broken links.

This series was generated against linux-next, but was rebased to be applied at
docs-next. It should apply cleanly on either tree.

There's a git tree with all of them applied on the top of docs/docs-next
at:

https://git.linuxtv.org/mchehab/experimental.git/log/?h=fix_doc_links_v2

-

v2:

- added received acks/reviewed-by tags
- removed patches that got merged at linux-next
- Removed it_IT patches, as a different version was already submitted;
- removed mfd: madera: patch, assuming that it will be merged via
  some other tree;
- Removed the :orphan:  markups for KVM patches, as those are fixed
  at -next;
- zh_CN: use a different approach to fix duplicate references;
- added a patch moving protection-keys.rst to the core-api book;
- added 3 patches fixing new broken stuff:

	docs: isdn: remove hisax references from kernel-parameters.txt
	dt: bindings: fix some broken links from txt->yaml conversion
	docs: fix broken documentation links


Mauro Carvalho Chehab (22):
  ABI: sysfs-devices-system-cpu: point to the right docs
  isdn: mISDN: remove a bogus reference to a non-existing doc
  docs: zh_CN: get rid of basic_profiling.txt
  docs: mm: numaperf.rst: get rid of a build warning
  docs: bpf: get rid of two warnings
  docs: mark orphan documents as such
  docs: amd-memory-encryption.rst get rid of warnings
  gpu: i915.rst: Fix references to renamed files
  docs: zh_CN: avoid duplicate citation references
  docs: vm: hmm.rst: fix some warnings
  docs: it: license-rules.rst: get rid of warnings
  docs: gpio: driver.rst: fix a bad tag
  docs: soundwire: locking: fix tags for a code-block
  docs: security: trusted-encrypted.rst: fix code-block tag
  docs: security: core.rst: Fix several warnings
  docs: net: dpio-driver.rst: fix two codeblock warnings
  docs: net: sja1105.rst: fix table format
  docs: move protection-keys.rst to the core-api book
  docs: fix broken documentation links
  dt: bindings: fix some broken links from txt->yaml conversion
  docs: isdn: remove hisax references from kernel-parameters.txt
  docs: Kbuild/Makefile: allow check for missing docs at build time

 .../ABI/testing/sysfs-devices-system-cpu      |  3 +-
 Documentation/Kconfig                         | 13 ++++
 Documentation/Makefile                        |  5 ++
 Documentation/accelerators/ocxl.rst           |  2 +
 Documentation/acpi/dsd/leds.txt               |  2 +-
 .../admin-guide/kernel-parameters.rst         |  6 +-
 .../admin-guide/kernel-parameters.txt         | 19 +++--
 Documentation/admin-guide/mm/numaperf.rst     |  5 +-
 Documentation/admin-guide/ras.rst             |  2 +-
 Documentation/arm/stm32/overview.rst          |  2 +
 .../arm/stm32/stm32f429-overview.rst          |  2 +
 .../arm/stm32/stm32f746-overview.rst          |  2 +
 .../arm/stm32/stm32f769-overview.rst          |  2 +
 .../arm/stm32/stm32h743-overview.rst          |  2 +
 .../arm/stm32/stm32mp157-overview.rst         |  2 +
 Documentation/bpf/btf.rst                     |  2 +
 Documentation/core-api/index.rst              |  1 +
 .../{x86 => core-api}/protection-keys.rst     |  0
 .../bindings/media/st,stm32-dcmi.txt          |  2 +-
 .../devicetree/bindings/net/fsl-enetc.txt     |  7 +-
 .../bindings/pci/amlogic,meson-pcie.txt       |  2 +-
 .../regulator/qcom,rpmh-regulator.txt         |  2 +-
 .../bindings/sound/st,stm32-i2s.txt           |  2 +-
 .../bindings/sound/st,stm32-sai.txt           |  2 +-
 .../devicetree/booting-without-of.txt         |  2 +-
 Documentation/driver-api/gpio/board.rst       |  2 +-
 Documentation/driver-api/gpio/consumer.rst    |  2 +-
 Documentation/driver-api/gpio/driver.rst      |  2 +-
 .../driver-api/soundwire/locking.rst          |  4 +-
 .../firmware-guide/acpi/enumeration.rst       |  2 +-
 .../firmware-guide/acpi/method-tracing.rst    |  2 +-
 Documentation/gpu/i915.rst                    |  6 +-
 Documentation/gpu/msm-crash-dump.rst          |  2 +
 Documentation/i2c/instantiating-devices       |  2 +-
 Documentation/interconnect/interconnect.rst   |  2 +
 Documentation/laptops/lg-laptop.rst           |  2 +
 .../freescale/dpaa2/dpio-driver.rst           |  4 +-
 Documentation/networking/dsa/sja1105.rst      |  6 +-
 Documentation/powerpc/isa-versions.rst        |  2 +
 Documentation/security/keys/core.rst          | 16 +++--
 .../security/keys/trusted-encrypted.rst       |  4 +-
 Documentation/sysctl/kernel.txt               |  4 +-
 .../it_IT/process/license-rules.rst           | 28 ++++----
 .../translations/zh_CN/basic_profiling.txt    | 71 -------------------
 .../translations/zh_CN/process/4.Coding.rst   |  2 +-
 .../zh_CN/process/management-style.rst        |  4 +-
 .../zh_CN/process/programming-language.rst    | 59 +++++++++++----
 .../virtual/kvm/amd-memory-encryption.rst     |  3 +
 Documentation/vm/hmm.rst                      |  3 +-
 Documentation/x86/index.rst                   |  1 -
 Documentation/x86/x86_64/5level-paging.rst    |  2 +-
 Documentation/x86/x86_64/boot-options.rst     |  4 +-
 .../x86/x86_64/fake-numa-for-cpusets.rst      |  2 +-
 Kconfig                                       |  2 +
 MAINTAINERS                                   |  6 +-
 arch/arm/Kconfig                              |  2 +-
 arch/arm64/kernel/kexec_image.c               |  2 +-
 arch/powerpc/Kconfig                          |  2 +-
 arch/x86/Kconfig                              | 16 ++---
 arch/x86/Kconfig.debug                        |  2 +-
 arch/x86/boot/header.S                        |  2 +-
 arch/x86/entry/entry_64.S                     |  2 +-
 arch/x86/include/asm/bootparam_utils.h        |  2 +-
 arch/x86/include/asm/page_64_types.h          |  2 +-
 arch/x86/include/asm/pgtable_64_types.h       |  2 +-
 arch/x86/kernel/cpu/microcode/amd.c           |  2 +-
 arch/x86/kernel/kexec-bzimage64.c             |  2 +-
 arch/x86/kernel/pci-dma.c                     |  2 +-
 arch/x86/mm/tlb.c                             |  2 +-
 arch/x86/platform/pvh/enlighten.c             |  2 +-
 drivers/acpi/Kconfig                          | 10 +--
 drivers/isdn/mISDN/dsp_core.c                 |  2 -
 drivers/net/ethernet/faraday/ftgmac100.c      |  2 +-
 .../fieldbus/Documentation/fieldbus_dev.txt   |  4 +-
 drivers/vhost/vhost.c                         |  2 +-
 include/acpi/acpi_drivers.h                   |  2 +-
 include/linux/fs_context.h                    |  2 +-
 include/linux/lsm_hooks.h                     |  2 +-
 mm/Kconfig                                    |  2 +-
 scripts/documentation-file-ref-check          |  9 +++
 security/Kconfig                              |  2 +-
 tools/include/linux/err.h                     |  2 +-
 .../Documentation/stack-validation.txt        |  4 +-
 tools/testing/selftests/x86/protection_keys.c |  2 +-
 84 files changed, 227 insertions(+), 206 deletions(-)
 create mode 100644 Documentation/Kconfig
 rename Documentation/{x86 => core-api}/protection-keys.rst (100%)
 delete mode 100644 Documentation/translations/zh_CN/basic_profiling.txt

Comments

Jonathan Corbet June 7, 2019, 5:55 p.m. UTC | #1
On Tue,  4 Jun 2019 11:17:34 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:

> Fix several warnings and broken links.
> 
> This series was generated against linux-next, but was rebased to be applied at
> docs-next. It should apply cleanly on either tree.
> 
> There's a git tree with all of them applied on the top of docs/docs-next
> at:
> 
> https://git.linuxtv.org/mchehab/experimental.git/log/?h=fix_doc_links_v2

So I'll admit I've kind of lost track of which of these are applied, which
have comments, etc.  When you feel things have settled, can you get me an
updated set and I'll get them applied?

Thanks,

jon
Mauro Carvalho Chehab June 7, 2019, 6:44 p.m. UTC | #2
Em Fri, 7 Jun 2019 11:55:21 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Tue,  4 Jun 2019 11:17:34 -0300
> Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:
> 
> > Fix several warnings and broken links.
> > 
> > This series was generated against linux-next, but was rebased to be applied at
> > docs-next. It should apply cleanly on either tree.
> > 
> > There's a git tree with all of them applied on the top of docs/docs-next
> > at:
> > 
> > https://git.linuxtv.org/mchehab/experimental.git/log/?h=fix_doc_links_v2  
> 
> So I'll admit I've kind of lost track of which of these are applied, which
> have comments, etc.  When you feel things have settled, can you get me an
> updated set and I'll get them applied?

What I usually do here to check what was already applied (besides
looking e-mails) is to reset my tree against yours, then pull from
linux-next and pull from my old branch with those patches.

Then, I reset again to your tree, in order to make easier for you
to apply. It should be noticed that, due to this, you might actually
see a few more warnings on your tree, if a patch on this series
fix an issue that it is at linux next but didn't arrive your
tree.

Yet, all patches apply cleanly on your tree.

After doing that, there are 17 patches yet to be applied. Two new
patches are now needed too, due to vfs.txt -> vfs.rst and
pci.txt -> pci.rst renames.

The patches against your tree are at:

	https://git.linuxtv.org/mchehab/experimental.git/log/?h=fix_doc_links_v3.3

For convenience, I'm sending them again as a new patch series
(with the two extra patches fixing the recent issues).


Thanks,
Mauro
Jonathan Corbet June 8, 2019, 7:44 p.m. UTC | #3
On Fri, 7 Jun 2019 15:44:30 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:

> After doing that, there are 17 patches yet to be applied. Two new
> patches are now needed too, due to vfs.txt -> vfs.rst and
> pci.txt -> pci.rst renames.

OK, I've applied the set, minus those that had been picked up elsewhere.

Thanks,

jon
Mauro Carvalho Chehab June 9, 2019, 2:31 a.m. UTC | #4
Em Sat, 8 Jun 2019 13:44:07 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Fri, 7 Jun 2019 15:44:30 -0300
> Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:
> 
> > After doing that, there are 17 patches yet to be applied. Two new
> > patches are now needed too, due to vfs.txt -> vfs.rst and
> > pci.txt -> pci.rst renames.  
> 
> OK, I've applied the set, minus those that had been picked up elsewhere.

Thank you!

I'm sending the conversion patches based after your tree + linux-next.

I opted to split it on a few series, as I have already 85 patches
here (and still several new "orphan" index files that I need to work
in order to find them a place).

Sending right now the first 33 patches.


Thanks,
Mauro