public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: "Tobin C. Harding" <me@tobin.cc>
To: Theodore Ts'o <tytso@mit.edu>
Cc: "Tobin C. Harding" <me@tobin.cc>, Petr Mladek <pmladek@suse.com>,
	Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
	Randy Dunlap <rdunlap@infradead.org>,
	"Steven Rostedt (VMware)" <rostedt@goodmis.org>,
	Sergey Senozhatsky <sergey.senozhatsky@gmail.com>,
	Arnd Bergmann <arnd@arndb.de>,
	linux-kernel@vger.kernel.org
Subject: [PATCH 3/3] docs: Fix docs for boot parameter debug_boot_weak_hash
Date: Tue, 10 Jul 2018 10:25:19 +1000	[thread overview]
Message-ID: <20180710002519.5044-4-me@tobin.cc> (raw)
In-Reply-To: <20180710002519.5044-1-me@tobin.cc>

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


  parent reply	other threads:[~2018-07-10  0:26 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-10  0:25 [PATCH 0/3] fix: enable early printing of hashed pointers Tobin C. Harding
2018-07-10  0:25 ` [PATCH 1/3] random: Remove unnecessary cast Tobin C. Harding
2018-07-10  2:06   ` Steven Rostedt
2018-07-10  0:25 ` [PATCH 2/3] vsprintf: Remove incorrect EXPORT_SYMBOL Tobin C. Harding
2018-07-10  2:12   ` Steven Rostedt
2018-07-10  0:25 ` Tobin C. Harding [this message]
2018-07-10  2:14   ` [PATCH 3/3] docs: Fix docs for boot parameter debug_boot_weak_hash Steven Rostedt
2018-07-10  2:07 ` [PATCH 0/3] fix: enable early printing of hashed pointers Steven Rostedt
2018-07-10  2:59   ` Tobin C. Harding

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=20180710002519.5044-4-me@tobin.cc \
    --to=me@tobin.cc \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=arnd@arndb.de \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pmladek@suse.com \
    --cc=rdunlap@infradead.org \
    --cc=rostedt@goodmis.org \
    --cc=sergey.senozhatsky@gmail.com \
    --cc=tytso@mit.edu \
    /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