]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
Documentation: fbcon: Use admonition directives
authorBagas Sanjaya <bagasdotme@gmail.com>
Tue, 9 Sep 2025 06:37:43 +0000 (13:37 +0700)
committerJonathan Corbet <corbet@lwn.net>
Thu, 18 Sep 2025 16:36:52 +0000 (10:36 -0600)
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>

Documentation/fb/fbcon.rst

index 3ed98b3ce64713d2b6c9959a12e12352fd8b087d..a98a5cb0b0d8bd3b8894896d884aa26b585dfdff 100644 (file)
@@ -39,11 +39,13 @@ Also, you will need to select at least one compiled-in font, but if
 you don't do anything, the kernel configuration tool will select one for you,
 usually an 8x16 font.
 
-GOTCHA: A common bug report is enabling the framebuffer without enabling the
-framebuffer console.  Depending on the driver, you may get a blanked or
-garbled display, but the system still boots to completion.  If you are
-fortunate to have a driver that does not alter the graphics chip, then you
-will still get a VGA console.
+.. admonition:: GOTCHA
+
+   A common bug report is enabling the framebuffer without enabling the
+   framebuffer console.  Depending on the driver, you may get a blanked or
+   garbled display, but the system still boots to completion.  If you are
+   fortunate to have a driver that does not alter the graphics chip, then you
+   will still get a VGA console.
 
 B. Loading
 ==========
@@ -117,9 +119,10 @@ C. Boot options
        outside the given range will still be controlled by the standard
        console driver.
 
-       NOTE: For x86 machines, the standard console is the VGA console which
-       is typically located on the same video card.  Thus, the consoles that
-       are controlled by the VGA console will be garbled.
+       .. note::
+          For x86 machines, the standard console is the VGA console which
+          is typically located on the same video card.  Thus, the consoles that
+          are controlled by the VGA console will be garbled.
 
 4. fbcon=rotate:<n>
 
@@ -141,10 +144,11 @@ C. Boot options
        Console rotation will only become available if Framebuffer Console
        Rotation support is compiled in your kernel.
 
-       NOTE: This is purely console rotation.  Any other applications that
-       use the framebuffer will remain at their 'normal' orientation.
-       Actually, the underlying fb driver is totally ignorant of console
-       rotation.
+       .. note::
+          This is purely console rotation.  Any other applications that
+          use the framebuffer will remain at their 'normal' orientation.
+          Actually, the underlying fb driver is totally ignorant of console
+          rotation.
 
 5. fbcon=margin:<color>