Linux Documentation
 help / color / mirror / Atom feed
* [PATCH] dm: fix dm-inlinecrypt docs warnings
@ 2026-05-12 18:04 Randy Dunlap
  2026-05-15 13:55 ` Jonathan Corbet
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2026-05-12 18:04 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, Linlin Zhang, Alasdair Kergon, Mike Snitzer,
	Mikulas Patocka, Benjamin Marzinski, dm-devel, Jonathan Corbet,
	Shuah Khan, linux-doc

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] dm: fix dm-inlinecrypt docs warnings
  2026-05-12 18:04 [PATCH] dm: fix dm-inlinecrypt docs warnings Randy Dunlap
@ 2026-05-15 13:55 ` Jonathan Corbet
  0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2026-05-15 13:55 UTC (permalink / raw)
  To: Randy Dunlap, linux-kernel
  Cc: Randy Dunlap, Linlin Zhang, Alasdair Kergon, Mike Snitzer,
	Mikulas Patocka, Benjamin Marzinski, dm-devel, Shuah Khan,
	linux-doc

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-05-15 13:55 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-05-12 18:04 [PATCH] dm: fix dm-inlinecrypt docs warnings Randy Dunlap
2026-05-15 13:55 ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox