diff mbox series

[v3,5/6] Documentation/admin-guide: Document nomodeset kernel parameter

Message ID 20211108121544.776590-6-javierm@redhat.com (mailing list archive)
State Superseded, archived
Headers show
Series Cleanups for the nomodeset kernel command line parameter logic | expand

Commit Message

Javier Martinez Canillas Nov. 8, 2021, 12:15 p.m. UTC
The nomodeset kernel command line parameter is not documented. Its name
is quite vague and is not intuitive what's the behaviour when it is set.

Document in kernel-parameters.txt what actually happens when nomodeset
is used. That way, users could know if they want to enable this option.

Signed-off-by: Javier Martinez Canillas <javierm@redhat.com>
---

(no changes since v1)

 Documentation/admin-guide/kernel-parameters.txt | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Thomas Zimmermann Nov. 8, 2021, 12:48 p.m. UTC | #1
Hi

Am 08.11.21 um 13:15 schrieb Javier Martinez Canillas:
> The nomodeset kernel command line parameter is not documented. Its name
> is quite vague and is not intuitive what's the behaviour when it is set.
> 
> Document in kernel-parameters.txt what actually happens when nomodeset
> is used. That way, users could know if they want to enable this option.
> 
> Signed-off-by: Javier Martinez Canillas <javierm@redhat.com>
> ---
> 
> (no changes since v1)
> 
>   Documentation/admin-guide/kernel-parameters.txt | 4 ++++
>   1 file changed, 4 insertions(+)
> 
> diff --git Documentation/admin-guide/kernel-parameters.txt Documentation/admin-guide/kernel-parameters.txt
> index 91ba391f9b32..ed9859fd0734 100644
> --- Documentation/admin-guide/kernel-parameters.txt
> +++ Documentation/admin-guide/kernel-parameters.txt
> @@ -3521,6 +3521,10 @@
>   			shutdown the other cpus.  Instead use the REBOOT_VECTOR
>   			irq.
>   
> +	nomodeset	Disable kernel modesetting. DRM drivers will not be
> +			loaded when this kernel boot parameter is used. The
> +			simpledrm driver is the only DRM driver that loads.
> +

That's misleading and to the general admin it might not be clear what 
simpledrm is about. Rather say something like

  Disable kernel modesetting. DRM drivers will not perform
  display-mode changes or accelerated rendering. Only the
  system framebuffer will be available for use. Requires the
  firmware or boot loader to setup the display. Useful as
  fallback, or for testing and debugging.

Best regards
Thomas

>   	nomodule	Disable module load
>   
>   	nopat		[X86] Disable PAT (page attribute table extension of
>
Daniel Vetter Nov. 8, 2021, 3:32 p.m. UTC | #2
On Mon, Nov 08, 2021 at 01:48:24PM +0100, Thomas Zimmermann wrote:
> Hi
> 
> Am 08.11.21 um 13:15 schrieb Javier Martinez Canillas:
> > The nomodeset kernel command line parameter is not documented. Its name
> > is quite vague and is not intuitive what's the behaviour when it is set.
> > 
> > Document in kernel-parameters.txt what actually happens when nomodeset
> > is used. That way, users could know if they want to enable this option.
> > 
> > Signed-off-by: Javier Martinez Canillas <javierm@redhat.com>
> > ---
> > 
> > (no changes since v1)
> > 
> >   Documentation/admin-guide/kernel-parameters.txt | 4 ++++
> >   1 file changed, 4 insertions(+)
> > 
> > diff --git Documentation/admin-guide/kernel-parameters.txt Documentation/admin-guide/kernel-parameters.txt
> > index 91ba391f9b32..ed9859fd0734 100644
> > --- Documentation/admin-guide/kernel-parameters.txt
> > +++ Documentation/admin-guide/kernel-parameters.txt
> > @@ -3521,6 +3521,10 @@
> >   			shutdown the other cpus.  Instead use the REBOOT_VECTOR
> >   			irq.
> > +	nomodeset	Disable kernel modesetting. DRM drivers will not be
> > +			loaded when this kernel boot parameter is used. The
> > +			simpledrm driver is the only DRM driver that loads.
> > +
> 
> That's misleading and to the general admin it might not be clear what
> simpledrm is about. Rather say something like
> 
>  Disable kernel modesetting. DRM drivers will not perform
>  display-mode changes or accelerated rendering. Only the
>  system framebuffer will be available for use. Requires the
>  firmware or boot loader to setup the display. Useful as
>  fallback, or for testing and debugging.

Yeah I think that's much clearer. With that wording:

Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> 
> Best regards
> Thomas
> 
> >   	nomodule	Disable module load
> >   	nopat		[X86] Disable PAT (page attribute table extension of
> > 
> 
> -- 
> Thomas Zimmermann
> Graphics Driver Developer
> SUSE Software Solutions Germany GmbH
> Maxfeldstr. 5, 90409 Nürnberg, Germany
> (HRB 36809, AG Nürnberg)
> Geschäftsführer: Ivo Totev
diff mbox series

Patch

diff --git Documentation/admin-guide/kernel-parameters.txt Documentation/admin-guide/kernel-parameters.txt
index 91ba391f9b32..ed9859fd0734 100644
--- Documentation/admin-guide/kernel-parameters.txt
+++ Documentation/admin-guide/kernel-parameters.txt
@@ -3521,6 +3521,10 @@ 
 			shutdown the other cpus.  Instead use the REBOOT_VECTOR
 			irq.
 
+	nomodeset	Disable kernel modesetting. DRM drivers will not be
+			loaded when this kernel boot parameter is used. The
+			simpledrm driver is the only DRM driver that loads.
+
 	nomodule	Disable module load
 
 	nopat		[X86] Disable PAT (page attribute table extension of