Skip to contentSkip to conversation

doc: fix references to driver-model

PATCH New Heinrich Schuchardt 4 participants 7 messages Feb 25, 2020 – Apr 21, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: fix references to driver-model

Fix some errors pointed out by 'make refcheckdocs'.

---
 doc/README.drivers.eth     | 2 +-
 doc/README.fdt-control     | 2 +-
 drivers/i2c/davinci_i2c.c  | 2 +-
 drivers/i2c/kona_i2c.c     | 2 +-
 drivers/i2c/sh_i2c.c       | 2 +-
 drivers/i2c/soft_i2c.c     | 2 +-
 tools/dtoc/dtb_platdata.py | 4 ++--
 tools/dtoc/dtoc.py         | 2 +-
 8 files changed, 9 insertions(+), 9 deletions(-)
doc/README.drivers.eth +1 -1
index 1a9a23b51b..acaf11fea3 100644
@@ -2,7 +2,7 @@
 
 This guide describes to the old way of doing things. No new Ethernet drivers
 should be implemented this way. All new drivers should be written against the
-U-Boot core driver model. See doc/driver-model/README.txt
+U-Boot core driver model. See doc/driver-model/index.rst.
 
 -----------------------
  Ethernet Driver Guide
doc/README.fdt-control +1 -1
index e53cf51875..424d13fc5b 100644
@@ -182,7 +182,7 @@ U-Boot can be divided into three phases: TPL, SPL and U-Boot proper.
 
 The full device tree is available to U-Boot proper, but normally only a subset
 (or none at all) is available to TPL and SPL. See 'Pre-Relocation Support' and
-'SPL Support' in doc/driver-model/README.txt for more details.
+'SPL Support' in doc/driver-model/design.rst for more details.
 
 
 Using several DTBs in the SPL (CONFIG_SPL_MULTI_DTB)
drivers/i2c/davinci_i2c.c +1 -1
index 2c77234c60..edc40f706c 100644
@@ -8,7 +8,7 @@
  * --------------------------------------------------------
  *
  * NOTE: This driver should be converted to driver model before June 2017.
- * Please see doc/driver-model/i2c-howto.txt for instructions.
+ * Please see doc/driver-model/i2c-howto.rst for instructions.
  */
 
 #include <common.h>
drivers/i2c/kona_i2c.c +1 -1
index 0726b4c956..8e31481c0f 100644
@@ -3,7 +3,7 @@
  * Copyright 2013 Broadcom Corporation.
  *
  * NOTE: This driver should be converted to driver model before June 2017.
- * Please see doc/driver-model/i2c-howto.txt for instructions.
+ * Please see doc/driver-model/i2c-howto.rst for instructions.
  */
 
 #include <common.h>
drivers/i2c/sh_i2c.c +1 -1
index b69d213593..834f1f2179 100644
@@ -4,7 +4,7 @@
  * Copyright (C) 2011, 2013 Nobuhiro Iwamatsu <[email protected]>
  *
  * NOTE: This driver should be converted to driver model before June 2017.
- * Please see doc/driver-model/i2c-howto.txt for instructions.
+ * Please see doc/driver-model/i2c-howto.rst for instructions.
  */
 
 #include <common.h>
drivers/i2c/soft_i2c.c +1 -1
index 7f0303cc05..9ad1c281ff 100644
@@ -12,7 +12,7 @@
  * Neil Russell.
  *
  * NOTE: This driver should be converted to driver model before June 2017.
- * Please see doc/driver-model/i2c-howto.txt for instructions.
+ * Please see doc/driver-model/i2c-howto.rst for instructions.
  */
 
 #include <common.h>
tools/dtoc/dtb_platdata.py +2 -2
index 037e82c8bb..90a9e1a626 100644
@@ -423,7 +423,7 @@ class DtbPlatdata(object):
 
         This writes out the body of a header file consisting of structure
         definitions for node in self._valid_nodes. See the documentation in
