* [PATCH 0/3] framebuffer docs toctree index refactoring
@ 2025-09-19 0:36 Bagas Sanjaya
2025-09-19 0:36 ` [PATCH 1/3] Documentation: fb: ep93xx: Demote section headings Bagas Sanjaya
` (2 more replies)
0 siblings, 3 replies; 8+ messages in thread
From: Bagas Sanjaya @ 2025-09-19 0:36 UTC (permalink / raw)
To: Linux Kernel Mailing List, Linux Documentation, Linux Framebuffer,
Linux DRI Development
Cc: Helge Deller, Jonathan Corbet, Sudip Mukherjee, Teddy Wang,
Bernie Thompson, Bagas Sanjaya, Mauro Carvalho Chehab,
Ard Biesheuvel, Arvind Sankar
Hi,
Here is simple toctree refactoring for framebuffer documentation,
based on docs-next tree. Simple because it only splits the toctree
in patch [3/3] into two sections.
Enjoy!
Bagas Sanjaya (3):
Documentation: fb: ep93xx: Demote section headings
Documentation: fb: Retitle driver docs
Documentation: fb: Split toctree
Documentation/fb/aty128fb.rst | 8 ++--
Documentation/fb/efifb.rst | 6 +--
Documentation/fb/ep93xx-fb.rst | 4 --
Documentation/fb/gxfb.rst | 8 ++--
Documentation/fb/index.rst | 80 +++++++++++++++++++---------------
Documentation/fb/lxfb.rst | 9 ++--
Documentation/fb/matroxfb.rst | 9 ++--
Documentation/fb/pvr2fb.rst | 6 +--
Documentation/fb/sa1100fb.rst | 9 ++--
Documentation/fb/sisfb.rst | 6 +--
Documentation/fb/sm712fb.rst | 6 +--
Documentation/fb/tgafb.rst | 6 +--
Documentation/fb/udlfb.rst | 6 +--
Documentation/fb/vesafb.rst | 6 +--
14 files changed, 81 insertions(+), 88 deletions(-)
base-commit: 348011753d99b146c190aae262ee361d03cb0c5e
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 8+ messages in thread* [PATCH 1/3] Documentation: fb: ep93xx: Demote section headings 2025-09-19 0:36 [PATCH 0/3] framebuffer docs toctree index refactoring Bagas Sanjaya @ 2025-09-19 0:36 ` Bagas Sanjaya 2025-09-21 4:09 ` Randy Dunlap 2025-09-19 0:36 ` [PATCH 2/3] Documentation: fb: Retitle driver docs Bagas Sanjaya 2025-09-19 0:36 ` [PATCH 3/3] Documentation: fb: Split toctree Bagas Sanjaya 2 siblings, 1 reply; 8+ messages in thread From: Bagas Sanjaya @ 2025-09-19 0:36 UTC (permalink / raw) To: Linux Kernel Mailing List, Linux Documentation, Linux Framebuffer, Linux DRI Development Cc: Helge Deller, Jonathan Corbet, Sudip Mukherjee, Teddy Wang, Bernie Thompson, Bagas Sanjaya, Mauro Carvalho Chehab, Ard Biesheuvel, Arvind Sankar Section headings are formatted the same as title heading, thus increasing number of entries in framebuffer toctree. Demote them. Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- Documentation/fb/ep93xx-fb.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/Documentation/fb/ep93xx-fb.rst b/Documentation/fb/ep93xx-fb.rst index 1dd67f4688c751..93b3494f530979 100644 --- a/Documentation/fb/ep93xx-fb.rst +++ b/Documentation/fb/ep93xx-fb.rst @@ -41,7 +41,6 @@ your board initialisation function:: ep93xx_register_fb(&some_board_fb_info); -===================== Video Attribute Flags ===================== @@ -79,7 +78,6 @@ EP93XXFB_USE_SDCSN2 Use SDCSn[2] for the framebuffer. EP93XXFB_USE_SDCSN3 Use SDCSn[3] for the framebuffer. =============================== ====================================== -================== Platform callbacks ================== @@ -101,7 +99,6 @@ obtained as follows:: /* Board specific framebuffer setup */ } -====================== Setting the video mode ====================== @@ -119,7 +116,6 @@ set when the module is installed:: modprobe ep93xx-fb video=320x240 -============== Screenpage bug ============== -- An old man doll... just what I always wanted! - Clara ^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH 1/3] Documentation: fb: ep93xx: Demote section headings 2025-09-19 0:36 ` [PATCH 1/3] Documentation: fb: ep93xx: Demote section headings Bagas Sanjaya @ 2025-09-21 4:09 ` Randy Dunlap 0 siblings, 0 replies; 8+ messages in thread From: Randy Dunlap @ 2025-09-21 4:09 UTC (permalink / raw) To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation, Linux Framebuffer, Linux DRI Development Cc: Helge Deller, Jonathan Corbet, Sudip Mukherjee, Teddy Wang, Bernie Thompson, Mauro Carvalho Chehab, Ard Biesheuvel, Arvind Sankar On 9/18/25 5:36 PM, Bagas Sanjaya wrote: > Section headings are formatted the same as title heading, thus > increasing number of entries in framebuffer toctree. Demote them. > > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Looks good. Thanks. Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> > --- > Documentation/fb/ep93xx-fb.rst | 4 ---- > 1 file changed, 4 deletions(-) > > diff --git a/Documentation/fb/ep93xx-fb.rst b/Documentation/fb/ep93xx-fb.rst > index 1dd67f4688c751..93b3494f530979 100644 > --- a/Documentation/fb/ep93xx-fb.rst > +++ b/Documentation/fb/ep93xx-fb.rst > @@ -41,7 +41,6 @@ your board initialisation function:: > > ep93xx_register_fb(&some_board_fb_info); > > -===================== > Video Attribute Flags > ===================== > > @@ -79,7 +78,6 @@ EP93XXFB_USE_SDCSN2 Use SDCSn[2] for the framebuffer. > EP93XXFB_USE_SDCSN3 Use SDCSn[3] for the framebuffer. > =============================== ====================================== > > -================== > Platform callbacks > ================== > > @@ -101,7 +99,6 @@ obtained as follows:: > /* Board specific framebuffer setup */ > } > > -====================== > Setting the video mode > ====================== > > @@ -119,7 +116,6 @@ set when the module is installed:: > > modprobe ep93xx-fb video=320x240 > > -============== > Screenpage bug > ============== > -- ~Randy ^ permalink raw reply [flat|nested] 8+ messages in thread
* [PATCH 2/3] Documentation: fb: Retitle driver docs 2025-09-19 0:36 [PATCH 0/3] framebuffer docs toctree index refactoring Bagas Sanjaya 2025-09-19 0:36 ` [PATCH 1/3] Documentation: fb: ep93xx: Demote section headings Bagas Sanjaya @ 2025-09-19 0:36 ` Bagas Sanjaya 2025-09-21 4:08 ` Randy Dunlap 2025-09-19 0:36 ` [PATCH 3/3] Documentation: fb: Split toctree Bagas Sanjaya 2 siblings, 1 reply; 8+ messages in thread From: Bagas Sanjaya @ 2025-09-19 0:36 UTC (permalink / raw) To: Linux Kernel Mailing List, Linux Documentation, Linux Framebuffer, Linux DRI Development Cc: Helge Deller, Jonathan Corbet, Sudip Mukherjee, Teddy Wang, Bernie Thompson, Bagas Sanjaya, Mauro Carvalho Chehab, Ard Biesheuvel, Arvind Sankar Many framebuffer driver docs are copied from vesafb docs as their template, including "What is <driver name>" title. Such title implies the introductory section, however, and not the whole docs. Retitle them. Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- Documentation/fb/aty128fb.rst | 8 +++----- Documentation/fb/efifb.rst | 6 +++--- Documentation/fb/gxfb.rst | 8 +++----- Documentation/fb/lxfb.rst | 9 +++------ Documentation/fb/matroxfb.rst | 9 +++------ Documentation/fb/pvr2fb.rst | 6 +++--- Documentation/fb/sa1100fb.rst | 9 +++------ Documentation/fb/sisfb.rst | 6 +++--- Documentation/fb/sm712fb.rst | 6 +++--- Documentation/fb/tgafb.rst | 6 +++--- Documentation/fb/udlfb.rst | 6 +++--- Documentation/fb/vesafb.rst | 6 +++--- 12 files changed, 36 insertions(+), 49 deletions(-) diff --git a/Documentation/fb/aty128fb.rst b/Documentation/fb/aty128fb.rst index 3f107718f933fc..0da8070a552165 100644 --- a/Documentation/fb/aty128fb.rst +++ b/Documentation/fb/aty128fb.rst @@ -1,8 +1,6 @@ -================= -What is aty128fb? -================= - -.. [This file is cloned from VesaFB/matroxfb] +========================================= +aty128fb - ATI Rage128 framebuffer driver +========================================= This is a driver for a graphic framebuffer for ATI Rage128 based devices on Intel and PPC boxes. diff --git a/Documentation/fb/efifb.rst b/Documentation/fb/efifb.rst index 6badff64756f49..3d4aab406dee0a 100644 --- a/Documentation/fb/efifb.rst +++ b/Documentation/fb/efifb.rst @@ -1,6 +1,6 @@ -============== -What is efifb? -============== +=================================== +efifb - Generic EFI platform driver +=================================== This is a generic EFI platform driver for systems with UEFI firmware. The system must be booted via the EFI stub for this to be usable. efifb supports diff --git a/Documentation/fb/gxfb.rst b/Documentation/fb/gxfb.rst index 5738709bccbbf3..3fda485606bdc1 100644 --- a/Documentation/fb/gxfb.rst +++ b/Documentation/fb/gxfb.rst @@ -1,8 +1,6 @@ -============= -What is gxfb? -============= - -.. [This file is cloned from VesaFB/aty128fb] +======================================= +gxfb - AMD Geode GX2 framebuffer driver +======================================= This is a graphics framebuffer driver for AMD Geode GX2 based processors. diff --git a/Documentation/fb/lxfb.rst b/Documentation/fb/lxfb.rst index 863e6b98fbae55..0a176ab376e30e 100644 --- a/Documentation/fb/lxfb.rst +++ b/Documentation/fb/lxfb.rst @@ -1,9 +1,6 @@ -============= -What is lxfb? -============= - -.. [This file is cloned from VesaFB/aty128fb] - +====================================== +lxfb - AMD Geode LX framebuffer driver +====================================== This is a graphics framebuffer driver for AMD Geode LX based processors. diff --git a/Documentation/fb/matroxfb.rst b/Documentation/fb/matroxfb.rst index 6158c49c857148..34cafaa00bab19 100644 --- a/Documentation/fb/matroxfb.rst +++ b/Documentation/fb/matroxfb.rst @@ -1,9 +1,6 @@ -================= -What is matroxfb? -================= - -.. [This file is cloned from VesaFB. Thanks go to Gerd Knorr] - +================================== +matroxfb driver for Matrox devices +================================== This is a driver for a graphic framebuffer for Matrox devices on Alpha, Intel and PPC boxes. diff --git a/Documentation/fb/pvr2fb.rst b/Documentation/fb/pvr2fb.rst index fcf2c21c8fcfeb..315ce085a5855b 100644 --- a/Documentation/fb/pvr2fb.rst +++ b/Documentation/fb/pvr2fb.rst @@ -1,6 +1,6 @@ -=============== -What is pvr2fb? -=============== +=============================================== +pvr2fb - PowerVR 2 graphics frame buffer driver +=============================================== This is a driver for PowerVR 2 based graphics frame buffers, such as the one found in the Dreamcast. diff --git a/Documentation/fb/sa1100fb.rst b/Documentation/fb/sa1100fb.rst index 67e2650e017d12..c5ca019b361a94 100644 --- a/Documentation/fb/sa1100fb.rst +++ b/Documentation/fb/sa1100fb.rst @@ -1,9 +1,6 @@ -================= -What is sa1100fb? -================= - -.. [This file is cloned from VesaFB/matroxfb] - +================================================= +sa1100fb - SA-1100 LCD graphic framebuffer driver +================================================= This is a driver for a graphic framebuffer for the SA-1100 LCD controller. diff --git a/Documentation/fb/sisfb.rst b/Documentation/fb/sisfb.rst index 8f4e502ea12ea7..9982f5ee05601b 100644 --- a/Documentation/fb/sisfb.rst +++ b/Documentation/fb/sisfb.rst @@ -1,6 +1,6 @@ -============== -What is sisfb? -============== +===================================== +sisfb - SiS framebuffer device driver +===================================== sisfb is a framebuffer device driver for SiS (Silicon Integrated Systems) graphics chips. Supported are: diff --git a/Documentation/fb/sm712fb.rst b/Documentation/fb/sm712fb.rst index 8e000f80b5bc6d..abbc6efae25f46 100644 --- a/Documentation/fb/sm712fb.rst +++ b/Documentation/fb/sm712fb.rst @@ -1,6 +1,6 @@ -================ -What is sm712fb? -================ +========================================================== +sm712fb - Silicon Motion SM712 graphics framebuffer driver +========================================================== This is a graphics framebuffer driver for Silicon Motion SM712 based processors. diff --git a/Documentation/fb/tgafb.rst b/Documentation/fb/tgafb.rst index 0c50d2134aa433..f0944da1ea5ef1 100644 --- a/Documentation/fb/tgafb.rst +++ b/Documentation/fb/tgafb.rst @@ -1,6 +1,6 @@ -============== -What is tgafb? -============== +======================================= +tgafb - TGA graphics framebuffer driver +======================================= This is a driver for DECChip 21030 based graphics framebuffers, a.k.a. TGA cards, which are usually found in older Digital Alpha systems. The diff --git a/Documentation/fb/udlfb.rst b/Documentation/fb/udlfb.rst index 99cfbb7a192238..9e75ac6b07c36a 100644 --- a/Documentation/fb/udlfb.rst +++ b/Documentation/fb/udlfb.rst @@ -1,6 +1,6 @@ -============== -What is udlfb? -============== +================================== +udlfb - DisplayLink USB 2.0 driver +================================== This is a driver for DisplayLink USB 2.0 era graphics chips. diff --git a/Documentation/fb/vesafb.rst b/Documentation/fb/vesafb.rst index f890a4f5623b45..5ffb35efd4538a 100644 --- a/Documentation/fb/vesafb.rst +++ b/Documentation/fb/vesafb.rst @@ -1,6 +1,6 @@ -=============== -What is vesafb? -=============== +=========================================== +Generic graphic framebuffer driver (vesafb) +=========================================== This is a generic driver for a graphic framebuffer on intel boxes. -- An old man doll... just what I always wanted! - Clara ^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH 2/3] Documentation: fb: Retitle driver docs 2025-09-19 0:36 ` [PATCH 2/3] Documentation: fb: Retitle driver docs Bagas Sanjaya @ 2025-09-21 4:08 ` Randy Dunlap 2025-09-22 10:21 ` Bagas Sanjaya 0 siblings, 1 reply; 8+ messages in thread From: Randy Dunlap @ 2025-09-21 4:08 UTC (permalink / raw) To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation, Linux Framebuffer, Linux DRI Development Cc: Helge Deller, Jonathan Corbet, Sudip Mukherjee, Teddy Wang, Bernie Thompson, Mauro Carvalho Chehab, Ard Biesheuvel, Arvind Sankar Hi, I would change a couple of the headings, but otherwise looks good. On 9/18/25 5:36 PM, Bagas Sanjaya wrote: > Many framebuffer driver docs are copied from vesafb docs as their > template, including "What is <driver name>" title. Such title > implies the introductory section, however, and not the whole docs. > > Retitle them. > > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> > --- > Documentation/fb/aty128fb.rst | 8 +++----- > Documentation/fb/efifb.rst | 6 +++--- > Documentation/fb/gxfb.rst | 8 +++----- > Documentation/fb/lxfb.rst | 9 +++------ > Documentation/fb/matroxfb.rst | 9 +++------ > Documentation/fb/pvr2fb.rst | 6 +++--- > Documentation/fb/sa1100fb.rst | 9 +++------ > Documentation/fb/sisfb.rst | 6 +++--- > Documentation/fb/sm712fb.rst | 6 +++--- > Documentation/fb/tgafb.rst | 6 +++--- > Documentation/fb/udlfb.rst | 6 +++--- > Documentation/fb/vesafb.rst | 6 +++--- > 12 files changed, 36 insertions(+), 49 deletions(-) > > diff --git a/Documentation/fb/aty128fb.rst b/Documentation/fb/aty128fb.rst > index 3f107718f933fc..0da8070a552165 100644 > --- a/Documentation/fb/aty128fb.rst > +++ b/Documentation/fb/aty128fb.rst > @@ -1,8 +1,6 @@ > -================= > -What is aty128fb? > -================= > - > -.. [This file is cloned from VesaFB/matroxfb] > +========================================= > +aty128fb - ATI Rage128 framebuffer driver > +========================================= > > This is a driver for a graphic framebuffer for ATI Rage128 based devices > on Intel and PPC boxes. > diff --git a/Documentation/fb/efifb.rst b/Documentation/fb/efifb.rst > index 6badff64756f49..3d4aab406dee0a 100644 > --- a/Documentation/fb/efifb.rst > +++ b/Documentation/fb/efifb.rst > @@ -1,6 +1,6 @@ > -============== > -What is efifb? > -============== > +=================================== > +efifb - Generic EFI platform driver > +=================================== > > This is a generic EFI platform driver for systems with UEFI firmware. The > system must be booted via the EFI stub for this to be usable. efifb supports > diff --git a/Documentation/fb/gxfb.rst b/Documentation/fb/gxfb.rst > index 5738709bccbbf3..3fda485606bdc1 100644 > --- a/Documentation/fb/gxfb.rst > +++ b/Documentation/fb/gxfb.rst > @@ -1,8 +1,6 @@ > -============= > -What is gxfb? > -============= > - > -.. [This file is cloned from VesaFB/aty128fb] > +======================================= > +gxfb - AMD Geode GX2 framebuffer driver > +======================================= > > This is a graphics framebuffer driver for AMD Geode GX2 based processors. > > diff --git a/Documentation/fb/lxfb.rst b/Documentation/fb/lxfb.rst > index 863e6b98fbae55..0a176ab376e30e 100644 > --- a/Documentation/fb/lxfb.rst > +++ b/Documentation/fb/lxfb.rst > @@ -1,9 +1,6 @@ > -============= > -What is lxfb? > -============= > - > -.. [This file is cloned from VesaFB/aty128fb] > - > +====================================== > +lxfb - AMD Geode LX framebuffer driver > +====================================== > > This is a graphics framebuffer driver for AMD Geode LX based processors. > > diff --git a/Documentation/fb/matroxfb.rst b/Documentation/fb/matroxfb.rst > index 6158c49c857148..34cafaa00bab19 100644 > --- a/Documentation/fb/matroxfb.rst > +++ b/Documentation/fb/matroxfb.rst > @@ -1,9 +1,6 @@ > -================= > -What is matroxfb? > -================= > - > -.. [This file is cloned from VesaFB. Thanks go to Gerd Knorr] > - > +================================== > +matroxfb driver for Matrox devices > +================================== Add a '-' after matroxfb > > This is a driver for a graphic framebuffer for Matrox devices on > Alpha, Intel and PPC boxes. > diff --git a/Documentation/fb/pvr2fb.rst b/Documentation/fb/pvr2fb.rst > index fcf2c21c8fcfeb..315ce085a5855b 100644 > --- a/Documentation/fb/pvr2fb.rst > +++ b/Documentation/fb/pvr2fb.rst > @@ -1,6 +1,6 @@ > -=============== > -What is pvr2fb? > -=============== > +=============================================== > +pvr2fb - PowerVR 2 graphics frame buffer driver > +=============================================== > > This is a driver for PowerVR 2 based graphics frame buffers, such as the > one found in the Dreamcast. > diff --git a/Documentation/fb/sa1100fb.rst b/Documentation/fb/sa1100fb.rst > index 67e2650e017d12..c5ca019b361a94 100644 > --- a/Documentation/fb/sa1100fb.rst > +++ b/Documentation/fb/sa1100fb.rst > @@ -1,9 +1,6 @@ > -================= > -What is sa1100fb? > -================= > - > -.. [This file is cloned from VesaFB/matroxfb] > - > +================================================= > +sa1100fb - SA-1100 LCD graphic framebuffer driver > +================================================= > > This is a driver for a graphic framebuffer for the SA-1100 LCD > controller. > diff --git a/Documentation/fb/sisfb.rst b/Documentation/fb/sisfb.rst > index 8f4e502ea12ea7..9982f5ee05601b 100644 > --- a/Documentation/fb/sisfb.rst > +++ b/Documentation/fb/sisfb.rst > @@ -1,6 +1,6 @@ > -============== > -What is sisfb? > -============== > +===================================== > +sisfb - SiS framebuffer device driver > +===================================== > > sisfb is a framebuffer device driver for SiS (Silicon Integrated Systems) > graphics chips. Supported are: > diff --git a/Documentation/fb/sm712fb.rst b/Documentation/fb/sm712fb.rst > index 8e000f80b5bc6d..abbc6efae25f46 100644 > --- a/Documentation/fb/sm712fb.rst > +++ b/Documentation/fb/sm712fb.rst > @@ -1,6 +1,6 @@ > -================ > -What is sm712fb? > -================ > +========================================================== > +sm712fb - Silicon Motion SM712 graphics framebuffer driver > +========================================================== > > This is a graphics framebuffer driver for Silicon Motion SM712 based processors. > > diff --git a/Documentation/fb/tgafb.rst b/Documentation/fb/tgafb.rst > index 0c50d2134aa433..f0944da1ea5ef1 100644 > --- a/Documentation/fb/tgafb.rst > +++ b/Documentation/fb/tgafb.rst > @@ -1,6 +1,6 @@ > -============== > -What is tgafb? > -============== > +======================================= > +tgafb - TGA graphics framebuffer driver > +======================================= > > This is a driver for DECChip 21030 based graphics framebuffers, a.k.a. TGA > cards, which are usually found in older Digital Alpha systems. The > diff --git a/Documentation/fb/udlfb.rst b/Documentation/fb/udlfb.rst > index 99cfbb7a192238..9e75ac6b07c36a 100644 > --- a/Documentation/fb/udlfb.rst > +++ b/Documentation/fb/udlfb.rst > @@ -1,6 +1,6 @@ > -============== > -What is udlfb? > -============== > +================================== > +udlfb - DisplayLink USB 2.0 driver > +================================== > > This is a driver for DisplayLink USB 2.0 era graphics chips. > > diff --git a/Documentation/fb/vesafb.rst b/Documentation/fb/vesafb.rst > index f890a4f5623b45..5ffb35efd4538a 100644 > --- a/Documentation/fb/vesafb.rst > +++ b/Documentation/fb/vesafb.rst > @@ -1,6 +1,6 @@ > -=============== > -What is vesafb? > -=============== > +=========================================== > +Generic graphic framebuffer driver (vesafb) > +=========================================== vesafb - Generic graphic framebuffer driver > > This is a generic driver for a graphic framebuffer on intel boxes. > Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Thanks. -- ~Randy ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH 2/3] Documentation: fb: Retitle driver docs 2025-09-21 4:08 ` Randy Dunlap @ 2025-09-22 10:21 ` Bagas Sanjaya 0 siblings, 0 replies; 8+ messages in thread From: Bagas Sanjaya @ 2025-09-22 10:21 UTC (permalink / raw) To: Randy Dunlap, Linux Kernel Mailing List, Linux Documentation, Linux Framebuffer, Linux DRI Development Cc: Helge Deller, Jonathan Corbet, Sudip Mukherjee, Teddy Wang, Bernie Thompson, Mauro Carvalho Chehab, Ard Biesheuvel, Arvind Sankar [-- Attachment #1: Type: text/plain, Size: 7070 bytes --] On Sat, Sep 20, 2025 at 09:08:57PM -0700, Randy Dunlap wrote: > > diff --git a/Documentation/fb/aty128fb.rst b/Documentation/fb/aty128fb.rst > > index 3f107718f933fc..0da8070a552165 100644 > > --- a/Documentation/fb/aty128fb.rst > > +++ b/Documentation/fb/aty128fb.rst > > @@ -1,8 +1,6 @@ > > -================= > > -What is aty128fb? > > -================= > > - > > -.. [This file is cloned from VesaFB/matroxfb] > > +========================================= > > +aty128fb - ATI Rage128 framebuffer driver > > +========================================= > > > > This is a driver for a graphic framebuffer for ATI Rage128 based devices > > on Intel and PPC boxes. > > diff --git a/Documentation/fb/efifb.rst b/Documentation/fb/efifb.rst > > index 6badff64756f49..3d4aab406dee0a 100644 > > --- a/Documentation/fb/efifb.rst > > +++ b/Documentation/fb/efifb.rst > > @@ -1,6 +1,6 @@ > > -============== > > -What is efifb? > > -============== > > +=================================== > > +efifb - Generic EFI platform driver > > +=================================== > > > > This is a generic EFI platform driver for systems with UEFI firmware. The > > system must be booted via the EFI stub for this to be usable. efifb supports > > diff --git a/Documentation/fb/gxfb.rst b/Documentation/fb/gxfb.rst > > index 5738709bccbbf3..3fda485606bdc1 100644 > > --- a/Documentation/fb/gxfb.rst > > +++ b/Documentation/fb/gxfb.rst > > @@ -1,8 +1,6 @@ > > -============= > > -What is gxfb? > > -============= > > - > > -.. [This file is cloned from VesaFB/aty128fb] > > +======================================= > > +gxfb - AMD Geode GX2 framebuffer driver > > +======================================= > > > > This is a graphics framebuffer driver for AMD Geode GX2 based processors. > > > > diff --git a/Documentation/fb/lxfb.rst b/Documentation/fb/lxfb.rst > > index 863e6b98fbae55..0a176ab376e30e 100644 > > --- a/Documentation/fb/lxfb.rst > > +++ b/Documentation/fb/lxfb.rst > > @@ -1,9 +1,6 @@ > > -============= > > -What is lxfb? > > -============= > > - > > -.. [This file is cloned from VesaFB/aty128fb] > > - > > +====================================== > > +lxfb - AMD Geode LX framebuffer driver > > +====================================== > > > > This is a graphics framebuffer driver for AMD Geode LX based processors. > > > > diff --git a/Documentation/fb/matroxfb.rst b/Documentation/fb/matroxfb.rst > > index 6158c49c857148..34cafaa00bab19 100644 > > --- a/Documentation/fb/matroxfb.rst > > +++ b/Documentation/fb/matroxfb.rst > > @@ -1,9 +1,6 @@ > > -================= > > -What is matroxfb? > > -================= > > - > > -.. [This file is cloned from VesaFB. Thanks go to Gerd Knorr] > > - > > +================================== > > +matroxfb driver for Matrox devices > > +================================== > > Add a '-' after matroxfb > > > > > This is a driver for a graphic framebuffer for Matrox devices on > > Alpha, Intel and PPC boxes. > > diff --git a/Documentation/fb/pvr2fb.rst b/Documentation/fb/pvr2fb.rst > > index fcf2c21c8fcfeb..315ce085a5855b 100644 > > --- a/Documentation/fb/pvr2fb.rst > > +++ b/Documentation/fb/pvr2fb.rst > > @@ -1,6 +1,6 @@ > > -=============== > > -What is pvr2fb? > > -=============== > > +=============================================== > > +pvr2fb - PowerVR 2 graphics frame buffer driver > > +=============================================== > > > > This is a driver for PowerVR 2 based graphics frame buffers, such as the > > one found in the Dreamcast. > > diff --git a/Documentation/fb/sa1100fb.rst b/Documentation/fb/sa1100fb.rst > > index 67e2650e017d12..c5ca019b361a94 100644 > > --- a/Documentation/fb/sa1100fb.rst > > +++ b/Documentation/fb/sa1100fb.rst > > @@ -1,9 +1,6 @@ > > -================= > > -What is sa1100fb? > > -================= > > - > > -.. [This file is cloned from VesaFB/matroxfb] > > - > > +================================================= > > +sa1100fb - SA-1100 LCD graphic framebuffer driver > > +================================================= > > > > This is a driver for a graphic framebuffer for the SA-1100 LCD > > controller. > > diff --git a/Documentation/fb/sisfb.rst b/Documentation/fb/sisfb.rst > > index 8f4e502ea12ea7..9982f5ee05601b 100644 > > --- a/Documentation/fb/sisfb.rst > > +++ b/Documentation/fb/sisfb.rst > > @@ -1,6 +1,6 @@ > > -============== > > -What is sisfb? > > -============== > > +===================================== > > +sisfb - SiS framebuffer device driver > > +===================================== > > > > sisfb is a framebuffer device driver for SiS (Silicon Integrated Systems) > > graphics chips. Supported are: > > diff --git a/Documentation/fb/sm712fb.rst b/Documentation/fb/sm712fb.rst > > index 8e000f80b5bc6d..abbc6efae25f46 100644 > > --- a/Documentation/fb/sm712fb.rst > > +++ b/Documentation/fb/sm712fb.rst > > @@ -1,6 +1,6 @@ > > -================ > > -What is sm712fb? > > -================ > > +========================================================== > > +sm712fb - Silicon Motion SM712 graphics framebuffer driver > > +========================================================== > > > > This is a graphics framebuffer driver for Silicon Motion SM712 based processors. > > > > diff --git a/Documentation/fb/tgafb.rst b/Documentation/fb/tgafb.rst > > index 0c50d2134aa433..f0944da1ea5ef1 100644 > > --- a/Documentation/fb/tgafb.rst > > +++ b/Documentation/fb/tgafb.rst > > @@ -1,6 +1,6 @@ > > -============== > > -What is tgafb? > > -============== > > +======================================= > > +tgafb - TGA graphics framebuffer driver > > +======================================= > > > > This is a driver for DECChip 21030 based graphics framebuffers, a.k.a. TGA > > cards, which are usually found in older Digital Alpha systems. The > > diff --git a/Documentation/fb/udlfb.rst b/Documentation/fb/udlfb.rst > > index 99cfbb7a192238..9e75ac6b07c36a 100644 > > --- a/Documentation/fb/udlfb.rst > > +++ b/Documentation/fb/udlfb.rst > > @@ -1,6 +1,6 @@ > > -============== > > -What is udlfb? > > -============== > > +================================== > > +udlfb - DisplayLink USB 2.0 driver > > +================================== > > > > This is a driver for DisplayLink USB 2.0 era graphics chips. > > > > diff --git a/Documentation/fb/vesafb.rst b/Documentation/fb/vesafb.rst > > index f890a4f5623b45..5ffb35efd4538a 100644 > > --- a/Documentation/fb/vesafb.rst > > +++ b/Documentation/fb/vesafb.rst > > @@ -1,6 +1,6 @@ > > -=============== > > -What is vesafb? > > -=============== > > +=========================================== > > +Generic graphic framebuffer driver (vesafb) > > +=========================================== > > vesafb - Generic graphic framebuffer driver > I'll apply your suggestions in v2. Thanks. -- An old man doll... just what I always wanted! - Clara [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 228 bytes --] ^ permalink raw reply [flat|nested] 8+ messages in thread
* [PATCH 3/3] Documentation: fb: Split toctree 2025-09-19 0:36 [PATCH 0/3] framebuffer docs toctree index refactoring Bagas Sanjaya 2025-09-19 0:36 ` [PATCH 1/3] Documentation: fb: ep93xx: Demote section headings Bagas Sanjaya 2025-09-19 0:36 ` [PATCH 2/3] Documentation: fb: Retitle driver docs Bagas Sanjaya @ 2025-09-19 0:36 ` Bagas Sanjaya 2025-09-21 4:08 ` Randy Dunlap 2 siblings, 1 reply; 8+ messages in thread From: Bagas Sanjaya @ 2025-09-19 0:36 UTC (permalink / raw) To: Linux Kernel Mailing List, Linux Documentation, Linux Framebuffer, Linux DRI Development Cc: Helge Deller, Jonathan Corbet, Sudip Mukherjee, Teddy Wang, Bernie Thompson, Bagas Sanjaya, Mauro Carvalho Chehab, Ard Biesheuvel, Arvind Sankar Framebuffer docs toctree consists of driver-independent docs (e.g. API docs) and driver-specific docs. The latter has much more entries. Group the docs into separate toctrees. Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- Documentation/fb/index.rst | 80 +++++++++++++++++++++----------------- 1 file changed, 45 insertions(+), 35 deletions(-) diff --git a/Documentation/fb/index.rst b/Documentation/fb/index.rst index 33e3c49f885695..e2f7488b6e2e42 100644 --- a/Documentation/fb/index.rst +++ b/Documentation/fb/index.rst @@ -4,42 +4,52 @@ Frame Buffer ============ -.. toctree:: - :maxdepth: 1 +General information +=================== - api - arkfb - aty128fb - cirrusfb - cmap_xfbdev - deferred_io - efifb - ep93xx-fb - fbcon - framebuffer - gxfb - intel810 - internals - lxfb - matroxfb - metronomefb - modedb - pvr2fb - pxafb - s3fb - sa1100fb - sh7760fb - sisfb - sm501 - sm712fb - sstfb - tgafb - tridentfb - udlfb - uvesafb - vesafb - viafb - vt8623fb +.. toctree:: + :maxdepth: 1 + + api + cmap_xfbdev + deferred_io + fbcon + framebuffer + internals + modedb + +Driver documentation +==================== + +.. toctree:: + :maxdepth: 1 + + arkfb + aty128fb + cirrusfb + efifb + ep93xx-fb + gxfb + intel810 + lxfb + matroxfb + metronomefb + pvr2fb + pxafb + s3fb + sa1100fb + sh7760fb + sisfb + sm501 + sm712fb + sstfb + tgafb + tridentfb + udlfb + uvesafb + vesafb + viafb + vt8623fb .. only:: subproject and html -- An old man doll... just what I always wanted! - Clara ^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH 3/3] Documentation: fb: Split toctree 2025-09-19 0:36 ` [PATCH 3/3] Documentation: fb: Split toctree Bagas Sanjaya @ 2025-09-21 4:08 ` Randy Dunlap 0 siblings, 0 replies; 8+ messages in thread From: Randy Dunlap @ 2025-09-21 4:08 UTC (permalink / raw) To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation, Linux Framebuffer, Linux DRI Development Cc: Helge Deller, Jonathan Corbet, Sudip Mukherjee, Teddy Wang, Bernie Thompson, Mauro Carvalho Chehab, Ard Biesheuvel, Arvind Sankar On 9/18/25 5:36 PM, Bagas Sanjaya wrote: > Framebuffer docs toctree consists of driver-independent docs > (e.g. API docs) and driver-specific docs. The latter has much > more entries. > > Group the docs into separate toctrees. > > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> LGTM. Thanks. Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> > --- > Documentation/fb/index.rst | 80 +++++++++++++++++++++----------------- > 1 file changed, 45 insertions(+), 35 deletions(-) > > diff --git a/Documentation/fb/index.rst b/Documentation/fb/index.rst > index 33e3c49f885695..e2f7488b6e2e42 100644 > --- a/Documentation/fb/index.rst > +++ b/Documentation/fb/index.rst > @@ -4,42 +4,52 @@ > Frame Buffer > ============ > > -.. toctree:: > - :maxdepth: 1 > +General information > +=================== > > - api > - arkfb > - aty128fb > - cirrusfb > - cmap_xfbdev > - deferred_io > - efifb > - ep93xx-fb > - fbcon > - framebuffer > - gxfb > - intel810 > - internals > - lxfb > - matroxfb > - metronomefb > - modedb > - pvr2fb > - pxafb > - s3fb > - sa1100fb > - sh7760fb > - sisfb > - sm501 > - sm712fb > - sstfb > - tgafb > - tridentfb > - udlfb > - uvesafb > - vesafb > - viafb > - vt8623fb > +.. toctree:: > + :maxdepth: 1 > + > + api > + cmap_xfbdev > + deferred_io > + fbcon > + framebuffer > + internals > + modedb > + > +Driver documentation > +==================== > + > +.. toctree:: > + :maxdepth: 1 > + > + arkfb > + aty128fb > + cirrusfb > + efifb > + ep93xx-fb > + gxfb > + intel810 > + lxfb > + matroxfb > + metronomefb > + pvr2fb > + pxafb > + s3fb > + sa1100fb > + sh7760fb > + sisfb > + sm501 > + sm712fb > + sstfb > + tgafb > + tridentfb > + udlfb > + uvesafb > + vesafb > + viafb > + vt8623fb > > .. only:: subproject and html > -- ~Randy ^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2025-09-22 10:21 UTC | newest] Thread overview: 8+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2025-09-19 0:36 [PATCH 0/3] framebuffer docs toctree index refactoring Bagas Sanjaya 2025-09-19 0:36 ` [PATCH 1/3] Documentation: fb: ep93xx: Demote section headings Bagas Sanjaya 2025-09-21 4:09 ` Randy Dunlap 2025-09-19 0:36 ` [PATCH 2/3] Documentation: fb: Retitle driver docs Bagas Sanjaya 2025-09-21 4:08 ` Randy Dunlap 2025-09-22 10:21 ` Bagas Sanjaya 2025-09-19 0:36 ` [PATCH 3/3] Documentation: fb: Split toctree Bagas Sanjaya 2025-09-21 4:08 ` Randy Dunlap
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).