Skip to contentSkip to conversation

docs/bpf: Fix "file doesn't exist" warnings in {llvm_reloc,btf}.rst

PATCH Applied Eduard Zingerman 3 participants 3 messages Sep 1, 2023

Subsystems (2)
lore
Share & tools
lore

Eduard Zingerman

author maintainer
#0 lore raw

PATCH 1/1 docs/bpf: Fix "file doesn't exist" warnings in {llvm_reloc,btf}.rst

scripts/documentation-file-ref-check reports warnings for (valid) cross-links of form:

:ref:Documentation/bpf/btf <BTF_Ext_Section>

Adding extension to the file name helps to avoid the warning, e.g:

:ref:Documentation/bpf/btf.rst <BTF_Ext_Section>

Fixes be4033d36070 ("docs/bpf: Add description for CO-RE relocations")
---
 Documentation/bpf/btf.rst        | 2 +-
 Documentation/bpf/llvm_reloc.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/bpf/btf.rst +1 -1
index ffc11afee569..e43c2fdafcd7 100644
@@ -803,7 +803,7 @@ structure when .BTF.ext is generated. All ``bpf_core_relo`` structures
 within a single ``btf_ext_info_sec`` describe relocations applied to
 section named by ``btf_ext_info_sec->sec_name_off``.
 
-See :ref:`Documentation/bpf/llvm_reloc <btf-co-re-relocations>`
+See :ref:`Documentation/bpf/llvm_reloc.rst <btf-co-re-relocations>`
 for more information on CO-RE relocations.
 
 4.2 .BTF_ids section
Documentation/bpf/llvm_reloc.rst +1 -1
index 73bf805000f2..44188e219d32 100644
@@ -250,7 +250,7 @@ CO-RE Relocations
 From object file point of view CO-RE mechanism is implemented as a set
 of CO-RE specific relocation records. These relocation records are not
 related to ELF relocations and are encoded in .BTF.ext section.
-See :ref:`Documentation/bpf/btf <BTF_Ext_Section>` for more
+See :ref:`Documentation/bpf/btf.rst <BTF_Ext_Section>` for more
 information on .BTF.ext structure.
 
 CO-RE relocations are applied to BPF instructions to update immediate
Signature · 1 line
2.41.0
Acked-by on v1 1/1
#1 lore raw
Quoted 5 lines · Eduard Zingerman

scripts/documentation-file-ref-check reports warnings for (valid) cross-links of form:

:ref:Documentation/bpf/btf <BTF_Ext_Section>

Quoted 8 lines

Adding extension to the file name helps to avoid the warning, e.g:

:ref:Documentation/bpf/btf.rst <BTF_Ext_Section>

Fixes be4033d36070 ("docs/bpf: Add description for CO-RE relocations")

jirka

Quoted 35 lines
---
 Documentation/bpf/btf.rst        | 2 +-
 Documentation/bpf/llvm_reloc.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/bpf/btf.rst +1 -1
index ffc11afee569..e43c2fdafcd7 100644
@@ -803,7 +803,7 @@ structure when .BTF.ext is generated. All ``bpf_core_relo`` structures
 within a single ``btf_ext_info_sec`` describe relocations applied to
 section named by ``btf_ext_info_sec->sec_name_off``.
 
-See :ref:`Documentation/bpf/llvm_reloc <btf-co-re-relocations>`
+See :ref:`Documentation/bpf/llvm_reloc.rst <btf-co-re-relocations>`
 for more information on CO-RE relocations.
 
 4.2 .BTF_ids section
Documentation/bpf/llvm_reloc.rst +1 -1
index 73bf805000f2..44188e219d32 100644
@@ -250,7 +250,7 @@ CO-RE Relocations
 From object file point of view CO-RE mechanism is implemented as a set
 of CO-RE specific relocation records. These relocation records are not
 related to ELF relocations and are encoded in .BTF.ext section.
-See :ref:`Documentation/bpf/btf <BTF_Ext_Section>` for more
+See :ref:`Documentation/bpf/btf.rst <BTF_Ext_Section>` for more
 information on .BTF.ext structure.
 
 CO-RE relocations are applied to BPF instructions to update immediate
Signature · 1 line
2.41.0
#2 lore raw
In reply to Eduard Zingerman
This patch was applied to bpf/bpf.git (master) by Daniel Borkmann <[email protected]>:

Hello:

This patch was applied to bpf/bpf.git (master)
by Daniel Borkmann <[email protected]>:

Quoted 8 lines · On Fri, 1 Sep 2023 15:59:35 +0300 you wrote:

scripts/documentation-file-ref-check reports warnings for (valid) cross-links of form:

:ref:Documentation/bpf/btf <BTF_Ext_Section>

Adding extension to the file name helps to avoid the warning, e.g:

[...]

Here is the summary with links:
- [bpf] docs/bpf: Fix "file doesn't exist" warnings in {llvm_reloc,btf}.rst

    https://git.kernel.org/bpf/bpf/c/3888fa134edd

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html