[PATCH] Documentation: fb: udlfb: clean up text and formatting

[PATCH] Documentation: fb: udlfb: clean up text and formatting

[Randy Dunlap]

Clean up punctuation, spelling, and formatting for command line usage
and modprobe config file usage in udlfb.rst.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Bernie Thompson <bernie@plugable.com>
Cc: linux-fbdev@vger.kernel.org
Cc: dri-devel@lists.freedesktop.org
Cc: Helge Deller <deller@gmx.de>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
---
 Documentation/fb/udlfb.rst |   18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

--- a/Documentation/fb/udlfb.rst
+++ b/Documentation/fb/udlfb.rst
@@ -86,17 +86,21 @@ Module Options
 Special configuration for udlfb is usually unnecessary. There are a few
 options, however.
 
-From the command line, pass options to modprobe
-modprobe udlfb fb_defio=0 console=1 shadow=1
+From the command line, pass options to modprobe::
 
-Or modify options on the fly at /sys/module/udlfb/parameters directory via
-sudo nano fb_defio
-change the parameter in place, and save the file.
+  modprobe udlfb fb_defio=0 console=1 shadow=1
+
+Or modify options on the fly at /sys/module/udlfb/parameters directory via::
+
+  sudo nano fb_defio
+  change the parameter in place, and save the file.
 
 Unplug/replug USB device to apply with new settings
 
-Or for permanent option, create file like /etc/modprobe.d/udlfb.conf with text
-options udlfb fb_defio=0 console=1 shadow=1
+Or for permanent options, create a file like /etc/modprobe.d/udlfb.conf
+with text::
+
+  options udlfb fb_defio=0 console=1 shadow=1
 
 Accepted boolean options:
 

Re: [PATCH] Documentation: fb: udlfb: clean up text and formatting

[Bagas Sanjaya]

On 8/28/22 02:39, Randy Dunlap wrote:
> -From the command line, pass options to modprobe
> -modprobe udlfb fb_defio=0 console=1 shadow=1
> +From the command line, pass options to modprobe::
>  
> -Or modify options on the fly at /sys/module/udlfb/parameters directory via
> -sudo nano fb_defio
> -change the parameter in place, and save the file.
> +  modprobe udlfb fb_defio=0 console=1 shadow=1
> +
> +Or modify options on the fly at /sys/module/udlfb/parameters directory via::
> +
> +  sudo nano fb_defio
> +  change the parameter in place, and save the file.
>  

Better say "Or change the options on the fly by editing
/sys/module/udlfb/parameters/fb_defio."

>  Unplug/replug USB device to apply with new settings
>  
> -Or for permanent option, create file like /etc/modprobe.d/udlfb.conf with text
> -options udlfb fb_defio=0 console=1 shadow=1
> +Or for permanent options, create a file like /etc/modprobe.d/udlfb.conf
> +with text::
> +
> +  options udlfb fb_defio=0 console=1 shadow=1

Maybe we can say "Or to apply options permanently, create modprobe configuration
like /etc/modprobe.d/udlfb.conf with::"

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] Documentation: fb: udlfb: clean up text and formatting

[Randy Dunlap]

On 8/27/22 18:51, Bagas Sanjaya wrote:
> On 8/28/22 02:39, Randy Dunlap wrote:
>> -From the command line, pass options to modprobe
>> -modprobe udlfb fb_defio=0 console=1 shadow=1
>> +From the command line, pass options to modprobe::
>>  
>> -Or modify options on the fly at /sys/module/udlfb/parameters directory via
>> -sudo nano fb_defio
>> -change the parameter in place, and save the file.
>> +  modprobe udlfb fb_defio=0 console=1 shadow=1
>> +
>> +Or modify options on the fly at /sys/module/udlfb/parameters directory via::
>> +
>> +  sudo nano fb_defio
>> +  change the parameter in place, and save the file.
>>  
> 
> Better say "Or change the options on the fly by editing
> /sys/module/udlfb/parameters/fb_defio."
> 
>>  Unplug/replug USB device to apply with new settings
>>  
>> -Or for permanent option, create file like /etc/modprobe.d/udlfb.conf with text
>> -options udlfb fb_defio=0 console=1 shadow=1
>> +Or for permanent options, create a file like /etc/modprobe.d/udlfb.conf
>> +with text::
>> +
>> +  options udlfb fb_defio=0 console=1 shadow=1
> 
> Maybe we can say "Or to apply options permanently, create modprobe configuration
> like /etc/modprobe.d/udlfb.conf with::"

Thanks, I'll send a v2.

-- 
~Randy