[v1] Documentation: driver-api: pps: Update PPS generator documentation

Message ID 20231016101953.27308-1-lakshmi.sowjanya.d@intel.com
State New
Headers
Series [v1] Documentation: driver-api: pps: Update PPS generator documentation |

Commit Message

D, Lakshmi Sowjanya Oct. 16, 2023, 10:19 a.m. UTC
  From: Pandith N <pandith.n@intel.com>

PPS documentation has a generalized section for generators. Update the
section so any new generator documentation can be appended.

Signed-off-by: Pandith N <pandith.n@intel.com>
Signed-off-by: Lakshmi Sowjanya D <lakshmi.sowjanya.d@intel.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Acked-by: Rodolfo Giometti <giometti@enneenne.com>
---
 Documentation/driver-api/pps.rst | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)
  

Comments

Andy Shevchenko Oct. 17, 2023, 12:48 p.m. UTC | #1
On Mon, Oct 16, 2023 at 03:49:53PM +0530, lakshmi.sowjanya.d@intel.com wrote:
> From: Pandith N <pandith.n@intel.com>
> 
> PPS documentation has a generalized section for generators. Update the
> section so any new generator documentation can be appended.

It should be v2 with a changelog.
  
Jonathan Corbet Oct. 26, 2023, 5:38 p.m. UTC | #2
lakshmi.sowjanya.d@intel.com writes:

> From: Pandith N <pandith.n@intel.com>
>
> PPS documentation has a generalized section for generators. Update the
> section so any new generator documentation can be appended.
>
> Signed-off-by: Pandith N <pandith.n@intel.com>
> Signed-off-by: Lakshmi Sowjanya D <lakshmi.sowjanya.d@intel.com>
> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> Acked-by: Rodolfo Giometti <giometti@enneenne.com>
> ---
>  Documentation/driver-api/pps.rst | 16 +++++++++++-----
>  1 file changed, 11 insertions(+), 5 deletions(-)

Applied, thanks.

jon
  

Patch

diff --git a/Documentation/driver-api/pps.rst b/Documentation/driver-api/pps.rst
index 2d6b99766ee8..78dded03e5d8 100644
--- a/Documentation/driver-api/pps.rst
+++ b/Documentation/driver-api/pps.rst
@@ -200,11 +200,17 @@  Generators
 
 Sometimes one needs to be able not only to catch PPS signals but to produce
 them also. For example, running a distributed simulation, which requires
-computers' clock to be synchronized very tightly. One way to do this is to
-invent some complicated hardware solutions but it may be neither necessary
-nor affordable. The cheap way is to load a PPS generator on one of the
-computers (master) and PPS clients on others (slaves), and use very simple
-cables to deliver signals using parallel ports, for example.
+computers' clock to be synchronized very tightly.
+
+
+Parallel port generator
+------------------------
+
+One way to do this is to invent some complicated hardware solutions but it
+may be neither necessary nor affordable. The cheap way is to load a PPS
+generator on one of the computers (master) and PPS clients on others
+(slaves), and use very simple cables to deliver signals using parallel
+ports, for example.
 
 Parallel port cable pinout::