[PATCH v3] docs: fb: Remove framebuffer scrollback boot option

[PATCH v3] docs: fb: Remove framebuffer scrollback boot option

[Bhaskar Chowdhury]

This patch remove reference to this option in this document and 
renumbered the sections. This is related to below commits.

Commit 973c096f6a85(vgacon: remove software scrollback support)
Commit 50145474f6ef(fbcon: remove soft scrollback code)
 

Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>
---
This version try to correct the previous errors, proper changelog text, subject
Trying to incorporate Willy's & Greg's suggestions
 
 Documentation/fb/fbcon.rst | 21 +++++++--------------
 1 file changed, 7 insertions(+), 14 deletions(-)

diff --git a/Documentation/fb/fbcon.rst b/Documentation/fb/fbcon.rst
index e57a3d1d085a..328f6980698c 100644
--- a/Documentation/fb/fbcon.rst
+++ b/Documentation/fb/fbcon.rst
@@ -87,15 +87,8 @@ C. Boot options
 	Note, not all drivers can handle font with widths not divisible by 8,
 	such as vga16fb.
 
-2. fbcon=scrollback:<value>[k]
 
-	The scrollback buffer is memory that is used to preserve display
-	contents that has already scrolled past your view.  This is accessed
-	by using the Shift-PageUp key combination.  The value 'value' is any
-	integer. It defaults to 32KB.  The 'k' suffix is optional, and will
-	multiply the 'value' by 1024.
-
-3. fbcon=map:<0123>
+2. fbcon=map:<0123>
 
 	This is an interesting option. It tells which driver gets mapped to
 	which console. The value '0123' is a sequence that gets repeated until
@@ -116,7 +109,7 @@ C. Boot options
 	Later on, when you want to map the console the to the framebuffer
 	device, you can use the con2fbmap utility.
 
-4. fbcon=vc:<n1>-<n2>
+3. fbcon=vc:<n1>-<n2>
 
 	This option tells fbcon to take over only a range of consoles as
 	specified by the values 'n1' and 'n2'. The rest of the consoles
@@ -127,7 +120,7 @@ C. Boot options
 	is typically located on the same video card.  Thus, the consoles that
 	are controlled by the VGA console will be garbled.
 
-5. fbcon=rotate:<n>
+4. fbcon=rotate:<n>
 
 	This option changes the orientation angle of the console display. The
 	value 'n' accepts the following:
@@ -152,21 +145,21 @@ C. Boot options
 	Actually, the underlying fb driver is totally ignorant of console
 	rotation.
 
-6. fbcon=margin:<color>
+5. fbcon=margin:<color>
 
 	This option specifies the color of the margins. The margins are the
 	leftover area at the right and the bottom of the screen that are not
 	used by text. By default, this area will be black. The 'color' value
 	is an integer number that depends on the framebuffer driver being used.
 
-7. fbcon=nodefer
+6. fbcon=nodefer
 
 	If the kernel is compiled with deferred fbcon takeover support, normally
 	the framebuffer contents, left in place by the firmware/bootloader, will
 	be preserved until there actually is some text is output to the console.
 	This option causes fbcon to bind immediately to the fbdev device.
 
-8. fbcon=logo-pos:<location>
+7. fbcon=logo-pos:<location>
 
 	The only possible 'location' is 'center' (without quotes), and when
 	given, the bootup logo is moved from the default top-left corner
@@ -174,7 +167,7 @@ C. Boot options
 	displayed due to multiple CPUs, the collected line of logos is moved
 	as a whole.
 
-9. fbcon=logo-count:<n>
+8. fbcon=logo-count:<n>
 
 	The value 'n' overrides the number of bootup logos. 0 disables the
 	logo, and -1 gives the default which is the number of online CPUs.
-- 
2.28.0

Re: [PATCH v3] docs: fb: Remove framebuffer scrollback boot option

[Greg KH]

On Thu, Sep 17, 2020 at 04:31:50AM +0530, Bhaskar Chowdhury wrote:
> This patch remove reference to this option in this document and 
> renumbered the sections. This is related to below commits.
> 
> Commit 973c096f6a85(vgacon: remove software scrollback support)
> Commit 50145474f6ef(fbcon: remove soft scrollback code)
>  
> 
> Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>
> ---
> This version try to correct the previous errors, proper changelog text, subject
> Trying to incorporate Willy's & Greg's suggestions

Better, but...

This should be a patch series, properly numbered and threaded, right?

The text above still has the commit ids not properly referenced, and you
have trailing whitespace in the text too.

Writing the changelog is often times the hardest part of a patch, as you
are finding out.

How about this example, for this specific patch, as a changelog text:

---------
In commit 50145474f6ef ("fbcon: remove soft scrollback code"), the
framebuffer scrollback mode was removed, but the documentation was not
updated.  Properly update the documentation by removing the option that
is no longer present, and update the section numbering because of the
removal.
---------

Doesn't that make more sense about what is happening here, and provide
enough information that when someone 10+ years from now goes and tries
to find out why a boot option went away, what exactly happened and why?

Can you make this type of change to all 4 of these patches and resend
them, with the proper change information below the --- line as a v4
series?

thanks,

greg k-h

Re: [PATCH v3] docs: fb: Remove framebuffer scrollback boot option

[Bhaskar Chowdhury]

[-- Attachment #1: Type: text/plain, Size: 2003 bytes --]

On 09:47 Thu 17 Sep 2020, Greg KH wrote:
>On Thu, Sep 17, 2020 at 04:31:50AM +0530, Bhaskar Chowdhury wrote:
>> This patch remove reference to this option in this document and 
>> renumbered the sections. This is related to below commits.
>> 
>> Commit 973c096f6a85(vgacon: remove software scrollback support)
>> Commit 50145474f6ef(fbcon: remove soft scrollback code)
>>  
>> 
>> Signed-off-by: Bhaskar Chowdhury <unixbhaskar@gmail.com>
>> ---
>> This version try to correct the previous errors, proper changelog text, subject
>> Trying to incorporate Willy's & Greg's suggestions
>
>Better, but...
>
>This should be a patch series, properly numbered and threaded, right?
>
>The text above still has the commit ids not properly referenced, and you
>have trailing whitespace in the text too.
>
I will certainly fix that in the upcoming version.

>Writing the changelog is often times the hardest part of a patch, as you
>are finding out.
>
Yes..true.
>How about this example, for this specific patch, as a changelog text:
>
>---------
>In commit 50145474f6ef ("fbcon: remove soft scrollback code"), the
>framebuffer scrollback mode was removed, but the documentation was not
>updated.  Properly update the documentation by removing the option that
>is no longer present, and update the section numbering because of the
>removal.
>---------
Just like an pointed arrow ..perfect...cut to the cheese!
>
>Doesn't that make more sense about what is happening here, and provide
>enough information that when someone 10+ years from now goes and tries
>to find out why a boot option went away, what exactly happened and why?
>
Absolutely.

>Can you make this type of change to all 4 of these patches and resend
>them, with the proper change information below the --- line as a v4
>series?
>

Certain thing...will incorporate your suggestions in V4 and send.

>thanks,

Indebted for your and others patience for standing this long ..thank you!
>
>greg k-h

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]