Commit 4eb018bd authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Jonathan Corbet
Browse files

Documentation: fbcon: Use admonition directives 



Use reST syntax for admonitions (notes and custom admonition
for gotcha).

Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Tested-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Message-ID: <20250909063744.30053-4-bagasdotme@gmail.com>
parent cfa51cfd

Documentation/fb/fbcon.rst

+16 −12
Original line number Diff line number Diff line
@@ -39,7 +39,9 @@ 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

.. 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
@@ -117,7 +119,8 @@ 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

	.. 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.
@@ -141,7 +144,8 @@ 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

	.. 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.