tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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>
authored by
Bagas Sanjaya
and committed by
Jonathan Corbet
4eb018bd
cfa51cfd
+16
-12
+16
-12
Documentation/fb/fbcon.rst
+16
-12
Documentation/fb/fbcon.rst
···
39
39
you don't do anything, the kernel configuration tool will select one for you,
40
40
usually an 8x16 font.
41
41
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.
47
49
48
50
B. Loading
49
51
==========
···
119
117
outside the given range will still be controlled by the standard
120
118
console driver.
121
119
122
-
NOTE: For x86 machines, the standard console is the VGA console which
123
-
is typically located on the same video card. Thus, the consoles that
124
-
are controlled by the VGA console will be garbled.
120
+
.. note::
121
+
For x86 machines, the standard console is the VGA console which
122
+
is typically located on the same video card. Thus, the consoles that
123
+
are controlled by the VGA console will be garbled.
125
124
126
125
4. fbcon=rotate:<n>
127
126
···
144
141
Console rotation will only become available if Framebuffer Console
145
142
Rotation support is compiled in your kernel.
146
143
147
-
NOTE: This is purely console rotation. Any other applications that
148
-
use the framebuffer will remain at their 'normal' orientation.
149
-
Actually, the underlying fb driver is totally ignorant of console
150
-
rotation.
144
+
.. note::
145
+
This is purely console rotation. Any other applications that
146
+
use the framebuffer will remain at their 'normal' orientation.
147
+
Actually, the underlying fb driver is totally ignorant of console
148
+
rotation.
151
149
152
150
5. fbcon=margin:<color>
153
151