[PATCH -next] Documentation: Explain the [KMG] parameters suffix

[PATCH -next] Documentation: Explain the [KMG] parameters suffix

[Ahmed S. Darwish]

(Also applicable over 2.6.38-rc3)

The '[KMG]' suffix is commonly described after a number of kernel
parameter values documentation.  Explicitly state its semantics.

Signed-off-by: Ahmed S. Darwish <darwish.07@gmail.com>
---

diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index 89835a4..3deedce 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -144,6 +144,11 @@ a fixed number of characters. This limit depends on the architecture
 and is between 256 and 4096 characters. It is defined in the file
 ./include/asm/setup.h as COMMAND_LINE_SIZE.
 
+Finally, the [KMG] suffix is commonly described after a number of kernel
+parameter values. These 'K', 'M', and 'G' letters represent the _binary_
+multipliers 'Kilo', 'Mega', and 'Giga', equalling 2^10, 2^20, and 2^30
+bytes respectively. Such letter suffixes can also be entirely omitted.
+
 
 	acpi=		[HW,ACPI,X86]
 			Advanced Configuration and Power Interface

regards,

-- 
Darwish
http://darwish.07.googlepages.com

[PATCH] Documentation: log_buf_len accepts [KMG]

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

Update the "log_buf_len" description to use [KMG] syntax for the
buffer size.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 Documentation/kernel-parameters.txt |    7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

--- linux-next-20110204.orig/Documentation/kernel-parameters.txt
+++ linux-next-20110204/Documentation/kernel-parameters.txt
@@ -1262,10 +1262,9 @@ and is between 256 and 4096 characters. 
 			6 (KERN_INFO)		informational
 			7 (KERN_DEBUG)		debug-level messages
 
-	log_buf_len=n	Sets the size of the printk ring buffer, in bytes.
-			Format: { n | nk | nM }
-			n must be a power of two.  The default size
-			is set in the kernel config file.
+	log_buf_len=n[KMG]	Sets the size of the printk ring buffer,
+			in bytes.  n must be a power of two.  The default
+			size is set in the kernel config file.
 
 	logo.nologo	[FB] Disables display of the built-in Linux logo.
 			This may be used to provide more screen space for

Re: [PATCH] Documentation: log_buf_len accepts [KMG]

[Ahmed S. Darwish]

On Sun, Feb 06, 2011 at 08:40:02PM -0800, Randy Dunlap wrote:
> 
> Update the "log_buf_len" description to use [KMG] syntax for the
> buffer size.
> 
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
> ---
> 

This implies an ACK for the original patch?

-- 
Darwish
http://darwish.07.googlepages.com

Re: [PATCH] Documentation: log_buf_len accepts [KMG]

[Randy Dunlap]

On 02/07/11 03:40, Ahmed S. Darwish wrote:
> On Sun, Feb 06, 2011 at 08:40:02PM -0800, Randy Dunlap wrote:
>>
>> Update the "log_buf_len" description to use [KMG] syntax for the
>> buffer size.
>>
>> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
>> ---
>>
> 
> This implies an ACK for the original patch?

Sorry, I meant to do that separately, but yes, I'll merge it.

-- 
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***