-        README.of-plat for more information.
+        doc/driver-model/of-plat.rst for more information.
         """
         self.out_header()
         self.out('#include <stdbool.h>\n')
@@ -527,7 +527,7 @@ class DtbPlatdata(object):
         U_BOOT_DEVICE() declarations for each valid node. Where a node has
         multiple compatible strings, a #define is used to make them equivalent.
 
-        See the documentation in doc/driver-model/of-plat.txt for more
+        See the documentation in doc/driver-model/of-plat.rst for more
         information.
         """
         self.out_header()
tools/dtoc/dtoc.py +1 -1
index b3596a5918..f31cba900e 100755
@@ -22,7 +22,7 @@ Dtoc produces two output files:
 This tool is used in U-Boot to provide device tree data to SPL without
 increasing the code size of SPL. This supports the CONFIG_SPL_OF_PLATDATA
 options. For more information about the use of this options and tool please
-see doc/driver-model/of-plat.txt
+see doc/driver-model/of-plat.rst
 """
 
 from __future__ import print_function

--
2.25.0

#1 lore raw

PATCH 1/1 doc: fix references to driver-model

Quoted 4 lines · Heinrich Schuchardt

Fix some errors pointed out by 'make refcheckdocs'.

Quoted 10 lines
---
 doc/README.drivers.eth     | 2 +-
 doc/README.fdt-control     | 2 +-
 drivers/i2c/davinci_i2c.c  | 2 +-
 drivers/i2c/kona_i2c.c     | 2 +-
 drivers/i2c/sh_i2c.c       | 2 +-
 drivers/i2c/soft_i2c.c     | 2 +-
 tools/dtoc/dtb_platdata.py | 4 ++--
 tools/dtoc/dtoc.py         | 2 +-
 8 files changed, 9 insertions(+), 9 deletions(-)
#2 lore raw

PATCH 1/1 doc: fix references to driver-model

In reply to Heinrich Schuchardt

Hi Heinrich

Quoted 7 lines

From: U-Boot <[email protected]> On Behalf Of Heinrich Schuchardt
Sent: mardi 25 f?vrier 2020 21:36

Fix some errors pointed out by 'make refcheckdocs'.

---

I found also the same issue in

-------------------------------- doc/README.SPL -------------------------------- index 4e3478a13a..929b9672b0 100644
@@ -81,7 +81,7 @@ fdtgrep is also used to remove:
('u-boot,dm-pre-reloc', 'u-boot,dm-spl' and 'u-boot,dm-tpl')

All the nodes remaining in the SPL devicetree are bound
-(see driver-model/README.txt).
+(see driver-model/design.rst).

Debugging
---------

Quoted 17 lines
 doc/README.drivers.eth     | 2 +-
 doc/README.fdt-control     | 2 +-
 drivers/i2c/davinci_i2c.c  | 2 +-
 drivers/i2c/kona_i2c.c     | 2 +-
 drivers/i2c/sh_i2c.c       | 2 +-
 drivers/i2c/soft_i2c.c     | 2 +-
 tools/dtoc/dtb_platdata.py | 4 ++--
 tools/dtoc/dtoc.py         | 2 +-
 8 files changed, 9 insertions(+), 9 deletions(-)
doc/README.drivers.eth index renamed from doc/README.drivers.eth +0 -0

1a9a23b51b..acaf11fea3 100644

doc/README.drivers.eth +0 -0
@@ -2,7 +2,7 @@
 
 This guide describes to the old way of doing things. No new Ethernet drivers
Quoted 3 lines

should be implemented this way. All new drivers should be written against the -U- Boot core driver model. See doc/driver-model/README.txt
+U-Boot core driver model. See doc/driver-model/index.rst.

index.rst or design.rst as in the next file ?

doc/driver-model/README.txt is replaced by design.rst in commit ed205e677b6f ('doc: driver-model: Convert README.txt to rest')

Quoted 103 lines

-----------------------
Ethernet Driver Guide

doc/README.fdt-control index renamed from doc/README.fdt-control +0 -0

e53cf51875..424d13fc5b 100644

doc/README.fdt-control +0 -0
@@ -182,7 +182,7 @@ U-Boot can be divided into three phases: TPL, SPL and U-

Boot proper.

The full device tree is available to U-Boot proper, but normally only a subset (or
none at all) is available to TPL and SPL. See 'Pre-Relocation Support' and -'SPL Support' in doc/driver-model/README.txt for more details.
+'SPL Support' in doc/driver-model/design.rst for more details.

Using several DTBs in the SPL (CONFIG_SPL_MULTI_DTB) diff --git
a/drivers/i2c/davinci_i2c.c b/drivers/i2c/davinci_i2c.c index 2c77234c60..edc40f706c 100644

drivers/i2c/davinci_i2c.c +1 -1
@@ -8,7 +8,7 @@
  * --------------------------------------------------------
  *
  * NOTE: This driver should be converted to driver model before June 2017.
- * Please see doc/driver-model/i2c-howto.txt for instructions.
+ * Please see doc/driver-model/i2c-howto.rst for instructions.
  */
 
 #include <common.h>
drivers/i2c/kona_i2c.c index renamed from drivers/i2c/kona_i2c.c +0 -0

0726b4c956..8e31481c0f 100644

drivers/i2c/kona_i2c.c +1 -1
@@ -3,7 +3,7 @@
  * Copyright 2013 Broadcom Corporation.
  *
  * NOTE: This driver should be converted to driver model before June 2017.
- * Please see doc/driver-model/i2c-howto.txt for instructions.
+ * Please see doc/driver-model/i2c-howto.rst for instructions.
  */
 
 #include <common.h>
drivers/i2c/sh_i2c.c index b69d213593..834f1f2179 renamed from drivers/i2c/sh_i2c.c +0 -0

100644

drivers/i2c/sh_i2c.c +0 -0
@@ -4,7 +4,7 @@
  * Copyright (C) 2011, 2013 Nobuhiro Iwamatsu

<[email protected]>
*
* NOTE: This driver should be converted to driver model before June 2017.
- * Please see doc/driver-model/i2c-howto.txt for instructions.
+ * Please see doc/driver-model/i2c-howto.rst for instructions. */

#include <common.h>

drivers/i2c/soft_i2c.c index renamed from drivers/i2c/soft_i2c.c +0 -0

7f0303cc05..9ad1c281ff 100644

drivers/i2c/soft_i2c.c +1 -1
@@ -12,7 +12,7 @@
  * Neil Russell.
  *
  * NOTE: This driver should be converted to driver model before June 2017.
- * Please see doc/driver-model/i2c-howto.txt for instructions.
+ * Please see doc/driver-model/i2c-howto.rst for instructions.
  */
 
 #include <common.h>
tools/dtoc/dtb_platdata.py index renamed from tools/dtoc/dtb_platdata.py +0 -0

037e82c8bb..90a9e1a626 100644

tools/dtoc/dtb_platdata.py +1 -1
@@ -423,7 +423,7 @@ class DtbPlatdata(object):
 
         This writes out the body of a header file consisting of structure
         definitions for node in self._valid_nodes. See the documentation in
-        README.of-plat for more information.
+        doc/driver-model/of-plat.rst for more information.
         """
         self.out_header()
         self.out('#include <stdbool.h>\n') @@ -527,7 +527,7 @@ class

