Subject: [PATCH v2 net-next] net-timestamp: correct the use of SOF_TIMESTAMPING_RAW_HARDWARE

From: Jason Xing <[email-masked]>
Date: Sun, 8 Sep 2024 20:41:41 +0800

From: Jason Xing <[email-masked]>

SOF_TIMESTAMPING_RAW_HARDWARE is a report flag which passes the
timestamps generated by either SOF_TIMESTAMPING_TX_HARDWARE or
SOF_TIMESTAMPING_RX_HARDWARE to the userspace all the time.

So let us revise the doc here.

Link: https://lore.kernel.org/all/[email-masked]/
Suggested-by: Willem de Bruijn <[email-masked]>
Reviewed-by: Willem de Bruijn <[email-masked]>
Signed-off-by: Jason Xing <[email-masked]>
---
v2
1. remove the duplicate word

previous version
Link: https://lore.kernel.org/all/[email-masked]/
Link: https://lore.kernel.org/all/[email-masked]/
1. cook this as a stand-alone patch (Willem)
2. add Willem's reviewed-by tag since this patch doesn't change
3. move the reference link at the top of S-b tag
---
 Documentation/networking/timestamping.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/networking/timestamping.rst b/Documentation/networking/timestamping.rst
index 5e93cd71f99f..9c7773271393 100644
--- a/Documentation/networking/timestamping.rst
+++ b/Documentation/networking/timestamping.rst
@@ -158,7 +158,8 @@ SOF_TIMESTAMPING_SYS_HARDWARE:
 
 SOF_TIMESTAMPING_RAW_HARDWARE:
   Report hardware timestamps as generated by
-  SOF_TIMESTAMPING_TX_HARDWARE when available.
+  SOF_TIMESTAMPING_TX_HARDWARE or SOF_TIMESTAMPING_RX_HARDWARE
+  when available.

 1.3.3 Timestamp Options
-- 
2.37.3