diff options
| author | Bagas Sanjaya <bagasdotme@gmail.com> | 2025-09-09 13:37:43 +0700 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2025-09-18 10:36:52 -0600 |
| commit | 4eb018bd15881504351c44f0d3d7287c88ef161f (patch) | |
| tree | a6fd47b58b6765c08822611571e1fae3156dedf9 | |
| parent | cfa51cfdb5100cecc3feb9ccdc08b17eeb711fe8 (diff) | |
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>
| -rw-r--r-- | Documentation/fb/fbcon.rst | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/Documentation/fb/fbcon.rst b/Documentation/fb/fbcon.rst index 3ed98b3ce647..a98a5cb0b0d8 100644 --- a/Documentation/fb/fbcon.rst +++ b/Documentation/fb/fbcon.rst @@ -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> |