diff mbox series

[U-Boot,RFC,5/9] doc: driver-model: Convert MIGRATION.txt to reST

Message ID 1563295374-1504-6-git-send-email-bmeng.cn@gmail.com
State RFC
Delegated to: Tom Rini
Headers show
Series Initial layout for Sphinx HTML docs | expand

Commit Message

Bin Meng July 16, 2019, 4:42 p.m. UTC 
Convert plain text documentation to reStructuredText format and add
it to Sphinx TOC tree. No essential content change.

Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
---

 doc/driver-model/index.rst                        |  1 +
 doc/driver-model/{MIGRATION.txt => migration.rst} | 42 ++++++++++-------------
 2 files changed, 20 insertions(+), 23 deletions(-)
 rename doc/driver-model/{MIGRATION.txt => migration.rst} (85%)

Comments

Heinrich Schuchardt July 16, 2019, 5:57 p.m. UTC | #1 
On 7/16/19 6:42 PM, Bin Meng wrote:
> Convert plain text documentation to reStructuredText format and add
> it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Bin Meng <bmeng.cn@gmail.com>

The conversion to RST is correct but we should rethink the values and
effect of the deadlines.

Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
diff mbox series

Patch

diff --git a/doc/driver-model/index.rst b/doc/driver-model/index.rst
index ae28dc0..7d5faf3 100644
--- a/doc/driver-model/index.rst
+++ b/doc/driver-model/index.rst
@@ -6,3 +6,4 @@  Driver Model
    :maxdepth: 2
 
    design
+   migration
diff --git a/doc/driver-model/MIGRATION.txt b/doc/driver-model/migration.rst
similarity index 85%
rename from doc/driver-model/MIGRATION.txt
rename to doc/driver-model/migration.rst
index d38be35..73e22ed 100644
--- a/doc/driver-model/MIGRATION.txt
+++ b/doc/driver-model/migration.rst
@@ -1,5 +1,5 @@ 
 Migration Schedule
-====================
+==================
 
 U-Boot has been migrating to a new driver model since its introduction in
 2014. This file describes the schedule for deprecation of pre-driver-model
@@ -8,8 +8,8 @@  features.
 CONFIG_DM_MMC
 -------------
 
-Status: In progress
-Deadline: 2019.04
+* Status: In progress
+* Deadline: 2019.04
 
 The subsystem itself has been converted and maintainers should submit patches
 switching over to using CONFIG_DM_MMC and other base driver model options in
@@ -18,8 +18,8 @@  time for inclusion in the 2019.04 rerelease.
 CONFIG_DM_USB
 -------------
 
-Status: In progress
-Deadline: 2019.07
+* Status: In progress
+* Deadline: 2019.07
 
 The subsystem itself has been converted along with many of the host controller
 and maintainers should submit patches switching over to using CONFIG_DM_USB and
@@ -28,8 +28,8 @@  other base driver model options in time for inclusion in the 2019.07 rerelease.
 CONFIG_SATA
 -----------
 
-Status: In progress
-Deadline: 2019.07
+* Status: In progress
+* Deadline: 2019.07
 
 The subsystem itself has been converted along with many of the host controller
 and maintainers should submit patches switching over to using CONFIG_AHCI and
@@ -38,8 +38,8 @@  other base driver model options in time for inclusion in the 2019.07 rerelease.
 CONFIG_BLK
 ----------
 
-Status: In progress
-Deadline: 2019.07
+* Status: In progress
+* Deadline: 2019.07
 
 In concert with maintainers migrating their block device usage to the
 appropriate DM driver, CONFIG_BLK needs to be set as well.  The final deadline
@@ -48,14 +48,14 @@  subsystems.  At this point we will be able to audit and correct the logic in
 Kconfig around using CONFIG_PARTITIONS and CONFIG_HAVE_BLOCK_DEVICE and make
 use of CONFIG_BLK / CONFIG_SPL_BLK as needed.
 
-CONFIG_DM_SPI
-CONFIG_DM_SPI_FLASH
--------------------
+CONFIG_DM_SPI / CONFIG_DM_SPI_FLASH
+-----------------------------------
 
 Board Maintainers should submit the patches for enabling DM_SPI and DM_SPI_FLASH
 to move the migration with in the deadline.
 
-No dm conversion yet:
+No dm conversion yet::
+
 	drivers/spi/cf_spi.c
 	drivers/spi/fsl_espi.c
 	drivers/spi/lpc32xx_ssp.c
@@ -63,10 +63,11 @@  No dm conversion yet:
 	drivers/spi/sh_spi.c
 	drivers/spi/soft_spi_legacy.c
 
-	Status: In progress
-	Deadline: 2019.04
+* Status: In progress
+* Deadline: 2019.04
+
+Partially converted::
 
-Partially converted:
 	drivers/spi/davinci_spi.c
 	drivers/spi/fsl_dspi.c
 	drivers/spi/kirkwood_spi.c
@@ -74,13 +75,8 @@  Partially converted:
 	drivers/spi/omap3_spi.c
 	drivers/spi/sh_qspi.c
 
-	Status: In progress
-	Deadline: 2019.07
-
---
-Jagan Teki <jagan@openedev.com>
-12/24/2018
-03/14/2018
+* Status: In progress
+* Deadline: 2019.07
 
 
 CONFIG_DM_PCI