Skip to content

Commit 4eb018b

Browse files
bagasmeJonathan Corbet
authored andcommitted
Documentation: fbcon: Use admonition directives
Use reST syntax for admonitions (notes and custom admonition for gotcha). Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250909063744.30053-4-bagasdotme@gmail.com>
1 parent cfa51cf commit 4eb018b

1 file changed

Lines changed: 16 additions & 12 deletions

File tree

Documentation/fb/fbcon.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,13 @@ Also, you will need to select at least one compiled-in font, but if
3939
you don't do anything, the kernel configuration tool will select one for you,
4040
usually an 8x16 font.
4141

42-
GOTCHA: A common bug report is enabling the framebuffer without enabling the
43-
framebuffer console. Depending on the driver, you may get a blanked or
44-
garbled display, but the system still boots to completion. If you are
45-
fortunate to have a driver that does not alter the graphics chip, then you
46-
will still get a VGA console.
42+
.. admonition:: GOTCHA
43+
44+
A common bug report is enabling the framebuffer without enabling the
45+
framebuffer console. Depending on the driver, you may get a blanked or
46+
garbled display, but the system still boots to completion. If you are
47+
fortunate to have a driver that does not alter the graphics chip, then you
48+
will still get a VGA console.
4749

4850
B. Loading
4951
==========
@@ -117,9 +119,10 @@ C. Boot options
117119
outside the given range will still be controlled by the standard
118120
console driver.
119121

120-
NOTE: For x86 machines, the standard console is the VGA console which
121-
is typically located on the same video card. Thus, the consoles that
122-
are controlled by the VGA console will be garbled.
122+
.. note::
123+
For x86 machines, the standard console is the VGA console which
124+
is typically located on the same video card. Thus, the consoles that
125+
are controlled by the VGA console will be garbled.
123126

124127
4. fbcon=rotate:<n>
125128

@@ -141,10 +144,11 @@ C. Boot options
141144
Console rotation will only become available if Framebuffer Console
142145
Rotation support is compiled in your kernel.
143146

144-
NOTE: This is purely console rotation. Any other applications that
145-
use the framebuffer will remain at their 'normal' orientation.
146-
Actually, the underlying fb driver is totally ignorant of console
147-
rotation.
147+
.. note::
148+
This is purely console rotation. Any other applications that
149+
use the framebuffer will remain at their 'normal' orientation.
150+
Actually, the underlying fb driver is totally ignorant of console
151+
rotation.
148152

149153
5. fbcon=margin:<color>
150154

0 commit comments

Comments
 (0)