DtbPlatdata(object):
U_BOOT_DEVICE() declarations for each valid node. Where a node has multiple compatible strings, a #define is used to make them equivalent.

tools/dtoc/dtb_platdata.py +1 -1
-        See the documentation in doc/driver-model/of-plat.txt for more
+        See the documentation in doc/driver-model/of-plat.rst for more
         information.
         """
         self.out_header()
tools/dtoc/dtoc.py index b3596a5918..f31cba900e renamed from tools/dtoc/dtoc.py +0 -0

100755

tools/dtoc/dtoc.py +0 -0
@@ -22,7 +22,7 @@ Dtoc produces two output files:
 This tool is used in U-Boot to provide device tree data to SPL without  increasing

the code size of SPL. This supports the CONFIG_SPL_OF_PLATDATA options. For more information about the use of this options and tool please -see doc/driver-model/of-plat.txt
+see doc/driver-model/of-plat.rst
"""

Quoted 3 lines

from __future__ import print_function
--
2.25.0

Regards
Patrick

#3 lore raw

PATCH 1/1 doc: fix references to driver-model

Hi,

Quoted 16 lines

From: U-Boot <[email protected]> On Behalf Of Patrick DELAUNAY
Sent: vendredi 28 f?vrier 2020 14:49

Hi Heinrich

