doc: driver-model: Convert MIGRATION.txt to reST
authorBin Meng <bmeng.cn@gmail.com>
Thu, 18 Jul 2019 07:33:50 +0000 (00:33 -0700)
committerTom Rini <trini@konsulko.com>
Wed, 24 Jul 2019 14:07:24 +0000 (10:07 -0400)
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>
Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
doc/driver-model/MIGRATION.txt [deleted file]
doc/driver-model/index.rst
doc/driver-model/migration.rst [new file with mode: 0644]

diff --git a/doc/driver-model/MIGRATION.txt b/doc/driver-model/MIGRATION.txt
deleted file mode 100644 (file)
index d38be35..0000000
+++ /dev/null
@@ -1,101 +0,0 @@
-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
-features.
-
-CONFIG_DM_MMC
--------------
-
-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
-time for inclusion in the 2019.04 rerelease.
-
-CONFIG_DM_USB
--------------
-
-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
-other base driver model options in time for inclusion in the 2019.07 rerelease.
-
-CONFIG_SATA
------------
-
-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
-other base driver model options in time for inclusion in the 2019.07 rerelease.
-
-CONFIG_BLK
-----------
-
-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
-here coincides with the final deadline for migration of the various block
-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
--------------------
-
-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:
-       drivers/spi/cf_spi.c
-       drivers/spi/fsl_espi.c
-       drivers/spi/lpc32xx_ssp.c
-       drivers/spi/mxs_spi.c
-       drivers/spi/sh_spi.c
-       drivers/spi/soft_spi_legacy.c
-
-       Status: In progress
-       Deadline: 2019.04
-
-Partially converted:
-       drivers/spi/davinci_spi.c
-       drivers/spi/fsl_dspi.c
-       drivers/spi/kirkwood_spi.c
-       drivers/spi/mxc_spi.c
-       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
-
-
-CONFIG_DM_PCI
--------------
-Deadline: 2019.07
-
-The PCI subsystem has supported driver model since mid 2015. Maintainers should
-submit patches switching over to using CONFIG_DM_PCI and other base driver
-model options in time for inclusion in the 2019.07 release.
-
-
-CONFIG_DM_VIDEO
----------------
-Deadline: 2019.07
-
-The video subsystem has supported driver model since early 2016. Maintainers
-should submit patches switching over to using CONFIG_DM_VIDEO and other base
-driver model options in time for inclusion in the 2019.07 release.
index 96fbd7213a5bdbad13c7a1cea9a2fcd3d5de29d7..663aa5d499e955cf95722117b183f0ba9303d4d7 100644 (file)
@@ -7,3 +7,4 @@ Driver Model
    :maxdepth: 2
 
    design
+   migration
diff --git a/doc/driver-model/migration.rst b/doc/driver-model/migration.rst
new file mode 100644 (file)
index 0000000..a26e7ab
--- /dev/null
@@ -0,0 +1,99 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+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
+features.
+
+CONFIG_DM_MMC
+-------------
+
+* 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
+time for inclusion in the 2019.04 rerelease.
+
+CONFIG_DM_USB
+-------------
+
+* 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
+other base driver model options in time for inclusion in the 2019.07 rerelease.
+
+CONFIG_SATA
+-----------
+
+* 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
+other base driver model options in time for inclusion in the 2019.07 rerelease.
+
+CONFIG_BLK
+----------
+
+* 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
+here coincides with the final deadline for migration of the various block
+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
+-----------------------------------
+
+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::
+
+       drivers/spi/cf_spi.c
+       drivers/spi/fsl_espi.c
+       drivers/spi/lpc32xx_ssp.c
+       drivers/spi/mxs_spi.c
+       drivers/spi/sh_spi.c
+       drivers/spi/soft_spi_legacy.c
+
+* Status: In progress
+* Deadline: 2019.04
+
+Partially converted::
+
+       drivers/spi/davinci_spi.c
+       drivers/spi/fsl_dspi.c
+       drivers/spi/kirkwood_spi.c
+       drivers/spi/mxc_spi.c
+       drivers/spi/omap3_spi.c
+       drivers/spi/sh_qspi.c
+
+* Status: In progress
+* Deadline: 2019.07
+
+
+CONFIG_DM_PCI
+-------------
+Deadline: 2019.07
+
+The PCI subsystem has supported driver model since mid 2015. Maintainers should
+submit patches switching over to using CONFIG_DM_PCI and other base driver
+model options in time for inclusion in the 2019.07 release.
+
+
+CONFIG_DM_VIDEO
+---------------
+Deadline: 2019.07
+
+The video subsystem has supported driver model since early 2016. Maintainers
+should submit patches switching over to using CONFIG_DM_VIDEO and other base
+driver model options in time for inclusion in the 2019.07 release.