Skip to contentSkip to conversation

doc: Fix some errors pointed out by 'make refcheckdocs'

PATCH New Patrick Delaunay 4 participants 17 messages Feb 28, 2020 – Apr 17, 2020

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

cover doc: Fix some errors pointed out by 'make refcheckdocs'

Fix some errors pointed out by 'make refcheckdocs'.

This target is available after Heinrich patch
"scripts: add documentation-file-ref-check"
http://patchwork.ozlabs.org/patch/1244498/

see also patches
1/ "doc: fix references to driver-model"
http://patchwork.ozlabs.org/patch/1244504/

2/ "Kconfig: fix typos in CMD_BEDBUG description"
http://patchwork.ozlabs.org/patch/1244507/

3/ "include/ata.h: remove invalid links"
http://patchwork.ozlabs.org/patch/1244637/

After this serie the only remaining errors are:

$> make refcheckdocs

doc/sphinx/parse-headers.pl: doc/doc-guide/parse-headers.rst doc/sphinx/rstFlatTable.py: doc/books/kernel-doc-HOWTO drivers/rtc/ds1374.c: Watchdoc/Alarm
include/fsl_qe.h: doc/README.qe_firmware lib/zlib/trees.c: ftp.uu.net:/pub/archiving/zip/doc/deflate-1.1.doc

Patrick Delaunay (7):
README: update reference to *.README
Kconfig: update reference to README.x86
doc: update reference to README.imximage
doc: update reference to README.imx8image
doc: update reference to README.board
doc: device-tree-bindings: update reference to binding directory
arm: imx: update reference to README.mxc_hab

 Kconfig                                                  | 2 +-
 README                                                   | 2 +-
 arch/arm/mach-imx/Kconfig                                | 4 ++--
 board/advantech/dms-ba16/dms-ba16_1g.cfg                 | 2 +-
 board/advantech/dms-ba16/dms-ba16_2g.cfg                 | 2 +-
 board/aristainetos/aristainetos2.cfg                     | 2 +-
 board/bachmann/ot1200/mx6q_4x_mt41j128.cfg               | 2 +-
 board/barco/titanium/imximage.cfg                        | 2 +-
 board/boundary/nitrogen6x/nitrogen6dl.cfg                | 2 +-
 board/boundary/nitrogen6x/nitrogen6dl2g.cfg              | 2 +-
 board/boundary/nitrogen6x/nitrogen6q.cfg                 | 2 +-
 board/boundary/nitrogen6x/nitrogen6q2g.cfg               | 2 +-
 board/boundary/nitrogen6x/nitrogen6s.cfg                 | 2 +-
 board/boundary/nitrogen6x/nitrogen6s1g.cfg               | 2 +-
 board/ccv/xpress/imximage.cfg                            | 2 +-
 board/cobra5272/README                                   | 2 +-
 board/freescale/imx8qxp_mek/imximage.cfg                 | 2 +-
 board/freescale/m52277evb/README                         | 2 +-
 board/freescale/m53017evb/README                         | 2 +-
 board/freescale/m5373evb/README                          | 2 +-
 board/freescale/m54455evb/README                         | 2 +-
 board/freescale/m547xevb/README                          | 2 +-
 board/freescale/mx25pdk/imximage.cfg                     | 2 +-
 board/freescale/mx51evk/imximage.cfg                     | 2 +-
 board/freescale/mx53ard/imximage_dd3.cfg                 | 2 +-
 board/freescale/mx53evk/imximage.cfg                     | 2 +-
 board/freescale/mx53loco/imximage.cfg                    | 2 +-
 board/freescale/mx53smd/imximage.cfg                     | 2 +-
 board/freescale/mx6qarm2/imximage.cfg                    | 2 +-
 board/freescale/mx6qarm2/imximage_mx6dl.cfg              | 2 +-
 board/freescale/mx6slevk/imximage.cfg                    | 2 +-
 board/freescale/mx6ullevk/imximage.cfg                   | 2 +-
 board/freescale/mx7dsabresd/imximage.cfg                 | 2 +-
 board/freescale/s32v234evb/s32v234evb.cfg                | 2 +-
 board/freescale/vf610twr/imximage.cfg                    | 2 +-
 board/ge/bx50v3/bx50v3.cfg                               | 2 +-
 board/ge/mx53ppd/imximage.cfg                            | 2 +-
 board/menlo/m53menlo/imximage.cfg                        | 2 +-
 board/phytec/pcm052/imximage.cfg                         | 2 +-
 board/seco/mx6quq7/mx6quq7-2g.cfg                        | 2 +-
 board/siemens/capricorn/imximage.cfg                     | 2 +-
 board/technexion/pico-imx6ul/imximage.cfg                | 2 +-
 board/toradex/apalis-imx8/apalis-imx8qm-imximage.cfg     | 2 +-
 board/toradex/colibri-imx6ull/imximage.cfg               | 2 +-
 board/toradex/colibri-imx8x/colibri-imx8qxp-imximage.cfg | 2 +-
 board/toradex/colibri_imx7/imximage.cfg                  | 2 +-
 board/toradex/colibri_vf/imximage.cfg                    | 2 +-
 board/tqc/tqma6/clocks.cfg                               | 2 +-
 board/tqc/tqma6/tqma6dl.cfg                              | 2 +-
 board/tqc/tqma6/tqma6q.cfg                               | 2 +-
 board/tqc/tqma6/tqma6s.cfg                               | 2 +-
 board/warp/imximage.cfg                                  | 2 +-
 board/warp7/imximage.cfg                                 | 2 +-
 doc/device-tree-bindings/net/ti,dp83867.txt              | 2 +-
 doc/device-tree-bindings/video/rockchip-lvds.txt         | 2 +-
 doc/imx/misc/sdp.txt                                     | 2 +-
 include/configs/sbc8548.h                                | 2 +-
 57 files changed, 58 insertions(+), 58 deletions(-)
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/7 README: update reference to *.README

