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 <rdun...@infradead.org>
Signed-off-by: Tobin C. Harding <m...@tobin.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

Reply via email to