[PATCH v2 00/20] Update Documentation/ cross-references

[PATCH v2 00/20] Update Documentation/ cross-references

[Mauro Carvalho Chehab]

Fix most broken documentation file cross references on next-20220624.

After this series, only 3 references will be broken:

Warning: Documentation/dev-tools/kunit/run_wrapper.rst references a file that doesn't exist: Documentation/dev-tools/kunit/non_uml.rst
Warning: Documentation/devicetree/bindings/regulator/siliconmitus,sm5703-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/siliconmitus,sm5703.yaml
Warning: drivers/acpi/device_pm.c references a file that doesn't exist: Documentation/firmware-guide/acpi/low-power-probe.rst

All of them seem to be due to the lack of a patch actually adding the
documentation. Maybe the document file is still under review?

Regards,
Mauro

Mauro Carvalho Chehab (20):
  docs: netdev: update maintainer-netdev.rst reference
  docs: filesystems: update netfs-api.rst reference
  docs: zh_CN: page_frags.rst: fix a broken reference
  docs: zh_CN/riscv/pmu.rst: remove old docuementation
  docs: zh_CN/devicetree: fix typos
  docs: zh_CN: fix a broken reference
  docs: zh_CN/vm: fix a typo for page reporting ReST file
  docs: zh_CN/vm/zsmalloc.rst: fix a typo
  docs: zh_CN/vm/index.rst: fix a broken reference
  Documentation: update watch_queue.rst references
  Documentation: KVM: update s390-pv.rst reference
  Documentation: KVM: update amd-memory-encryption.rst references
  Documentation: KVM: update msr.rst reference
  Documentation: KVM: update s390-diag.rst reference
  objtool: update objtool.txt references
  arch: m68k: q40: README: drop references to IDE driver
  tegra194-hte.rst: fix reference to its binding
  dt-bindings: mfd: update dlg,da9063.yaml reference
  MAINTAINERS: update nvidia,tegra20-host1x.yaml reference
  MAINTAINERS: fix cross references to mfd/dlg,da9063.yaml

 .../admin-guide/kernel-parameters.txt         |   2 +-
 .../bindings/input/da9062-onkey.txt           |   2 +-
 Documentation/driver-api/hte/tegra194-hte.rst |   2 +-
 Documentation/security/keys/core.rst          |   2 +-
 Documentation/security/secrets/coco.rst       |   2 +-
 .../it_IT/networking/netdev-FAQ.rst           |   2 +-
 .../translations/zh_CN/devicetree/index.rst   |   2 +-
 .../zh_CN/devicetree/of_unittest.rst          |   2 +-
 .../zh_CN/devicetree/usage-model.rst          |   2 +-
 .../zh_CN/doc-guide/kernel-doc.rst            |   2 +-
 .../translations/zh_CN/riscv/index.rst        |   1 -
 .../translations/zh_CN/riscv/pmu.rst          | 235 ------------------
 .../zh_CN/vm/free_page_reporting.rst          |   2 +-
 .../translations/zh_CN/vm/frontswap.rst       |   2 +-
 Documentation/translations/zh_CN/vm/index.rst |   2 +-
 .../translations/zh_CN/vm/page_frags.rst      |   2 +-
 .../translations/zh_CN/vm/zsmalloc.rst        |   2 +-
 Documentation/virt/kvm/api.rst                |   4 +-
 Documentation/virt/kvm/s390/s390-pv-boot.rst  |   2 +-
 Documentation/virt/kvm/x86/hypercalls.rst     |   2 +-
 Documentation/x86/orc-unwinder.rst            |   2 +-
 MAINTAINERS                                   |   6 +-
 arch/m68k/q40/README                          |   5 +-
 include/linux/fscache.h                       |   2 +-
 include/linux/objtool.h                       |   2 +-
 include/linux/watch_queue.h                   |   2 +-
 init/Kconfig                                  |   2 +-
 kernel/watch_queue.c                          |   2 +-
 lib/Kconfig.debug                             |   2 +-
 tools/include/linux/objtool.h                 |   2 +-
 tools/objtool/check.c                         |   2 +-
 31 files changed, 33 insertions(+), 270 deletions(-)
 delete mode 100644 Documentation/translations/zh_CN/riscv/pmu.rst

-- 
2.36.1

[PATCH v2 06/20] docs: zh_CN: fix a broken reference

[Mauro Carvalho Chehab]

The location of the rust doc is wrong (probably a typo). Fix it.

Fixes: 3a5915156429 ("docs/zh_CN: Add translation zh_CN/doc-guide/kernel-doc.rst")
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH v2 00/20] at: https://lore.kernel.org/all/cover.1656234456.git.mchehab@kernel.org/

 Documentation/translations/zh_CN/doc-guide/kernel-doc.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst b/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
index 82ec84470c0b..ccfb9b8329c2 100644
--- a/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
+++ b/Documentation/translations/zh_CN/doc-guide/kernel-doc.rst
@@ -14,7 +14,7 @@ Linux内核源文件可以包含kernel-doc格式的结构化文档注释，用
           实际有着明显的不同。内核源包含成千上万个kernel-doc注释。请坚持遵循
           此处描述的风格。
 
-.. note:: kernel-doc无法包含Rust代码：请参考 Documentation/rust/docs.rst 。
+.. note:: kernel-doc无法包含Rust代码：请参考 Documentation/rust/general-information.rst 。
 
 从注释中提取kernel-doc结构，并从中生成适当的 `Sphinx C 域`_ 函数和带有锚点的
 类型描述。这些注释将被过滤以生成特殊kernel-doc高亮和交叉引用。详见下文。
-- 
2.36.1

Re: [PATCH v2 06/20] docs: zh_CN: fix a broken reference

[Miguel Ojeda]

On Sun, Jun 26, 2022 at 11:11 AM Mauro Carvalho Chehab
<mchehab@kernel.org> wrote:
>
> The location of the rust doc is wrong (probably a typo). Fix it.

Thanks Mauro -- it was the old location of the document. For some
reason, the translated docs have bits from -next.

Cheers,
Miguel

Re: [PATCH v2 00/20] Update Documentation/ cross-references

[Jonathan Corbet]

Mauro Carvalho Chehab <mchehab@kernel.org> writes:

> Fix most broken documentation file cross references on next-20220624.
>
> After this series, only 3 references will be broken:

OK, I've applied everything except parts 4, 9, and 20.

Thanks,

jon