linux-kernel - [PATCH 3/3] docs: Fix docs for boot parameter debug_boot_weak

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20180710002519.5044-4-me@tobin.cc>
Date:   Tue, 10 Jul 2018 10:25:19 +1000
From:   "Tobin C. Harding" <me@...in.cc>
To:     Theodore Ts'o <tytso@....edu>
Cc:     "Tobin C. Harding" <me@...in.cc>, Petr Mladek <pmladek@...e.com>,
        Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
        Randy Dunlap <rdunlap@...radead.org>,
        "Steven Rostedt (VMware)" <rostedt@...dmis.org>,
        Sergey Senozhatsky <sergey.senozhatsky@...il.com>,
        Arnd Bergmann <arnd@...db.de>, linux-kernel@...r.kernel.org
Subject: [PATCH 3/3] docs: Fix docs for boot parameter debug_boot_weak_hash

Recently boot parameter 'debug_boot_weak_hash' was added.  Latter
discussion on LKML developed more descriptive documentation but due to
the programmers lack of understanding (*cough* me) on how linux-next
works these improvements never got picked up.

Update documentation for boot parameter 'debug_boot_weak_hash' as
discussed (patch posted and acked) on LKML.

Fixes: bfe80ed3d7c76 ("vsprintf: add command line option debug_boot_weak_hash")
Acked-by: Randy Dunlap <rdunlap@...radead.org>
Signed-off-by: Tobin C. Harding <me@...in.cc>
---
 Documentation/admin-guide/kernel-parameters.txt | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 31c9b76058a7..e3b1c84d19c6 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -749,13 +749,12 @@
 	debug		[KNL] Enable kernel debugging (events log level).
 
 	debug_boot_weak_hash
-			[KNL] Enable printing pointers early in the boot
-			sequence.  If enabled, we use a weak hash instead of
-			siphash to hash pointers.  Use this option if you need
-			to see pointer values during early boot (i.e you are
-			seeing instances of '(___ptrval___)').
-			Cryptographically insecure, please do not use on
-			production kernels.
+			[KNL] Enable printing [hashed] pointers early in the
+			boot sequence.  If enabled, we use a weak hash instead
+			of siphash to hash pointers.  Use this option if you are
+			seeing instances of '(___ptrval___)') and need to see a
+			value (hashed pointer) instead. Cryptographically
+			insecure, please do not use on production kernels.
 
 	debug_locks_verbose=
 			[KNL] verbose self-tests
-- 
2.17.1