Update some reference in README file detected by
scripts/documentation-file-ref-check

*.README => README.*

---

 README | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
README +1 -1
index 8cfa92fac9..4a0f8cbeef 100644
@@ -4639,7 +4639,7 @@ int main(int argc, char *argv[])
 	while (learning) {
 		Read the README file in the top level directory;
 		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
-		Read applicable doc/*.README;
+		Read applicable doc/README.*;
 		Read the source, Luke;
 		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
 	}
Signature · 1 line
2.17.1
#2 lore raw

PATCH 1/7 README: update reference to *.README

Quoted 6 lines · Patrick Delaunay

Update some reference in README file detected by
scripts/documentation-file-ref-check

*.README => README.*

Quoted 19 lines

---

  README | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
README +1 -1
index 8cfa92fac9..4a0f8cbeef 100644
@@ -4639,7 +4639,7 @@ int main(int argc, char *argv[])
  	while (learning) {
  		Read the README file in the top level directory;
  		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
-		Read applicable doc/*.README;
+		Read applicable doc/README.*;
  		Read the source, Luke;
  		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
  	}
#3 lore raw

PATCH 1/7 README: update reference to *.README

In reply to Patrick Delaunay
Quoted 7 lines · Patrick Delaunay

Update some reference in README file detected by
scripts/documentation-file-ref-check

*.README => README.*

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/20200417/aa61d111/attachment.sig>
#4 lore raw

PATCH 2/7 Kconfig: update reference to README.x86

In reply to Patrick Delaunay

Update reference in Kconfig detected by
scripts/documentation-file-ref-check

README.x86 => doc/arch/x86.rst

---

 Kconfig | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Kconfig +1 -1
index 66148ce477..6bb6a1e415 100644
@@ -236,7 +236,7 @@ config BUILD_ROM
 	  This option allows to build a ROM version of U-Boot.
 	  The build process generally requires several binary blobs
 	  which are not shipped in the U-Boot source tree.
-	  Please, see doc/README.x86 for details.
+	  Please, see doc/arch/x86.rst for details.
 
 config SPL_IMAGE
 	string "SPL image used in the combined SPL+U-Boot image"
Signature · 1 line
2.17.1
#6 lore raw

PATCH 2/7 Kconfig: update reference to README.x86

In reply to Patrick Delaunay
Quoted 7 lines · Patrick Delaunay

Update reference in Kconfig detected by
scripts/documentation-file-ref-check

README.x86 => doc/arch/x86.rst

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/20200417/64929155/attachment.sig>
#7 lore raw

PATCH 3/7 doc: update reference to README.imximage

In reply to Patrick Delaunay

Update reference in many files detected by
scripts/documentation-file-ref-check

README.imximage => imx/mkimage/imximage.txt

---

 board/advantech/dms-ba16/dms-ba16_1g.cfg    | 2 +-
 board/advantech/dms-ba16/dms-ba16_2g.cfg    | 2 +-
 board/aristainetos/aristainetos2.cfg        | 2 +-
 board/bachmann/ot1200/mx6q_4x_mt41j128.cfg  | 2 +-
 board/barco/titanium/imximage.cfg           | 2 +-
 board/boundary/nitrogen6x/nitrogen6dl.cfg   | 2 +-
 board/boundary/nitrogen6x/nitrogen6dl2g.cfg | 2 +-
 board/boundary/nitrogen6x/nitrogen6q.cfg    | 2 +-
 board/boundary/nitrogen6x/nitrogen6q2g.cfg  | 2 +-
 board/boundary/nitrogen6x/nitrogen6s.cfg    | 2 +-
 board/boundary/nitrogen6x/nitrogen6s1g.cfg  | 2 +-
 board/ccv/xpress/imximage.cfg               | 2 +-
 board/freescale/mx25pdk/imximage.cfg        | 2 +-
 board/freescale/mx51evk/imximage.cfg        | 2 +-
 board/freescale/mx53ard/imximage_dd3.cfg    | 2 +-
 board/freescale/mx53evk/imximage.cfg        | 2 +-
 board/freescale/mx53loco/imximage.cfg       | 2 +-
 board/freescale/mx53smd/imximage.cfg        | 2 +-
 board/freescale/mx6qarm2/imximage.cfg       | 2 +-
 board/freescale/mx6qarm2/imximage_mx6dl.cfg | 2 +-
 board/freescale/mx6slevk/imximage.cfg       | 2 +-
 board/freescale/mx6ullevk/imximage.cfg      | 2 +-
 board/freescale/mx7dsabresd/imximage.cfg    | 2 +-
 board/freescale/s32v234evb/s32v234evb.cfg   | 2 +-
 board/freescale/vf610twr/imximage.cfg       | 2 +-
 board/ge/bx50v3/bx50v3.cfg                  | 2 +-
 board/ge/mx53ppd/imximage.cfg               | 2 +-
 board/menlo/m53menlo/imximage.cfg           | 2 +-
 board/phytec/pcm052/imximage.cfg            | 2 +-
 board/seco/mx6quq7/mx6quq7-2g.cfg           | 2 +-
 board/technexion/pico-imx6ul/imximage.cfg   | 2 +-
 board/toradex/colibri-imx6ull/imximage.cfg  | 2 +-
 board/toradex/colibri_imx7/imximage.cfg     | 2 +-
 board/toradex/colibri_vf/imximage.cfg       | 2 +-
 board/tqc/tqma6/clocks.cfg                  | 2 +-
 board/tqc/tqma6/tqma6dl.cfg                 | 2 +-
 board/tqc/tqma6/tqma6q.cfg                  | 2 +-
 board/tqc/tqma6/tqma6s.cfg                  | 2 +-
 board/warp/imximage.cfg                     | 2 +-
 board/warp7/imximage.cfg                    | 2 +-
 doc/imx/misc/sdp.txt                        | 2 +-
 41 files changed, 41 insertions(+), 41 deletions(-)
board/advantech/dms-ba16/dms-ba16_1g.cfg +1 -1
index c2624ddc3e..1c737baaf2 100644
@@ -4,7 +4,7 @@
  * Copyright 2015 Timesys Corporation.
  * Copyright 2015 General Electric Company
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/advantech/dms-ba16/dms-ba16_2g.cfg +1 -1
index 4ce93ff74b..371a84eb7e 100644
@@ -4,7 +4,7 @@
  * Copyright 2015 Timesys Corporation.
  * Copyright 2015 General Electric Company
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/aristainetos/aristainetos2.cfg +1 -1
index 965ad64b49..d088cc83ad 100644
@@ -6,7 +6,7 @@
  * Based on:
  * Copyright (C) 2013 Boundary Devices
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/bachmann/ot1200/mx6q_4x_mt41j128.cfg +1 -1
index ba5c074797..f4f605fc8d 100644
@@ -3,7 +3,7 @@
  * Copyright (C) 2011 Freescale Semiconductor, Inc.
  * Jason Liu <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/barco/titanium/imximage.cfg +1 -1
index 101fc76de4..1fc26ed2c9 100644
@@ -6,7 +6,7 @@
  * Copyright (C) 2011 Freescale Semiconductor, Inc.
  * Jason Liu <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/boundary/nitrogen6x/nitrogen6dl.cfg +1 -1
index 56b3bcbb2f..9558e26a2f 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013 Boundary Devices
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/boundary/nitrogen6x/nitrogen6dl2g.cfg +1 -1
index 13f7a89232..f5a107c225 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013 Boundary Devices
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/boundary/nitrogen6x/nitrogen6q.cfg +1 -1
index 1304b52d18..b0bbf0d797 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013 Boundary Devices
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/boundary/nitrogen6x/nitrogen6q2g.cfg +1 -1
index e5e923d3cf..4999254329 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013 Boundary Devices
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/boundary/nitrogen6x/nitrogen6s.cfg +1 -1
index e5f814b715..16d778491a 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013 Boundary Devices
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/boundary/nitrogen6x/nitrogen6s1g.cfg +1 -1
index f3d754e23a..0320078a91 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013 Boundary Devices
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/ccv/xpress/imximage.cfg +1 -1
index be7e391ddb..b59dc842c1 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2015-2016 Stefan Roese <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/mx25pdk/imximage.cfg +1 -1
index 209775f2fd..762ccd0ab3 100644
@@ -3,7 +3,7 @@
  * (C) Copyright 2009
  * Stefano Babic DENX Software Engineering sbabic at denx.de.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/mx51evk/imximage.cfg +1 -1
index 75500e70f3..ff2ec4aa27 100644
@@ -3,7 +3,7 @@
  * (C Copyright 2009
  * Stefano Babic DENX Software Engineering sbabic at denx.de.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/mx53ard/imximage_dd3.cfg +1 -1
index 9533dfb456..fd033187b7 100644
@@ -3,7 +3,7 @@
  * (C) Copyright 2009
  * Stefano Babic DENX Software Engineering sbabic at denx.de.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/mx53evk/imximage.cfg +1 -1
index d4158daafe..ef103d6da7 100644
@@ -3,7 +3,7 @@
  * (C Copyright 2009
  * Stefano Babic DENX Software Engineering sbabic at denx.de.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/mx53loco/imximage.cfg +1 -1
index db578b2cf2..d12801d19f 100644
@@ -3,7 +3,7 @@
  * Copyright (C) 2011 Freescale Semiconductor, Inc.
  * Jason Liu <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/mx53smd/imximage.cfg +1 -1
index 9533dfb456..fd033187b7 100644
@@ -3,7 +3,7 @@
  * (C) Copyright 2009
  * Stefano Babic DENX Software Engineering sbabic at denx.de.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/mx6qarm2/imximage.cfg +1 -1
index b0608f3467..74a33c2503 100644
@@ -3,7 +3,7 @@
  * Copyright (C) 2011-2014 Freescale Semiconductor, Inc.
  * Jason Liu <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/mx6qarm2/imximage_mx6dl.cfg +1 -1
index 509c659649..0d1353119b 100644
@@ -3,7 +3,7 @@
  * Copyright (C) 2014 Freescale Semiconductor, Inc.
  * Jason Liu <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/mx6slevk/imximage.cfg +1 -1
index fd71bef286..b97761a516 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013 Freescale Semiconductor, Inc.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/mx6ullevk/imximage.cfg +1 -1
index 40818d0a03..155503997d 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2016 Freescale Semiconductor, Inc.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/mx7dsabresd/imximage.cfg +1 -1
index a0f39c4062..05446ac833 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2015 Freescale Semiconductor, Inc.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/s32v234evb/s32v234evb.cfg +1 -1
index 526b7d177f..7881512139 100644
@@ -4,7 +4,7 @@
  */
 
 /*
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/freescale/vf610twr/imximage.cfg +1 -1
index b1a8e8ef06..e2fa1a582d 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright 2013 Freescale Semiconductor, Inc.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/ge/bx50v3/bx50v3.cfg +1 -1
index f872ea24fc..de3955a94d 100644
@@ -4,7 +4,7 @@
  * Copyright 2015 Timesys Corporation.
  * Copyright 2015 General Electric Company
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/ge/mx53ppd/imximage.cfg +1 -1
index 8dd1b0f979..1ee8198390 100644
@@ -7,7 +7,7 @@
  * Copyright (C) 2011 Freescale Semiconductor, Inc.
  * Jason Liu <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/menlo/m53menlo/imximage.cfg +1 -1
index 68b3eb5c1c..282caf65e0 100644
@@ -3,7 +3,7 @@
  * M53 DRAM init values
  * Copyright (C) 2012-2013 Marek Vasut <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/phytec/pcm052/imximage.cfg +1 -1
index d25f611942..cf72b84e77 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright 2015 3ADEV <http://www.3adev.com>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/seco/mx6quq7/mx6quq7-2g.cfg +1 -1
index c48d64ba40..68d13cc92b 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013 Seco USA Inc
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/technexion/pico-imx6ul/imximage.cfg +1 -1
index ad9cc5a8f1..993c1da670 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2015 Freescale Semiconductor, Inc.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/toradex/colibri-imx6ull/imximage.cfg +1 -1
index a11e288c6c..8d869d9f79 100644
@@ -3,7 +3,7 @@
  * Copyright (C) 2016 Freescale Semiconductor, Inc.
  * Copyright (C) 2018 Toradex AG
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/toradex/colibri_imx7/imximage.cfg +1 -1
index 1b4f272bb6..bdce48b7ff 100644
@@ -3,7 +3,7 @@
  * Copyright (C) 2015 Freescale Semiconductor, Inc.
  *               2015 Toradex AG
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/toradex/colibri_vf/imximage.cfg +1 -1
index 623371d069..7e629d2f9e 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright 2014 Toradex, Inc.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/tqc/tqma6/clocks.cfg +1 -1
index a98b30bfe7..1f2001c75f 100644
@@ -3,7 +3,7 @@
  * Copyright (C) 2013 Boundary Devices
  * Copyright (C) 2013, 2014 Markus Niebel <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  */
 
board/tqc/tqma6/tqma6dl.cfg +1 -1
index 84c38b470b..80c7150316 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2014 - 2015 Markus Niebel <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/tqc/tqma6/tqma6q.cfg +1 -1
index 6141be673b..82a0a271d4 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013, 2014 Markus Niebel <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/tqc/tqma6/tqma6s.cfg +1 -1
index 2d2d65ecc6..9cdbb3c767 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013, 2014 Markus Niebel <[email protected]>
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/warp/imximage.cfg +1 -1
index dea331cab1..619f6aa7b0 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2013 Freescale Semiconductor, Inc.
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
board/warp7/imximage.cfg +1 -1
index a4c2f677a1..9e7d4725e4 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright (C) 2016 NXP Semiconductors
  *
- * Refer doc/README.imximage for more details about how-to configure
+ * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure
  * and create imximage boot image
  *
  * The syntax is taken as close as possible with the kwbimage
doc/imx/misc/sdp.txt +1 -1
index 6ea6e41395..49b281234b 100644
@@ -22,7 +22,7 @@ described in the manual. It is a replacement for Freescale's
 MFGTOOLS.
 
 The host side utilities are typically capable to interpret the i.MX
-specific image header (see doc/README.imximage). There are extensions
+specific image header (see doc/imx/mkimage/imximage.txt). There are extensions
 for imx_loader's imx_usb utility which allow to interpret the U-Boot
 specific legacy image format (see mkimage(1)). Also the U-Boot side
 support beside the i.MX specific header the U-Boot legacy header.
Signature · 1 line
2.17.1
#8 lore raw

PATCH 3/7 doc: update reference to README.imximage

Quoted 6 lines · Patrick Delaunay

Update reference in many files detected by
scripts/documentation-file-ref-check

README.imximage => imx/mkimage/imximage.txt

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/20200417/8cfea1ff/attachment.sig>
#9 lore raw

PATCH 4/7 doc: update reference to README.imx8image

In reply to Patrick Delaunay

Update reference in many files detected by
scripts/documentation-file-ref-check

README.imx8image => imx/mkimage/imx8image.txt

---

 board/freescale/imx8qxp_mek/imximage.cfg                 | 2 +-
 board/siemens/capricorn/imximage.cfg                     | 2 +-
 board/toradex/apalis-imx8/apalis-imx8qm-imximage.cfg     | 2 +-
 board/toradex/colibri-imx8x/colibri-imx8qxp-imximage.cfg | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)