Quoted 8 lines

From: U-Boot <[email protected]> On Behalf Of Heinrich Schuchardt
Sent: mardi 25 f?vrier 2020 21:36

Fix some errors pointed out by 'make refcheckdocs'.

---

I found also the same issue in

Quoted 8 lines

-------------------------------- doc/README.SPL -------------------------------- index 4e3478a13a..929b9672b0 100644 @@ -81,7 +81,7 @@ fdtgrep is also used to remove:

   ('u-boot,dm-pre-reloc', 'u-boot,dm-spl' and 'u-boot,dm-tpl')

All the nodes remaining in the SPL devicetree are bound -(see driver-
model/README.txt).
+(see driver-model/design.rst).

Edit: need to add "doc/"

+( see doc/driver-model/design.rst)

Regards
Patrick

#4 lore raw

PATCH 1/1 doc: fix references to driver-model

Quoted 27 lines · Patrick DELAUNAY

Hi,

Quoted 16 lines

From: U-Boot <[email protected]> On Behalf Of Patrick DELAUNAY
Sent: vendredi 28 f?vrier 2020 14:49

Hi Heinrich

Quoted 8 lines

From: U-Boot <[email protected]> On Behalf Of Heinrich Schuchardt
Sent: mardi 25 f?vrier 2020 21:36

Fix some errors pointed out by 'make refcheckdocs'.

---

I found also the same issue in

Quoted 8 lines

-------------------------------- doc/README.SPL -------------------------------- index 4e3478a13a..929b9672b0 100644 @@ -81,7 +81,7 @@ fdtgrep is also used to remove:

    ('u-boot,dm-pre-reloc', 'u-boot,dm-spl' and 'u-boot,dm-tpl')

All the nodes remaining in the SPL devicetree are bound -(see driver-
model/README.txt).
+(see driver-model/design.rst).

Quoted 6 lines

Edit: need to add "doc/"

+( see doc/driver-model/design.rst)

Regards
Patrick

Please, create an additional patch.

Best regards

Heinrich

Quoted 1 line
#5 lore raw

PATCH 1/1 doc: fix references to driver-model

Hi Heinrich

Quoted 38 lines

From: Heinrich Schuchardt <[email protected]>
Sent: vendredi 28 f?vrier 2020 18:38

Quoted 34 lines · Patrick DELAUNAY

Hi,

Quoted 22 lines

From: U-Boot <[email protected]> On Behalf Of Patrick DELAUNAY
Sent: vendredi 28 f?vrier 2020 14:49

Hi Heinrich

Quoted 8 lines

From: U-Boot <[email protected]> On Behalf Of Heinrich Schuchardt
Sent: mardi 25 f?vrier 2020 21:36

Fix some errors pointed out by 'make refcheckdocs'.

---

I found also the same issue in

-------------------------------- doc/README.SPL -------------------------------- index 4e3478a13a..929b9672b0 100644 @@ -81,7 +81,7 @@ fdtgrep is also used to
remove:

Quoted 5 lines
    ('u-boot,dm-pre-reloc', 'u-boot,dm-spl' and 'u-boot,dm-tpl')

All the nodes remaining in the SPL devicetree are bound -(see
driver- model/README.txt).
+(see driver-model/design.rst).

Edit: need to add "doc/"

+( see doc/driver-model/design.rst)

Quoted 8 lines
Quoted 2 lines

Regards
Patrick

Please, create an additional patch.

Best regards

Heinrich

FYI: done in http://patchwork.ozlabs.org/patch/1247524/

Regards

Patrick

#6 lore raw

PATCH 1/1 doc: fix references to driver-model

In reply to Heinrich Schuchardt
Quoted 4 lines · Heinrich Schuchardt

Fix some errors pointed out by 'make refcheckdocs'.

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20200421/4e1fdf1c/attachment.sig>