Permalink
Browse files

Merge pull request #2 from skreuzer/cleanup

skreuzer: Convert the README file to markdown and remove some trailing whitespace
  • Loading branch information...
2 parents 6b2a853 + 8191d37 commit 7c01a2762b06daa60b10eaa2b8760cadf08e3332 @wowczarek wowczarek committed Nov 23, 2015
Showing with 46 additions and 44 deletions.
  1. +3 −3 INSTALL
  2. +0 −41 README
  3. +43 −0 README.md
View
@@ -87,7 +87,7 @@ You will need the following tools and libraries to build ptpd2:
performance. When running high numbers of slaves, it is recommended
to use libpcap (ptpengine:use_libpcap=y) to allow easier matching
of Sync and FollowUp, unless the NIC supports software transmit
- timestamps. Without those and without libpcap, ptpd loops packets
+ timestamps. Without those and without libpcap, ptpd loops packets
back into its own socket, so the followUp destination cannot be
matched with the Sync destination, and a lookup table is used.
Hash collissions are low, but they may happen, in which case
@@ -96,10 +96,10 @@ You will need the following tools and libraries to build ptpd2:
* With certain NIC drivers on Linux providing the SO_TIMESTAMPING
functionality with software transmit timestamps (SOF_TIMESTAMPING_
- TX_SOFTWARE), unpredictable transmit timestamp failures can occur,
+ TX_SOFTWARE), unpredictable transmit timestamp failures can occur,
which may cause unstable operation and in some cases high CPU usage
(see https://sourceforge.net/p/ptpd/discussion/469208/thread/4aea6e47).
- While fixes have been implemented and have shown success,
+ While fixes have been implemented and have shown success,
there is still some risk. To disable SO_TIMESTAMPING support on Linux
completely, regardless of OS support, use:
View
@@ -1,41 +0,0 @@
-README for PTPd Version 2.x
-
-- Introduction -
-
-This is the source code for the PTP daemon (PTPd) implementing the
-Precision Time Protocol (PTP) version 2 as defined by 'IEEE Std 1588-2008'. PTP
-provides precise time coordination of Ethernet LAN connected computers. It
-was designed primarily for instrumentation and control systems.
-
-- Use -
-
-PTPd can coordinate the clocks of a group of LAN connected computers with each
-other. It has been shown to achieve microsecond level coordination, even on
-limited platforms.
-
-The 'ptpd' program can be built from the included source code. To use
-the program, run 'ptpd' on a group of LAN connected computers. Compile
-with 'PTPD_DBG' defined and run with the '-c' argument to watch what's
-going on.
-
-If you are just looking for software to update the time on your desktop, you
-probably want something that implements the Network Time Protocol. It can
-coordinate computer clocks with an absolute time reference such as UTC.
-
-Please refer to the INSTALL file for build instructions and configuration
-options. Please refer to the README.repocheckout file for information
-on how to build from source code repositories.
-
-- Legal notice -
-
-PTPd was written by using only information contained within 'IEEE Std
-1588-2008'. IEEE 1588 may contain patented technology, the use of which is not
-under the control of the authors of PTPd. Users of IEEE 1588 may need to obtain
-a license for the patented technology in the protocol. Contact the IEEE for
-licensing information.
-
-PTPd is licenced under a 2 Clause BSD Open Source License
-see COPYRIGHT for full information.
-
-PTPd comes with absolutely no warranty.
-
View
@@ -0,0 +1,43 @@
+PTPd
+===
+
+PTP daemon (PTPd) is an implementation the Precision Time Protocol (PTP) version
+2 as defined by 'IEEE Std 1588-2008'. PTP provides precise time coordination of
+Ethernet LAN connected computers. It was designed primarily for instrumentation
+and control systems.
+
+Use
+---
+
+PTPd can coordinate the clocks of a group of LAN connected computers with each
+other. It has been shown to achieve microsecond level coordination, even on
+limited platforms.
+
+The 'ptpd' program can be built from the included source code. To use the
+program, run 'ptpd' on a group of LAN connected computers. Compile with
+'PTPD_DBG' defined and run with the '-c' argument to watch what's going on.
+
+If you are just looking for software to update the time on your desktop, you
+probably want something that implements the Network Time Protocol. It can
+coordinate computer clocks with an absolute time reference such as UTC.
+
+Please refer to the
+[INSTALL](https://raw.githubusercontent.com/cfengine/core/master/INSTALL) file
+for build instructions and configuration options. Please refer to the
+[README.repocheckout](https://github.com/ptpd/ptpd/blob/master/README.repocheckout)
+file for information on how to build from source code repositories.
+
+Legal notice
+---
+
+PTPd was written by using only information contained within 'IEEE Std
+1588-2008'. IEEE 1588 may contain patented technology, the use of which is not
+under the control of the authors of PTPd. Users of IEEE 1588 may need to obtain
+a license for the patented technology in the protocol. Contact the IEEE for
+licensing information.
+
+PTPd is licenced under a 2 Clause BSD Open Source License see
+[COPYRIGHT](https://github.com/ptpd/ptpd/blob/master/COPYRIGHT) for full
+information.
+
+PTPd comes with absolutely no warranty.

0 comments on commit 7c01a27

Please sign in to comment.