board/freescale/imx8qxp_mek/imximage.cfg +1 -1
index 259a1646bf..cd747d2eee 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright 2018 NXP
  *
- * Refer doc/README.imx8image for more details about how-to configure
+ * Refer doc/imx/mkimage/imx8image.txt for more details about how-to configure
  * and create imx8image boot image
  */
 
board/siemens/capricorn/imximage.cfg +1 -1
index 8660e50cbd..9f9df68e64 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright 2018 NXP
  *
- * Refer doc/README.imx8image for more details about how-to configure
+ * Refer doc/imx/mkimage/imx8image.txt for more details about how-to configure
  * and create imx8image boot image
  */
 
board/toradex/apalis-imx8/apalis-imx8qm-imximage.cfg +1 -1
index 71981f8c55..b8f0f3dc10 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright 2019 Toradex
  *
- * Refer doc/README.imx8image for more details about how-to configure
+ * Refer doc/imx/mkimage/imx8image.txt for more details about how-to configure
  * and create imx8image boot image
  */
 
board/toradex/colibri-imx8x/colibri-imx8qxp-imximage.cfg +1 -1
index 1dcd13271d..44f6c0c455 100644
@@ -2,7 +2,7 @@
 /*
  * Copyright 2019 Toradex
  *
- * Refer doc/README.imx8image for more details about how-to configure
+ * Refer doc/imx/mkimage/imx8image.txt for more details about how-to configure
  * and create imx8image boot image
  */
 
