Skip to contentSkip to conversation

ptp: Fix documentation to match code.

PATCH Applied Richard Cochran 2 participants 2 messages Mar 24, 2018 – Mar 26, 2018

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ptp: Fix documentation to match code.

Ever since commit 3a06c7ac24f9 ("posix-clocks: Remove interval timer facility and mmap/fasync callbacks") the possibility of PHC based posix timers has been removed. In addition it will probably never make sense to implement this functionality.

This patch removes the misleading text which seems to suggest that posix timers for PHC devices will ever be a thing.

---
 Documentation/ptp/ptp.txt | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)
Documentation/ptp/ptp.txt +1 -4
index ae8fef86b832..11e904ee073f 100644
@@ -18,7 +18,6 @@
     - Adjust clock frequency
 
   + Ancillary clock features
-    - One short or periodic alarms, with signal delivery to user program
     - Time stamp external events
     - Period output signals configurable from user space
     - Synchronization of the Linux system time via the PPS subsystem
@@ -48,9 +47,7 @@
    User space programs may control the clock using standardized
    ioctls. A program may query, enable, configure, and disable the
    ancillary clock features. User space can receive time stamped
-   events via blocking read() and poll(). One shot and periodic
-   signals may be configured via the POSIX timer_settime() system
-   call.
+   events via blocking read() and poll().
 
 ** Writing clock drivers
 
Signature · 1 line
2.11.0
maintainer Applied
#1 lore raw

From: Richard Cochran <[email protected]>
Date: Fri, 23 Mar 2018 21:24:02 -0700

Quoted 9 lines

Ever since commit 3a06c7ac24f9 ("posix-clocks: Remove interval timer facility and mmap/fasync callbacks") the possibility of PHC based posix timers has been removed. In addition it will probably never make sense to implement this functionality.

This patch removes the misleading text which seems to suggest that posix timers for PHC devices will ever be a thing.

Applied.