| Message ID | 20230901125935.487972-1-eddyz87@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 3888fa134eddac467b5a094949a8f0731ef6ffd5 |
| Delegated to: | BPF |
| Headers | show |
| Series | [bpf] docs/bpf: Fix "file doesn't exist" warnings in {llvm_reloc,btf}.rst | expand |
On Fri, Sep 01, 2023 at 03:59:35PM +0300, Eduard Zingerman 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: > > :ref:`Documentation/bpf/btf.rst <BTF_Ext_Section>` > > Fixes: be4033d36070 ("docs/bpf: Add description for CO-RE relocations") > Reported-by: kernel test robot <lkp@intel.com> > Closes: https://lore.kernel.org/oe-kbuild-all/202309010804.G3MpXo59-lkp@intel.com/ > Signed-off-by: Eduard Zingerman <eddyz87@gmail.com> Acked-by: Jiri Olsa <jolsa@kernel.org> jirka > --- > Documentation/bpf/btf.rst | 2 +- > Documentation/bpf/llvm_reloc.rst | 2 +- > 2 files changed, 2 insertions(+), 2 deletions(-) > > diff --git a/Documentation/bpf/btf.rst b/Documentation/bpf/btf.rst > index ffc11afee569..e43c2fdafcd7 100644 > --- a/Documentation/bpf/btf.rst > +++ b/Documentation/bpf/btf.rst > @@ -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 > diff --git a/Documentation/bpf/llvm_reloc.rst b/Documentation/bpf/llvm_reloc.rst > index 73bf805000f2..44188e219d32 100644 > --- a/Documentation/bpf/llvm_reloc.rst > +++ b/Documentation/bpf/llvm_reloc.rst > @@ -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 > -- > 2.41.0 > >
Hello: This patch was applied to bpf/bpf.git (master) by Daniel Borkmann <daniel@iogearbox.net>: 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!
diff --git a/Documentation/bpf/btf.rst b/Documentation/bpf/btf.rst index ffc11afee569..e43c2fdafcd7 100644 --- a/Documentation/bpf/btf.rst +++ b/Documentation/bpf/btf.rst @@ -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 diff --git a/Documentation/bpf/llvm_reloc.rst b/Documentation/bpf/llvm_reloc.rst index 73bf805000f2..44188e219d32 100644 --- a/Documentation/bpf/llvm_reloc.rst +++ b/Documentation/bpf/llvm_reloc.rst @@ -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
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") Reported-by: kernel test robot <lkp@intel.com> Closes: https://lore.kernel.org/oe-kbuild-all/202309010804.G3MpXo59-lkp@intel.com/ Signed-off-by: Eduard Zingerman <eddyz87@gmail.com> --- Documentation/bpf/btf.rst | 2 +- Documentation/bpf/llvm_reloc.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)