diff mbox series

[net-next,v4,2/4] net-timestamp: correct the use of SOF_TIMESTAMPING_RAW_HARDWARE

Message ID 20240905071738.3725-3-kerneljasonxing@gmail.com (mailing list archive)
State Accepted
Commit e503f82e304b039332226008addac9d13ac68cb9
Headers show
Series net-timestamp: introduce a flag to filter out rx software and hardware report | expand

Commit Message

Jason Xing Sept. 5, 2024, 7:17 a.m. UTC 
From: Jason Xing <kernelxing@tencent.com>

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.

Suggested-by: Willem de Bruijn <willemdebruijn.kernel@gmail.com>
Signed-off-by: Jason Xing <kernelxing@tencent.com>
---
Link: https://lore.kernel.org/all/66d8c21d3042a_163d93294cb@willemb.c.googlers.com.notmuch/
---
 Documentation/networking/timestamping.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Willem de Bruijn Sept. 5, 2024, 1:38 p.m. UTC | #1 
Jason Xing wrote:
> From: Jason Xing <kernelxing@tencent.com>
> 
> 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.
> 
> Suggested-by: Willem de Bruijn <willemdebruijn.kernel@gmail.com>
> Signed-off-by: Jason Xing <kernelxing@tencent.com>

Reviewed-by: Willem de Bruijn <willemb@google.com>

As an exception to the rule, as a one word fix, can be squashed into
the feature patch, I think.

> ---
> Link: https://lore.kernel.org/all/66d8c21d3042a_163d93294cb@willemb.c.googlers.com.notmuch/

Please put these at the top of the Suggested-by/Signed-off-by/..-by
block. Their more useful to future readers than to current followers
of the mailing list.
Jason Xing Sept. 5, 2024, 2:02 p.m. UTC | #2 
On Thu, Sep 5, 2024 at 9:38 PM Willem de Bruijn
<willemdebruijn.kernel@gmail.com> wrote:
>
> Jason Xing wrote:
> > From: Jason Xing <kernelxing@tencent.com>
> >
> > 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.
> >
> > Suggested-by: Willem de Bruijn <willemdebruijn.kernel@gmail.com>
> > Signed-off-by: Jason Xing <kernelxing@tencent.com>
>
> Reviewed-by: Willem de Bruijn <willemb@google.com>
>
> As an exception to the rule, as a one word fix, can be squashed into
> the feature patch, I think.
>
> > ---
> > Link: https://lore.kernel.org/all/66d8c21d3042a_163d93294cb@willemb.c.googlers.com.notmuch/
>
> Please put these at the top of the Suggested-by/Signed-off-by/..-by
> block. Their more useful to future readers than to current followers
> of the mailing list.

But I have to ask if it looks a little messy if the first patch will
grow much bigger than before with adding some suggested-by tags and
links, and a separate paragraph to explain why we touch the doc...

Cooking one patch which saves my much energy is surely easier for me
but not for readers probably, I assume.

Thanks,
Jason
Willem de Bruijn Sept. 5, 2024, 2:45 p.m. UTC | #3 
Jason Xing wrote:
> On Thu, Sep 5, 2024 at 9:38 PM Willem de Bruijn
> <willemdebruijn.kernel@gmail.com> wrote:
> >
> > Jason Xing wrote:
> > > From: Jason Xing <kernelxing@tencent.com>
> > >
> > > 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.
> > >
> > > Suggested-by: Willem de Bruijn <willemdebruijn.kernel@gmail.com>
> > > Signed-off-by: Jason Xing <kernelxing@tencent.com>
> >
> > Reviewed-by: Willem de Bruijn <willemb@google.com>
> >
> > As an exception to the rule, as a one word fix, can be squashed into
> > the feature patch, I think.
> >
> > > ---
> > > Link: https://lore.kernel.org/all/66d8c21d3042a_163d93294cb@willemb.c.googlers.com.notmuch/
> >
> > Please put these at the top of the Suggested-by/Signed-off-by/..-by
> > block. Their more useful to future readers than to current followers
> > of the mailing list.
> 
> But I have to ask if it looks a little messy if the first patch will
> grow much bigger than before with adding some suggested-by tags and
> links, and a separate paragraph to explain why we touch the doc...
> 
> Cooking one patch which saves my much energy is surely easier for me
> but not for readers probably, I assume.

Ok. This small patch can even be stand-alone. No need for a series.
Jason Xing Sept. 5, 2024, 2:52 p.m. UTC | #4 
On Thu, Sep 5, 2024 at 10:45 PM Willem de Bruijn
<willemdebruijn.kernel@gmail.com> wrote:
>
> Jason Xing wrote:
> > On Thu, Sep 5, 2024 at 9:38 PM Willem de Bruijn
> > <willemdebruijn.kernel@gmail.com> wrote:
> > >
> > > Jason Xing wrote:
> > > > From: Jason Xing <kernelxing@tencent.com>
> > > >
> > > > 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.
> > > >
> > > > Suggested-by: Willem de Bruijn <willemdebruijn.kernel@gmail.com>
> > > > Signed-off-by: Jason Xing <kernelxing@tencent.com>
> > >
> > > Reviewed-by: Willem de Bruijn <willemb@google.com>
> > >
> > > As an exception to the rule, as a one word fix, can be squashed into
> > > the feature patch, I think.
> > >
> > > > ---
> > > > Link: https://lore.kernel.org/all/66d8c21d3042a_163d93294cb@willemb.c.googlers.com.notmuch/
> > >
> > > Please put these at the top of the Suggested-by/Signed-off-by/..-by
> > > block. Their more useful to future readers than to current followers
> > > of the mailing list.
> >
> > But I have to ask if it looks a little messy if the first patch will
> > grow much bigger than before with adding some suggested-by tags and
> > links, and a separate paragraph to explain why we touch the doc...
> >
> > Cooking one patch which saves my much energy is surely easier for me
> > but not for readers probably, I assume.
>
> Ok. This small patch can even be stand-alone. No need for a series.
>

Got it. I will send it as a standalone patch tomorrow since I need to
wait more than 24 hours.
diff mbox series

Patch

diff --git a/Documentation/networking/timestamping.rst b/Documentation/networking/timestamping.rst
index 37ead02be3b1..ac57d9de2f11 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