starlingx/docs
Code Issues Proposed changes

Add abbrevs (dsR6)

Browse Source 
Add back abbreviation updates missing from TAI clock updates.

Continuation of: https://review.opendev.org/c/starlingx/docs/+/842559

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Id56db72fddf9f8ec008b37bcda2a154f7c8ff44d
This commit is contained in:
Ron Stone 2022-06-07 08:26:58 -04:00
parent f3e67d7761
commit a3b069bb9a
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/shared/abbrevs.txt
View File

@ -50,8 +50,6 @@
.. |FPGA| replace:: :abbr:`FPGA (Field Programmable Gate Array)` .. |FPGA| replace:: :abbr:`FPGA (Field Programmable Gate Array)`
.. |FQDN| replace:: :abbr:`FQDN (Fully Qualified Domain Name)` .. |FQDN| replace:: :abbr:`FQDN (Fully Qualified Domain Name)`
.. |FQDNs| replace:: :abbr:`FQDNs (Fully Qualified Domain Names)` .. |FQDNs| replace:: :abbr:`FQDNs (Fully Qualified Domain Names)`
.. Following abbrev expands M (Master) to Leader as inclusive lang.
.. |GM| replace:: :abbr:`GM (Grand Leader)`
.. |GNP| replace:: :abbr:`GNP (Global Network Policy)` .. |GNP| replace:: :abbr:`GNP (Global Network Policy)`
.. |GNSS| replace:: :abbr:`GNSS (Global Navigation Satellite System)` .. |GNSS| replace:: :abbr:`GNSS (Global Navigation Satellite System)`
.. |GCC| replace:: :abbr:`GCC (GNU Compiler Collection)` .. |GCC| replace:: :abbr:`GCC (GNU Compiler Collection)`
@ -106,6 +104,7 @@
.. |PSP| replace:: :abbr:`PSP (Pod Security Policy)` .. |PSP| replace:: :abbr:`PSP (Pod Security Policy)`
.. |PSPs| replace:: :abbr:`PSPs (Pod Security Policies)` .. |PSPs| replace:: :abbr:`PSPs (Pod Security Policies)`
.. |PTP| replace:: :abbr:`PTP (Precision Time Protocol)` .. |PTP| replace:: :abbr:`PTP (Precision Time Protocol)`
.. |PTS| replace:: :abbr:`PTS (Primary Time Source)`
.. |PVC| replace:: :abbr:`PVC (Persistent Volume Claim)` .. |PVC| replace:: :abbr:`PVC (Persistent Volume Claim)`
.. |PVCs| replace:: :abbr:`PVCs (Persistent Volume Claims)` .. |PVCs| replace:: :abbr:`PVCs (Persistent Volume Claims)`
.. |PXE| replace:: :abbr:`PXE (Preboot Execution Environment)` .. |PXE| replace:: :abbr:`PXE (Preboot Execution Environment)`
@ -136,6 +135,7 @@
.. |SSL| replace:: :abbr:`SSL (Secure Socket Layer)` .. |SSL| replace:: :abbr:`SSL (Secure Socket Layer)`
.. |STP| replace:: :abbr:`STP (Spanning Tree Protocol)` .. |STP| replace:: :abbr:`STP (Spanning Tree Protocol)`
.. |SWACT| replace:: :abbr:`SWACT (SWitch ACTivity)` .. |SWACT| replace:: :abbr:`SWACT (SWitch ACTivity)`
.. |TAI| replace:: :abbr:`TAI (International Atomic Time)`
.. |T-BC| replace:: :abbr:`T-BC (Telecom Boundary Clock)` .. |T-BC| replace:: :abbr:`T-BC (Telecom Boundary Clock)`
.. |TCP| replace:: :abbr:`TCP (Transition Control Protocol)` .. |TCP| replace:: :abbr:`TCP (Transition Control Protocol)`
.. |TFTP| replace:: :abbr:`TFTP (Trivial File Transfer Protocol)` .. |TFTP| replace:: :abbr:`TFTP (Trivial File Transfer Protocol)`

6
doc/source/system_configuration/kubernetes/ptp-instance-examples-517dce312f56.rst
View File

@ -12,11 +12,11 @@ Example PTP Instance Configurations
The following sections provide example configuration steps for two |PTP| The following sections provide example configuration steps for two |PTP|
configurations supported by |prod|. configurations supported by |prod|.
* The first is a Border Clock setup where an external |PTP| |GM| is providing * The first is a Border Clock setup where an external |PTP| |PTS| is providing
a time source for the system. Only ptp4l and phc2sys are used for this a time source for the system. Only ptp4l and phc2sys are used for this
configuration. configuration.
* The second shows how to setup a |GM| node when a time source is available * The second shows how to setup a |PTS| node when a time source is available
via a locally connected GNSS signal. The ``ptp4l``, ``phc2sys``, via a locally connected GNSS signal. The ``ptp4l``, ``phc2sys``,
``ts2phc`` and clock instance types are used for this configuration. ``ts2phc`` and clock instance types are used for this configuration.
@ -296,7 +296,7 @@ ptp4l
~(keystone_admin)]$ system ptp-instance-parameter-add ptp-inst1 domainNumber=24 ~(keystone_admin)]$ system ptp-instance-parameter-add ptp-inst1 domainNumber=24
#. If configuring a |GM| node, set the special ``ptp4l`` parameter #. If configuring a |PTS| node, set the special ``ptp4l`` parameter
``currentUtcOffsetValid=1``. ``currentUtcOffsetValid=1``.
This allows the local clock and all downstream clocks to use the announced This allows the local clock and all downstream clocks to use the announced

2
doc/source/system_configuration/kubernetes/ptp-introduction-d981dd710bda.rst
View File

@ -72,7 +72,7 @@ Overview of the |prod| configuration units
allow certain parameters to be set which do not have a long name option allow certain parameters to be set which do not have a long name option
supported in the configuration file. supported in the configuration file.
* A special ``ptp4l`` instance level parameter is provided to allow a |GM| * A special ``ptp4l`` instance level parameter is provided to allow a |PTS|
node to set the ``currentUtcOffsetValid`` flag in its announce messages and node to set the ``currentUtcOffsetValid`` flag in its announce messages and
to correctly set the ``CLOCK_TAI`` on the system. Assign to correctly set the ``CLOCK_TAI`` on the system. Assign
``currentUtcOffsetValid=1`` at the the ``ptp4l`` instance level to set this ``currentUtcOffsetValid=1`` at the the ``ptp4l`` instance level to set this