[LinuxPPS] Advise on kernel documentation

[Bernhard Schiffner]

Am Dienstag, 6. Februar 2007 22:42 schrieb Rodolfo Giometti:
> Hello,
>
> please review this last version of LinuxPPS kernel documentation.
>
> If you have modifications ___please___ produce a patch with:
>
>    diff -ub pps.txt.orig pps.txt
>
> Thanks,
>
> Rodolfo

Hi,

some little typo's.

BTW: I didn't try the SYSFS. It's possible to do some write there to change 
pps behavior?
echo 1 > /sys/class/pps/00/echo ?


Thanks for your work!

Bernhard
----------------------------------------------------

bernd at pc2:/media/sdb1/home/bernd$ diff -ub pps.txt pps_4.txt
--- pps.txt     2007-02-07 10:08:10.000000000 +0100
+++ pps_4.txt   2007-02-07 10:18:44.000000000 +0100
@@ -113,7 +113,7 @@
                        PPS_CAPTUREASSERT|PPS_OFFSETASSERT,
                        -1 /* is up to the system */);

-The linuxpps_register_source() prototipe is:
+The linuxpps_register_source() prototype is:

   int linuxpps_register_source(struct linuxpps_source_info_s *info, int 
default_params, int try_id)

@@ -141,13 +141,13 @@
 PROCFS support
 --------------

-If the PROCFS support is enabled a new directory is created:
+If PROCFS support is enabled a new directory /proc/pps is created:

     $ ls /proc/pps/
     00       01       sources

 The file "sources" holds a brief description of all PPS sources
-defined into the system:
+defined in the system:

     $ cat /proc/pps/sources
     id    mode         echo    name                    path
@@ -155,7 +155,7 @@
     00    1133         no      serial0                 /dev/ttyS0
     01    1133         no      serial1                 /dev/ttyS1

-while other files are directories that hold one or two files according
+The other entries are directories that hold one or two files according
 to the ability of the associated source to provide "assert" and
 "clear" timestamps:

@@ -163,7 +163,7 @@
     assert               clear

 Inside each "assert" and "clear" file you can find the timestamp and a
-sequence number as reported below:
+sequence number:

     $ cat /proc/pps/00/assert
     1170026870.983207967 #8
@@ -173,25 +173,26 @@
 -------------

 The SYSFS support is enabled by default if the SYSFS filesystem is
-enabled into the kernel and it provides a new class:
+enabled in the kernel and it provides a new class:

    $ ls /sys/class/pps/
    00/  01/  02/

-Each directory is the ID of each PPS sources defined into the system
-and inside each one you can find several files:
+Every directory is the ID of a PPS source defined in the system
+and inside you find several files:

     $ ls /sys/class/pps/00/
     assert     clear  echo  mode  name  path  subsystem@  uevent

-Files "assert" and "clear" have the same functionality as the PROCFS
-alter ego (even if with different syntax due the one-value-per-file
-sysfs pragma) while other files are:
+Files "assert" and "clear" have the same functionality as their PROCFS
+counterparts but with different syntax due to the one-value-per-file
+ sysfs pragma.
+Other files are:

 * echo: reports if the PPS source has an echo function or not;

-* mode: reports available PPS functioning modes (in the same form of
-  PROCFS);
+* mode: reports available PPS functioning modes (in the same form as
+  PROCFS does);

 * name: reports the PPS source's name;