[PATCH] dm: fix dm-inlinecrypt docs warnings

Randy Dunlap posted 1 patch 1 month ago
Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst |    4 ++--
Documentation/admin-guide/device-mapper/index.rst          |    1 +
2 files changed, 3 insertions(+), 2 deletions(-)
[PATCH] dm: fix dm-inlinecrypt docs warnings
Posted by Randy Dunlap 1 month ago
Add this file to the index and use a longer heading overline string
to eliminate warnings:

Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst:1: WARNING: Title overline too short.
========
dm-inlinecrypt
========
Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst: WARNING: document isn't included in any toctree [toc.not_included]

Fixes: b4a0774bd7fd ("dm: add documentation for dm-inlinecrypt target")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Linlin Zhang <linlin.zhang@oss.qualcomm.com>
Cc: Alasdair Kergon <agk@redhat.com>
Cc: Mike Snitzer <snitzer@kernel.org>
Cc: Mikulas Patocka <mpatocka@redhat.com>
Cc: Benjamin Marzinski <bmarzins@redhat.com>
Cc: dm-devel@lists.linux.dev
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-doc@vger.kernel.org

 Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst |    4 ++--
 Documentation/admin-guide/device-mapper/index.rst          |    1 +
 2 files changed, 3 insertions(+), 2 deletions(-)

--- linux-next-20260508.orig/Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst
+++ linux-next-20260508/Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst
@@ -1,6 +1,6 @@
-========
+==============
 dm-inlinecrypt
-========
+==============
 
 Device-Mapper's "inlinecrypt" target provides transparent encryption of block devices
 using the inline encryption hardware.
--- linux-next-20260508.orig/Documentation/admin-guide/device-mapper/index.rst
+++ linux-next-20260508/Documentation/admin-guide/device-mapper/index.rst
@@ -15,6 +15,7 @@ Device Mapper
     dm-flakey
     dm-ima
     dm-init
+    dm-inlinecrypt
     dm-integrity
     dm-io
     dm-log
Re: [PATCH] dm: fix dm-inlinecrypt docs warnings
Posted by Jonathan Corbet 4 weeks ago
Randy Dunlap <rdunlap@infradead.org> writes:

> Add this file to the index and use a longer heading overline string
> to eliminate warnings:
>
> Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst:1: WARNING: Title overline too short.
> ========
> dm-inlinecrypt
> ========
> Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst: WARNING: document isn't included in any toctree [toc.not_included]
>
> Fixes: b4a0774bd7fd ("dm: add documentation for dm-inlinecrypt target")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Linlin Zhang <linlin.zhang@oss.qualcomm.com>
> Cc: Alasdair Kergon <agk@redhat.com>
> Cc: Mike Snitzer <snitzer@kernel.org>
> Cc: Mikulas Patocka <mpatocka@redhat.com>
> Cc: Benjamin Marzinski <bmarzins@redhat.com>
> Cc: dm-devel@lists.linux.dev
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-doc@vger.kernel.org
>
>  Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst |    4 ++--
>  Documentation/admin-guide/device-mapper/index.rst          |    1 +
>  2 files changed, 3 insertions(+), 2 deletions(-)

This doesn't apply to docs-next, so I'm guessing it's intended for some
other tree?

Thanks,

jon
Re: [PATCH] dm: fix dm-inlinecrypt docs warnings
Posted by Randy Dunlap 4 weeks ago

On 5/15/26 6:55 AM, Jonathan Corbet wrote:
> Randy Dunlap <rdunlap@infradead.org> writes:
> 
>> Add this file to the index and use a longer heading overline string
>> to eliminate warnings:
>>
>> Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst:1: WARNING: Title overline too short.
>> ========
>> dm-inlinecrypt
>> ========
>> Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst: WARNING: document isn't included in any toctree [toc.not_included]
>>
>> Fixes: b4a0774bd7fd ("dm: add documentation for dm-inlinecrypt target")
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> ---
>> Cc: Linlin Zhang <linlin.zhang@oss.qualcomm.com>
>> Cc: Alasdair Kergon <agk@redhat.com>
>> Cc: Mike Snitzer <snitzer@kernel.org>
>> Cc: Mikulas Patocka <mpatocka@redhat.com>
>> Cc: Benjamin Marzinski <bmarzins@redhat.com>
>> Cc: dm-devel@lists.linux.dev
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: Shuah Khan <skhan@linuxfoundation.org>
>> Cc: linux-doc@vger.kernel.org
>>
>>  Documentation/admin-guide/device-mapper/dm-inlinecrypt.rst |    4 ++--
>>  Documentation/admin-guide/device-mapper/index.rst          |    1 +
>>  2 files changed, 3 insertions(+), 2 deletions(-)
> 
> This doesn't apply to docs-next, so I'm guessing it's intended for some
> other tree?

Right. It should go thru the device-mapper tree.

@Mikulas merged this file.

thanks.
-- 
~Randy