Skip to contentSkip to conversation

docs: fb: Removed framebuffer scrollback related documentations

PATCH In review Bhaskar Chowdhury 3 participants 7 messages Sep 17, 2020 – Sep 24, 2020

Subsystems (3)
Documentation Framebuffer layer Framebuffer console
lore
Share & tools
lore

Bhaskar Chowdhury

author
#0 lore raw

v4 cover docs: fb: Removed framebuffer scrollback related documentations

In this patch series, documentation get in sync with the code removal of scrollback,by this commit 50145474f6ef ("fbcon: remove soft scrollback code"), by eliminating the information related to it.

Changes since V3:

Remove the wrong commit hash and messages from all the 4 patches i.e Commit 973c096f6a85(vgacon: remove software scrollback support) from the patches as suggested by Willy and Greg.

Patch 1: Remove the documentation related to framebuffer scrollback from the file
fbcon.rst

Patch 2: Remove the documentation boot option for scrollback from the file matroxfb.rst

Patch 3: Remove the documentation scrollback option from sstfb.rst file.

Patch 4: Remove the documentation scrollback option from vesafb.rst file.

Bhaskar Chowdhury (4):
Remove framebuffer scrollback boot option
Remove matroxfb scrollback boot option
Remove sstfb scrollback boot option
Remove vesafb scrollback boot option

 Documentation/fb/fbcon.rst    | 21 +++++++--------------
 Documentation/fb/matroxfb.rst |  2 --
 Documentation/fb/sstfb.rst    |  3 ---
 Documentation/fb/vesafb.rst   |  2 --
 4 files changed, 7 insertions(+), 21 deletions(-)
Signature · 1 line
2.28.0
author
#1 lore raw

PATCH v4 1/4 docs: fb: Remove framebuffer scrollback boot option

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.

Signed-off-by Bhaskar Chowdhury <[email protected]>

---
Change since V3:
Following the suggestions from Willy and Greg.In this version remove the not relevant commit hash and messages from the changelog.

 Documentation/fb/fbcon.rst | 21 +++++++--------------
 1 file changed, 7 insertions(+), 14 deletions(-)
Documentation/fb/fbcon.rst +7 -14
index e57a3d1d085a..328f6980698c 100644
@@ -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.
Signature · 1 line
2.28.0
author
#2 lore raw

PATCH v4 2/4 docs: fb: Remove matroxfb scrollback boot option

In reply to Bhaskar Chowdhury

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 pressent, and removed the particular scrollback option.

Signed-off-by Bhaskar Chowdhury <[email protected]>

---
Change since V3:
Following Willy's and Greg's suggestion ,in this version removing the not relevant hash and commit from the changelog and put a proper one.

 Documentation/fb/matroxfb.rst | 2 --
 1 file changed, 2 deletions(-)
Documentation/fb/matroxfb.rst +0 -2
index f1859d98606e..6158c49c8571 100644
@@ -317,8 +317,6 @@ Currently there are following known bugs:
  - interlaced text mode is not supported; it looks like hardware limitation,
    but I'm not sure.
  - Gxx0 SGRAM/SDRAM is not autodetected.
- - If you are using more than one framebuffer device, you must boot kernel
-   with 'video=scrollback:0'.
  - maybe more...
 
 And following misfeatures:
Signature · 1 line
2.28.0
author
#3 lore raw

PATCH v4 3/4 docs: fb: Remove sstfb scrollback boot option

In reply to Bhaskar Chowdhury

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 i.e remove a stanza related to scrollback.

Signed-off-by Bhaskar Chowdhury <[email protected]>

---
Changesince V3:
Following Willy's and Greg's suggestion remove the not relevant commit hash and message from the changelog and put a correct one.

 Documentation/fb/sstfb.rst | 3 ---
 1 file changed, 3 deletions(-)
Documentation/fb/sstfb.rst +0 -3
index 8e8c1b940359..42466ff49c58 100644
@@ -185,9 +185,6 @@ Bugs
   contact me.
 - The 24/32 is not likely to work anytime soon, knowing that the
   hardware does ... unusual things in 24/32 bpp.
-- When used with another video board, current limitations of the linux
-  console subsystem can cause some troubles, specifically, you should
-  disable software scrollback, as it can oops badly ...
 
 Todo
 ====
Signature · 1 line
2.28.0
author
#4 lore raw

PATCH v4 4/4 docs: fb: Remove vesafb scrollback boot option

In reply to Bhaskar Chowdhury

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,remove the scrollback option.

Signed-off-by Bhaskar Chowdhury <[email protected]>

---
Changes since V3:
Following Willy's and Greg's suggestion,get rid of not relevant commit hash and message from changelog and put a correct one.

 Documentation/fb/vesafb.rst | 2 --
 1 file changed, 2 deletions(-)
Documentation/fb/vesafb.rst +0 -2
index 6821c87b7893..f890a4f5623b 100644
@@ -135,8 +135,6 @@ ypan	  enable display panning using the VESA protected mode
 
                 * scrolling (fullscreen) is fast, because there is
 		  no need to copy around data.
-		* You'll get scrollback (the Shift-PgUp thing),
-		  the video memory can be used as scrollback buffer
 
           kontra:
Signature · 1 line
2.28.0
Reviewed-by on the v4 series
#5 lore raw
In reply to Bhaskar Chowdhury
Quoted 4 lines · Bhaskar Chowdhury

In this patch series, documentation get in sync with the code removal of scrollback,by this commit 50145474f6ef ("fbcon: remove soft scrollback code"), by eliminating the information related to it.

Much nicer, thanks for sticking with it:

Reviewed-by Greg Kroah-Hartman <[email protected]>
maintainer
#6 lore raw
In reply to Bhaskar Chowdhury
Quoted 11 lines · On Thu, 17 Sep 2020 15:56:11 +0530 Bhaskar Chowdhury <[email protected]>…

In this patch series, documentation get in sync with the code removal of scrollback,by this commit 50145474f6ef ("fbcon: remove soft scrollback code"), by eliminating the information related to it.

Changes since V3:

Remove the wrong commit hash and messages from all the 4 patches i.e Commit 973c096f6a85(vgacon: remove software scrollback support) from the patches as suggested by Willy and Greg.

Quoted 8 lines

Patch 1: Remove the documentation related to framebuffer scrollback from the file
fbcon.rst

Patch 2: Remove the documentation boot option for scrollback from the file matroxfb.rst

Patch 3: Remove the documentation scrollback option from sstfb.rst file.

Patch 4: Remove the documentation scrollback option from vesafb.rst file.

Set applied, thanks.

jon