linux-kernel - Re: [PATCH 2/3] Documentation: fb: Retitle driver docs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <222d551c-fb01-4a8c-9b83-daef019b6795@infradead.org>
Date: Sat, 20 Sep 2025 21:08:57 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Bagas Sanjaya <bagasdotme@...il.com>,
 Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
 Linux Documentation <linux-doc@...r.kernel.org>,
 Linux Framebuffer <linux-fbdev@...r.kernel.org>,
 Linux DRI Development <dri-devel@...ts.freedesktop.org>
Cc: Helge Deller <deller@....de>, Jonathan Corbet <corbet@....net>,
 Sudip Mukherjee <sudipm.mukherjee@...il.com>,
 Teddy Wang <teddy.wang@...iconmotion.com>,
 Bernie Thompson <bernie@...gable.com>,
 Mauro Carvalho Chehab <mchehab+samsung@...nel.org>,
 Ard Biesheuvel <ardb@...nel.org>, Arvind Sankar <nivedita@...m.mit.edu>
Subject: Re: [PATCH 2/3] Documentation: fb: Retitle driver docs

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@...il.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@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.

-- 
~Randy