Signature · 1 line
2.17.1
#10 lore raw

PATCH 4/7 doc: update reference to README.imx8image

Quoted 6 lines · Patrick Delaunay

Update reference in many files detected by
scripts/documentation-file-ref-check

README.imx8image => imx/mkimage/imx8image.txt

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/20200417/d2365b4a/attachment.sig>
#11 lore raw

PATCH 5/7 doc: update reference to README.board

In reply to Patrick Delaunay

Update reference in files detected by
scripts/documentation-file-ref-check

doc/README.<board> => board/<board>/README

Files moved in board directory in
commit 702e6014f15b ("doc: cleanup - move board
READMEs into respective board directories")'

---

 board/cobra5272/README           | 2 +-
 board/freescale/m52277evb/README | 2 +-
 board/freescale/m53017evb/README | 2 +-
 board/freescale/m5373evb/README  | 2 +-
 board/freescale/m54455evb/README | 2 +-
 board/freescale/m547xevb/README  | 2 +-
 include/configs/sbc8548.h        | 2 +-
 7 files changed, 7 insertions(+), 7 deletions(-)
board/cobra5272/README +1 -1
index ae0f148258..1dad7e3eaf 100644
@@ -28,7 +28,7 @@ CONFIGURING
 
 
 Please refer to u-boot README (general info, u-boot-x-x-x/README),
-to u-boot-x-x-x/doc/README.COBRA5272 and
+to u-boot-x-x-x/board/cobra5272/README and
 to the comments in u-boot-x-x-x/include/configs/cobra5272.h
 
 Configuring u-boot is done by commenting/uncommenting preprocessor defines.
board/freescale/m52277evb/README +1 -1
index 76f4789335..8bfd8122dd 100644
@@ -22,7 +22,7 @@ Changed files:
 - arch/m68k/cpu/mcf5227x/config.mk	config make
 - arch/m68k/cpu/mcf5227x/start.S		start up assembly code
 
-- doc/README.m52277evb		This readme file
+- board/freescale/m52277evb/README	This readme file
 
 - drivers/serial/mcfuart.c	ColdFire common UART driver
 - drivers/rtc/mcfrtc.c		Realtime clock Driver
board/freescale/m53017evb/README +1 -1
index a7074c9b71..c4b019e2a9 100644
@@ -23,7 +23,7 @@ Changed files:
 - arch/m68k/cpu/mcf532x/config.mk			config make
 - arch/m68k/cpu/mcf532x/start.S			start up assembly code
 
-- doc/README.m53017evb			This readme file
+- board/freescale/m53017evb/README	his readme file
 
 - drivers/net/mcffec.c			ColdFire common FEC driver
 - drivers/net/mcfmii.c			ColdFire common Mii driver
board/freescale/m5373evb/README +1 -1
index f0a0631c94..bba5420215 100644
@@ -23,7 +23,7 @@ Changed files:
 - arch/m68k/cpu/mcf532x/config.mk		config make
 - arch/m68k/cpu/mcf532x/start.S		start up assembly code
 
-- doc/README.m5373evb		This readme file
+- board/freescale/m5373evb/README	This readme file
 
 - drivers/net/mcffec.c		ColdFire common FEC driver
 - drivers/serial/mcfuart.c	ColdFire common UART driver
board/freescale/m54455evb/README +1 -1
index 260aec9f1b..26d3cc81fd 100644
@@ -26,7 +26,7 @@ Changed files:
 - arch/m68k/cpu/mcf5445x/config.mk	config make
 - arch/m68k/cpu/mcf5445x/start.S		start up assembly code
 
-- doc/README.m54455evb	This readme file
+- board/freescale/m54455evb/README	This readme file
 
 - drivers/net/mcffec.c		ColdFire common FEC driver
 - drivers/serial/mcfuart.c	ColdFire common UART driver
board/freescale/m547xevb/README +1 -1
index ce7b27b8b2..6b4fbe5c25 100644
@@ -24,7 +24,7 @@ Changed files:
 - arch/m68k/cpu/mcf547x_8x/config.mk		config make
 - arch/m68k/cpu/mcf547x_8x/start.S		start up assembly code
 
-- doc/README.m5475evb			This readme file
+- board/freescale/m547xevb/README	This readme file
 
 - drivers/dma/MCD_dmaApi.c		DMA API functions
 - drivers/dma/MCD_tasks.c		DMA Tasks
include/configs/sbc8548.h +1 -1
index f4113e03c4..ae2c0033d0 100644
@@ -7,7 +7,7 @@
 
 /*
  * sbc8548 board configuration file
- * Please refer to doc/README.sbc8548 for more info.
+ * Please refer to board/sbc8548/README for more info.
  */
 #ifndef __CONFIG_H
 #define __CONFIG_H
Signature · 1 line
2.17.1
#12 lore raw

PATCH 5/7 doc: update reference to README.board

Quoted 10 lines · Patrick Delaunay

Update reference in files detected by
scripts/documentation-file-ref-check

doc/README.<board> => board/<board>/README

Files moved in board directory in
commit 702e6014f15b ("doc: cleanup - move board
READMEs into respective board directories")'

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/20200417/ddfae2e8/attachment.sig>
#13 lore raw

PATCH 6/7 doc: device-tree-bindings: update reference to binding directory

In reply to Patrick Delaunay

Update reference in files detected by
scripts/documentation-file-ref-check

doc/devicetree/device-tree-bindings/ => doc/device-tree-bindings/

---

 doc/device-tree-bindings/net/ti,dp83867.txt      | 2 +-
 doc/device-tree-bindings/video/rockchip-lvds.txt | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
doc/device-tree-bindings/net/ti,dp83867.txt +1 -1
index 268220964a..d3c3046499 100644
@@ -18,7 +18,7 @@ Required properties:
 			      PHY's default will be left as is.
 
 Default child nodes are standard Ethernet PHY device
-nodes as described in doc/devicetree/bindings/net/ethernet.txt
+nodes as described in doc/device-tree-bindings/net/ethernet.txt
 
 Example:
 
doc/device-tree-bindings/video/rockchip-lvds.txt +1 -1
index 07e3d3f9de..7432e22166 100644
@@ -20,7 +20,7 @@ Required properties:
 	<LVDS_OUTPUT_DUAL>, This describes the output face.
 
 - display-timings : described by
-	doc/devicetree/device-tree-bindings/video/display-timing.txt.
+	doc/device-tree-bindings/video/display-timing.txt.
 
 Example:
 	lvds: lvds at ff96c000 {
Signature · 1 line
2.17.1
#14 lore raw

PATCH 6/7 doc: device-tree-bindings: update reference to binding directory

Quoted 6 lines · Patrick Delaunay

Update reference in files detected by
scripts/documentation-file-ref-check

doc/devicetree/device-tree-bindings/ => doc/device-tree-bindings/

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/20200417/958c0e93/attachment.sig>
#15 lore raw

PATCH 7/7 arm: imx: update reference to README.mxc_hab

In reply to Patrick Delaunay

Update reference in files detected by
scripts/documentation-file-ref-check

doc/README.mxc_hab => doc/imx/habv4/*

---

 arch/arm/mach-imx/Kconfig | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
arch/arm/mach-imx/Kconfig +2 -2
index aa140c4798..329149900a 100644
@@ -41,7 +41,7 @@ config IMX_HAB
 	imply CMD_DEKBLOB
 	help
 	  This option enables the support for secure boot (HAB).
-	  See doc/README.mxc_hab for more details.
+	  See doc/imx/habv4/* for more details.
 
 config CSF_SIZE
 	hex "Maximum size for Command Sequence File (CSF) binary"
@@ -69,7 +69,7 @@ config CMD_DEKBLOB
 	help
 	  This enables the 'dek_blob' command which is used with the
 	  Freescale secure boot mechanism. This command encapsulates and
-	  creates a blob of data. See also CMD_BLOB and doc/README.mxc_hab for
+	  creates a blob of data. See also CMD_BLOB and doc/imx/habv4/* for
 	  more information.
 
 config CMD_HDMIDETECT
Signature · 1 line
2.17.1
#16 lore raw

PATCH 7/7 arm: imx: update reference to README.mxc_hab

Quoted 6 lines · Patrick Delaunay

Update reference in files detected by
scripts/documentation-file-ref-check

doc/README.mxc_hab => doc/imx/habv4/*

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/20200417/c441f7d1/attachment.sig>