This section currently does nothing, but is present for future phc2sys
configuration extension. Update the ptp4l manual in order to indicate
that the configuration file could be shared.

Note that the user is not required (obviously) to use the same file for
both ptp4l and phc2sys, though the goal is to make it possible to share
the configuration file if desired.

Signed-off-by: Jacob Keller <jacob.e.kel...@intel.com>
---
 ptp4l.8 | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/ptp4l.8 b/ptp4l.8
index 0d01f29f4bda..fd5b1274bece 100644
--- a/ptp4l.8
+++ b/ptp4l.8
@@ -94,22 +94,29 @@ Display a help message.
 
 .SH CONFIGURATION FILE
 
-The configuration file is divided into sections. Each section starts with a
-line containing its name enclosed in brackets and it follows with settings.
-Each setting is placed on a separate line, it contains the name of the
-option and the value separated by whitespace characters. Empty lines and lines
-starting with # are ignored.
+The configuration file is divided into sections and may be shared with phc2sys.
+Each section starts with a line containing its name enclosed in brackets and it
+follows with settings. Each setting is placed on a separate line, it contains
+the name of the option and the value separated by whitespace characters. Empty
+lines and lines starting with # are ignored.
 
 The global section (indicated as
 .BR [global] )
-sets the program options, clock options and default port options. Other
+sets the program options, clock options and default port options. Note that 
some options are shared with
+.B phc2sys.
+Other
 sections are port specific sections and they override the default port options.
 The name of the section is the name of the configured port (e.g.
 .BR [eth0] ).
 Ports specified in the configuration file don't need to be
 specified by the
 .B \-i
-option. An empty port section can be used to replace the command line option.
+option. An empty port section can be used to replace the command line option. 
The
+.BR [phc2sys]
+section is used for options specific to the
+.B phc2sys
+program and is outlined in phc2sys(8)
+
 
 .SH PORT OPTIONS
 
-- 
2.1.2.555.gfbecd99


------------------------------------------------------------------------------
Dive into the World of Parallel Programming! The Go Parallel Website,
sponsored by Intel and developed in partnership with Slashdot Media, is your
hub for all things parallel software development, from weekly thought
leadership blogs to news, videos, case studies, tutorials and more. Take a
look and join the conversation now. http://goparallel.sourceforge.net
_______________________________________________
Linuxptp-devel mailing list
Linuxptp-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linuxptp-devel

Reply via email to