[PATCH net] docs: networking: timestamping: improve stacked PHC sentence

[PATCH net] docs: networking: timestamping: improve stacked PHC sentence

[Vladimir Oltean]

The first paragraph makes no grammatical sense. I suppose a portion of
the intended sentece is missing: "[The challenge with ] stacked PHCs
(...) is that they uncover bugs".

Rephrase, and at the same time simplify the structure of the sentence a
little bit, it is not easy to follow.

Fixes: 94d9f78f4d64 ("docs: networking: timestamping: add section for stacked PHC devices")
Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>
---
 Documentation/networking/timestamping.rst | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/Documentation/networking/timestamping.rst b/Documentation/networking/timestamping.rst
index b8fef8101176..7aabead90648 100644
--- a/Documentation/networking/timestamping.rst
+++ b/Documentation/networking/timestamping.rst
@@ -811,11 +811,9 @@ Documentation/devicetree/bindings/ptp/timestamper.txt for more details.
 3.2.4 Other caveats for MAC drivers
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Stacked PHCs, especially DSA (but not only) - since that doesn't require any
-modification to MAC drivers, so it is more difficult to ensure correctness of
-all possible code paths - is that they uncover bugs which were impossible to
-trigger before the existence of stacked PTP clocks.  One example has to do with
-this line of code, already presented earlier::
+The use of stacked PHCs may uncover MAC driver bugs which were impossible to
+trigger without them. One example has to do with this line of code, already
+presented earlier::
 
       skb_shinfo(skb)->tx_flags |= SKBTX_IN_PROGRESS;
 
-- 
2.43.0

Re: [PATCH net] docs: networking: timestamping: improve stacked PHC sentence

[Richard Cochran]

On Mon, May 12, 2025 at 04:17:51PM +0300, Vladimir Oltean wrote:
> The first paragraph makes no grammatical sense. I suppose a portion of
> the intended sentece is missing: "[The challenge with ] stacked PHCs
> (...) is that they uncover bugs".
> 
> Rephrase, and at the same time simplify the structure of the sentence a
> little bit, it is not easy to follow.
> 
> Fixes: 94d9f78f4d64 ("docs: networking: timestamping: add section for stacked PHC devices")
> Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>

Acked-by: Richard Cochran <richardcochran@gmail.com>

Re: [PATCH net] docs: networking: timestamping: improve stacked PHC sentence

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Mon, 12 May 2025 16:17:51 +0300 you wrote:
> The first paragraph makes no grammatical sense. I suppose a portion of
> the intended sentece is missing: "[The challenge with ] stacked PHCs
> (...) is that they uncover bugs".
> 
> Rephrase, and at the same time simplify the structure of the sentence a
> little bit, it is not easy to follow.
> 
> [...]

Here is the summary with links:
  - [net] docs: networking: timestamping: improve stacked PHC sentence
    https://git.kernel.org/netdev/net/c/d5c17e36549c

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html