Re: [udev] man page beauty

Re: [udev] man page beauty

[Kay Sievers]

[-- Attachment #1: Type: text/plain, Size: 324 bytes --]

Hi,
I've never seen any project where the documentation is in sync with the
code at this early stage. Nice! So here is the patch to make it extra perfect :)

thanks,
Kay

05-udev.8-tweaks.diff
  remove random indent to be consistent
  style is "shell style"
  s/wildcard/pattern/
  mention negation char in character class


[-- Attachment #2: 05-udev.8-tweaks.diff --]
[-- Type: text/plain, Size: 2454 bytes --]

diff -Nru a/udev.8 b/udev.8
--- a/udev.8	Thu Dec  4 04:24:15 2003
+++ b/udev.8	Thu Dec  4 04:24:15 2003
@@ -27,7 +27,9 @@
 .B udev
 queries the internal database for the name of the device file to be deleted.
 .SH "CONFIGURATION"
-All udev configuration files consist of a set of lines of text.  All empty
+All
+.B udev
+configuration files consist of a set of lines of text.  All empty
 lines, and lines beginning with a '#' will be ignored.
 .P
 
@@ -96,11 +98,9 @@
 is used.
 .P
 The line format is:
-.RS
 .sp
 .I method, key,[key,...] name
 .sp
-.RE
 where valid methods with corresponding keys are:
 .TP
 .B CALLOUT
@@ -130,22 +130,13 @@
 key: \fBKERNEL_NAME\fP
 .P
 The methods are applied in the following order:
-.B CALLOUT
-,
-.B LABEL
-,
-.B NUMBER
-,
-.B TOPOLOGY
-,
-.B REPLACE
+.BR CALLOUT ", " LABEL ", " NUMBER ",  " TOPOLOGY ", " REPLACE "."
 .P
 The 
 .B NAME 
 and 
 .B PROGRAM 
-fields support simple printf-like string subtitution:
-.RS
+fields support simple printf-like string substitution:
 .TP
 .B %n
 the "kernel number" of the device
@@ -168,7 +159,6 @@
 Use the devfs style disk name for this device.
 For partitions, this will result in 'part%n'
 If this is not a partition, it will result in 'disk'
-.RE
 .P
 A sample \fIudev.rules\fP might look like this:
 .sp
@@ -202,7 +192,7 @@
 .br
 Every line lists a device name followed by owner, group and permission
 mode. All values are separated by colons. The name field may contain a
-wildcard to apply the values to a whole class of devices.
+pattern to apply the values to a whole class of devices.
 .br
 If
 .B udev
@@ -221,9 +211,7 @@
 .fi
 .P
 A number of different fields in the above configuration files support a simple
-form of wildcard matching.  This form is based on the fnmatch(3) style, and
-supports the following fields:
-.RS
+form of shell style pattern matching. It supports the following pattern characters:
 .TP
 .B *
 Matches zero, one, or more characters.
@@ -235,8 +223,8 @@
 Matches any single character specified within the brackets. For example, the
 pattern string "tty[SR]" would match either "ttyS" or "ttyR".  Ranges are also
 supported within this match with the '-' character.  For example, to match on
-the range of all digits, the pattern [0-9] would be used.
-.RE
+the range of all digits, the pattern [0-9] would be used. If the first character
+following the '[' is a '!' then any character not enclosed is matched.
 .SH "FILES"
 .nf
 .ft B

Re: [udev] man page beauty

[Greg KH]

On Thu, Dec 04, 2003 at 04:41:45AM +0100, Kay Sievers wrote:
> Hi,
> I've never seen any project where the documentation is in sync with the
> code at this early stage. Nice! So here is the patch to make it extra
> perfect :)

Heh.

> 05-udev.8-tweaks.diff
>   remove random indent to be consistent
>   style is "shell style"
>   s/wildcard/pattern/
>   mention negation char in character class

Thanks, applied.

greg k-h


-------------------------------------------------------
This SF.net email is sponsored by: IBM Linux Tutorials.
Become an expert in LINUX or just sharpen your skills.  Sign up for IBM's
Free Linux Tutorials.  Learn everything from the bash shell to sys admin.
Click now! http://ads.osdn.com/?ad_id\x1278&alloc_id371&op=click
_______________________________________________
Linux-hotplug-devel mailing list  http://linux-hotplug.sourceforge.net
Linux-hotplug-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel