mbox series

[v2,0/2] docs: mtd: spi-nor: add sections about flash additions and testing

Message ID 20231124184902.1194235-1-tudor.ambarus@linaro.org
Headers show
Series docs: mtd: spi-nor: add sections about flash additions and testing | expand

Message

Tudor Ambarus Nov. 24, 2023, 6:49 p.m. UTC 
v2:
- specify that we prefer to dump the SFDP data with ``xxd -p`` (Michael)
- update the mtd-utils tests (Pratyush)
- fix formatting (Bagas)

Introduce guide about when to propose a new flash addition and what are
the minimum testing requirements. Dropped the old documentation as it
no longer applies to the current SPI NOR framework state.

Generate the htmldoc by using ``make htmldocs`` and then find the
SPI NOR documentation at
``Documentation/output/driver-api/mtd/spi-nor.html``

Tudor Ambarus (2):
  docs: mtd: spi-nor: add sections about flash additions and testing
  docs: mtd: spi-nor: drop obsolete info

 Documentation/driver-api/mtd/spi-nor.rst | 247 +++++++++++++++++------
 1 file changed, 186 insertions(+), 61 deletions(-)

Comments

Tudor Ambarus Nov. 24, 2023, 8:20 p.m. UTC | #1 
On Fri, 24 Nov 2023 20:49:00 +0200, Tudor Ambarus wrote:
> v2:
> - specify that we prefer to dump the SFDP data with ``xxd -p`` (Michael)
> - update the mtd-utils tests (Pratyush)
> - fix formatting (Bagas)
> 
> Introduce guide about when to propose a new flash addition and what are
> the minimum testing requirements. Dropped the old documentation as it
> no longer applies to the current SPI NOR framework state.
> 
> [...]

Introduced the extra erase test. I guess the proposed mtd-utils
test suite can be implemented as a dedicated mtd-utils standard test.
Exercise for the readers or for future self.

Applied to git://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git,
spi-nor/next branch. Thanks!

[1/2] docs: mtd: spi-nor: add sections about flash additions and testing
      https://git.kernel.org/mtd/c/bb1f9e39c1bf
[2/2] docs: mtd: spi-nor: drop obsolete info
      https://git.kernel.org/mtd/c/9b3eae3486c8

Cheers,