Linux Documentation
 help / color / mirror / Atom feed
From: kernel test robot <lkp@intel.com>
To: Miquel Raynal <miquel.raynal@bootlin.com>
Cc: oe-kbuild-all@lists.linux.dev,
	Pratyush Yadav <pratyush@kernel.org>,
	linux-doc@vger.kernel.org
Subject: [mtd:spi-nor/next 20/28] htmldocs: Documentation/driver-api/mtd/spi-nor.rst:216: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
Date: Wed, 27 May 2026 01:24:04 +0200	[thread overview]
Message-ID: <202605270105.CZQo8wSO-lkp@intel.com> (raw)

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git spi-nor/next
head:   113ff79be3bcf0262eb7860d3325dd951ff29499
commit: ecbba8d91f4bd0fccd722a7e5a57cec385c11ca8 [20/28] mtd: spi-nor: Add steps for testing locking support
compiler: clang version 20.1.8 (https://github.com/llvm/llvm-project 87f0227cb60147a26a1eeb4fb06e3b505e9c7261)
docutils: docutils (Docutils 0.21.2, Python 3.13.5, on linux)
reproduce: (https://download.01.org/0day-ci/archive/20260527/202605270105.CZQo8wSO-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202605270105.CZQo8wSO-lkp@intel.com/

All warnings (new ones prefixed by >>):

   Documentation/driver-api/basics:42: ./kernel/time/time.c:370: WARNING: Duplicate C declaration, also defined at driver-api/basics:436.
   Declaration is '.. c:function:: unsigned int jiffies_to_msecs (const unsigned long j)'. [duplicate_declaration.c]
   Documentation/driver-api/basics:42: ./kernel/time/time.c:393: WARNING: Duplicate C declaration, also defined at driver-api/basics:453.
   Declaration is '.. c:function:: unsigned int jiffies_to_usecs (const unsigned long j)'. [duplicate_declaration.c]
   Documentation/driver-api/mtd/spi-nor.rst:215: ERROR: Unexpected indentation. [docutils]
>> Documentation/driver-api/mtd/spi-nor.rst:216: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
   Documentation/driver-api/target:25: ./drivers/target/target_core_user.c:35: ERROR: Unexpected section title.


vim +216 Documentation/driver-api/mtd/spi-nor.rst

    78	
    79	    root@1:~# cat /sys/kernel/debug/spi-nor/spi0.0/capabilities
    80	    Supported read modes by the flash
    81	     1S-1S-1S
    82	      opcode		0x03
    83	      mode cycles	0
    84	      dummy cycles	0
    85	     1S-1S-1S (fast read)
    86	      opcode		0x0b
    87	      mode cycles	0
    88	      dummy cycles	8
    89	     1S-1S-2S
    90	      opcode		0x3b
    91	      mode cycles	0
    92	      dummy cycles	8
    93	     1S-2S-2S
    94	      opcode		0xbb
    95	      mode cycles	4
    96	      dummy cycles	0
    97	     1S-1S-4S
    98	      opcode		0x6b
    99	      mode cycles	0
   100	      dummy cycles	8
   101	     1S-4S-4S
   102	      opcode		0xeb
   103	      mode cycles	2
   104	      dummy cycles	4
   105	     4S-4S-4S
   106	      opcode		0x0b
   107	      mode cycles	2
   108	      dummy cycles	4
   109	
   110	    Supported page program modes by the flash
   111	     1S-1S-1S
   112	      opcode	0x02
   113	
   114	    root@1:~# cat /sys/kernel/debug/spi-nor/spi0.0/params
   115	    name		sst26vf064b
   116	    id			bf 26 43 bf 26 43
   117	    size		8.00 MiB
   118	    write size		1
   119	    page size		256
   120	    address nbytes	3
   121	    flags		HAS_LOCK | HAS_16BIT_SR | SOFT_RESET | SWP_IS_VOLATILE
   122	
   123	    opcodes
   124	     read		0xeb
   125	      dummy cycles	6
   126	     erase		0x20
   127	     program		0x02
   128	     8D extension	none
   129	
   130	    protocols
   131	     read		1S-4S-4S
   132	     write		1S-1S-1S
   133	     register		1S-1S-1S
   134	
   135	    erase commands
   136	     20 (4.00 KiB) [0]
   137	     d8 (8.00 KiB) [1]
   138	     d8 (32.0 KiB) [2]
   139	     d8 (64.0 KiB) [3]
   140	     c7 (8.00 MiB)
   141	
   142	    sector map
   143	     region (in hex)   | erase mask | flags
   144	     ------------------+------------+----------
   145	     00000000-00007fff |     [01  ] |
   146	     00008000-0000ffff |     [0 2 ] |
   147	     00010000-007effff |     [0  3] |
   148	     007f0000-007f7fff |     [0 2 ] |
   149	     007f8000-007fffff |     [01  ] |
   150	
   151	4) Use `mtd-utils <https://git.infradead.org/mtd-utils.git>`__
   152	   and verify that erase, read and page program operations work fine::
   153	
   154	    root@1:~# dd if=/dev/urandom of=./spi_test bs=1M count=2
   155	    2+0 records in
   156	    2+0 records out
   157	    2097152 bytes (2.1 MB, 2.0 MiB) copied, 0.848566 s, 2.5 MB/s
   158	
   159	    root@1:~# mtd_debug erase /dev/mtd0 0 2097152
   160	    Erased 2097152 bytes from address 0x00000000 in flash
   161	
   162	    root@1:~# mtd_debug read /dev/mtd0 0 2097152 spi_read
   163	    Copied 2097152 bytes from address 0x00000000 in flash to spi_read
   164	
   165	    root@1:~# hexdump spi_read
   166	    0000000 ffff ffff ffff ffff ffff ffff ffff ffff
   167	    *
   168	    0200000
   169	
   170	    root@1:~# sha256sum spi_read
   171	    4bda3a28f4ffe603c0ec1258c0034d65a1a0d35ab7bd523a834608adabf03cc5  spi_read
   172	
   173	    root@1:~# mtd_debug write /dev/mtd0 0 2097152 spi_test
   174	    Copied 2097152 bytes from spi_test to address 0x00000000 in flash
   175	
   176	    root@1:~# mtd_debug read /dev/mtd0 0 2097152 spi_read
   177	    Copied 2097152 bytes from address 0x00000000 in flash to spi_read
   178	
   179	    root@1:~# sha256sum spi*
   180	    c444216a6ba2a4a66cccd60a0dd062bce4b865dd52b200ef5e21838c4b899ac8  spi_read
   181	    c444216a6ba2a4a66cccd60a0dd062bce4b865dd52b200ef5e21838c4b899ac8  spi_test
   182	
   183	   If the flash comes erased by default and the previous erase was ignored,
   184	   we won't catch it, thus test the erase again::
   185	
   186	    root@1:~# mtd_debug erase /dev/mtd0 0 2097152
   187	    Erased 2097152 bytes from address 0x00000000 in flash
   188	
   189	    root@1:~# mtd_debug read /dev/mtd0 0 2097152 spi_read
   190	    Copied 2097152 bytes from address 0x00000000 in flash to spi_read
   191	
   192	    root@1:~# sha256sum spi*
   193	    4bda3a28f4ffe603c0ec1258c0034d65a1a0d35ab7bd523a834608adabf03cc5  spi_read
   194	    c444216a6ba2a4a66cccd60a0dd062bce4b865dd52b200ef5e21838c4b899ac8  spi_test
   195	
   196	   Dump some other relevant data::
   197	
   198	    root@1:~# mtd_debug info /dev/mtd0
   199	    mtd.type = MTD_NORFLASH
   200	    mtd.flags = MTD_CAP_NORFLASH
   201	    mtd.size = 8388608 (8M)
   202	    mtd.erasesize = 4096 (4K)
   203	    mtd.writesize = 1
   204	    mtd.oobsize = 0
   205	    regions = 0
   206	
   207	5) If your flash supports locking, please go through the following test
   208	   procedure to make sure it correctly behaves. The below example
   209	   expects the typical situation where eraseblocks and lock sectors have
   210	   the same size. In case you enabled MTD_SPI_NOR_USE_4K_SECTORS, you
   211	   must adapt `bs` accordingly.
   212	
   213	   Warning: These tests may hard lock your device! Make sure:
   214	   - The device is not hard locked already (#WP strapped to low and
   215	     SR_SRWD bit set)
 > 216	   - If you have a WPn pin, you may want to set `no-wp` in your DT for

--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

             reply	other threads:[~2026-05-26 23:24 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-26 23:24 kernel test robot [this message]
2026-05-27  0:16 ` [mtd:spi-nor/next 20/28] htmldocs: Documentation/driver-api/mtd/spi-nor.rst:216: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils] Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=202605270105.CZQo8wSO-lkp@intel.com \
    --to=lkp@intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=miquel.raynal@bootlin.com \
    --cc=oe-kbuild-all@lists.linux.dev \
    --cc=pratyush@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox