mbox series

[v2,00/23] Fix some issues at documentation

Message ID cover.1631785820.git.mchehab+huawei@kernel.org
Headers show
Series Fix some issues at documentation | expand

Message

Mauro Carvalho Chehab Sept. 16, 2021, 9:54 a.m. UTC
Hi John,

Please ignore the previous series I sent today [1].  I forgot that I had
already submitted a first version of this series.

[1]  https://lore.kernel.org/all/cover.1631783482.git.mchehab+huawei@kernel.org/


The first patch in this series fix a bad character used instead of
a "(c)" UTF-8 symbol.

The remaining ones fix several broken references to files
under Documentation/, several due to DT schema conversions
from .txt to .yaml.

---

v2:
   - Added a couple of extra fixes;
   - merged two patches touching mtd-physmap.yaml;
   - added missing tags (acked-by/reviewed-by) received after v1.
v1: https://lore.kernel.org/all/cover.1626947923.git.mchehab+huawei@kernel.org/



Mauro Carvalho Chehab (23):
  visorbus: fix a copyright symbol that was bad encoded
  dt-bindings: net: dsa: sja1105: update nxp,sja1105.yaml reference
  dt-bindings: arm: mediatek: mmsys: update mediatek,mmsys.yaml
    reference
  dt-bindings: w1: update w1-gpio.yaml reference
  dt-bindings: mmc: update mmc-card.yaml reference
  libbpf: update index.rst reference
  docs: accounting: update delay-accounting.rst reference
  tools: bpftool: update bpftool-prog.rst reference
  tools: bpftool: update bpftool-map.rst reference
  bpftool: update bpftool-cgroup.rst reference
  MAINTAINERS: update arm,vic.yaml reference
  MAINTAINERS: update aspeed,i2c.yaml reference
  MAINTAINERS: update faraday,ftrtc010.yaml reference
  MAINTAINERS: update fsl,fec.yaml reference
  MAINTAINERS: update ti,sci.yaml reference
  MAINTAINERS: update intel,ixp46x-rng.yaml reference
  MAINTAINERS: update nxp,imx8-jpeg.yaml reference
  MAINTAINERS: update gemini.yaml reference
  MAINTAINERS: update brcm,unimac-mdio.yaml reference
  MAINTAINERS: update chipone,icn8318.yaml reference
  MAINTAINERS: update silergy,sy8106a.yaml reference
  MAINTAINERS: update mtd-physmap.yaml reference
  MAINTAINERS: update ti,am654-hbmc.yaml reference

 Documentation/admin-guide/sysctl/kernel.rst   |  2 +-
 Documentation/bpf/index.rst                   |  2 +-
 .../display/mediatek/mediatek,disp.txt        |  2 +-
 Documentation/networking/dsa/sja1105.rst      |  2 +-
 Documentation/w1/masters/w1-gpio.rst          |  2 +-
 MAINTAINERS                                   | 28 +++++++++----------
 drivers/mmc/host/omap_hsmmc.c                 |  2 +-
 drivers/visorbus/visorbus_main.c              |  2 +-
 .../selftests/bpf/test_bpftool_synctypes.py   |  6 ++--
 9 files changed, 24 insertions(+), 24 deletions(-)

Comments

Andrii Nakryiko Sept. 17, 2021, 5:18 p.m. UTC | #1
On Thu, Sep 16, 2021 at 2:55 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>

> The file name: Documentation/bpftool-prog.rst

> should be, instead: tools/bpf/bpftool/Documentation/bpftool-prog.rst.

>

> Update its cross-reference accordingly.

>

> Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")

> Fixes: ff69c21a85a4 ("tools: bpftool: add documentation")

> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

> ---

>  tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-

>  1 file changed, 1 insertion(+), 1 deletion(-)

>

> diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py

> index be54b7335a76..27a2c369a798 100755

> --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py

> +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py

> @@ -374,7 +374,7 @@ class ManProgExtractor(ManPageExtractor):

>      """

>      An extractor for bpftool-prog.rst.

>      """

> -    filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-prog.rst')

> +    filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-prog.rst')


Same as on another patch, this is wrong, BPFTOOL_DIR points to the
correct bpftool path already

>

>      def get_attach_types(self):

>          return self.get_rst_list('ATTACH_TYPE')

> --

> 2.31.1

>
Andrii Nakryiko Sept. 17, 2021, 5:19 p.m. UTC | #2
On Thu, Sep 16, 2021 at 2:55 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>

> The file name: Documentation/bpftool-cgroup.rst

> should be, instead: tools/bpf/bpftool/Documentation/bpftool-cgroup.rst.

>

> Update its cross-reference accordingly.

>

> Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")

> Fixes: 5ccda64d38cc ("bpftool: implement cgroup bpf operations")

> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

> ---

>  tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-

>  1 file changed, 1 insertion(+), 1 deletion(-)

>

> diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py

> index 2d7eb683bd5a..c974abd4db13 100755

> --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py

> +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py

> @@ -392,7 +392,7 @@ class ManCgroupExtractor(ManPageExtractor):

>      """

>      An extractor for bpftool-cgroup.rst.

>      """

> -    filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-cgroup.rst')

> +    filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-cgroup.rst')


Same, this is wrong, please double-check all bpftool path adjustments,
in case you didn't CC me on all of the related patches. Thanks!

>

>      def get_attach_types(self):

>          return self.get_rst_list('ATTACH_TYPE')

> --

> 2.31.1

>