| Message ID | 20200717161027.1408240-2-olteanv@gmail.com |
|---|---|
| State | Changes Requested |
| Delegated to: | David Miller |
| Headers | show |
| Series | Document more PTP timestamping known quirks | expand |
On 7/17/2020 9:10 AM, Vladimir Oltean wrote: > One more quirk of the timestamping infrastructure will be documented > shortly. Rename the section from "Other caveats for MAC drivers" to > simply "Known bugs". This uncovers some bad phrasing at the beginning of > the section, which is now corrected. > > Signed-off-by: Vladimir Oltean <olteanv@gmail.com> > --- > Documentation/networking/timestamping.rst | 16 ++++++++-------- > 1 file changed, 8 insertions(+), 8 deletions(-) > > diff --git a/Documentation/networking/timestamping.rst b/Documentation/networking/timestamping.rst > index 5fa4e2274dd9..9a1f4cb4ce9e 100644 > --- a/Documentation/networking/timestamping.rst > +++ b/Documentation/networking/timestamping.rst > @@ -711,14 +711,14 @@ discoverable and attachable to a ``struct phy_device`` through Device Tree, and > for the rest, they use the same mii_ts infrastructure as those. See > 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:: > +3.2.4 Known bugs > +^^^^^^^^^^^^^^^^ > + > +One caveat with 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 interjection between - - is really long and made it difficult to parse this statement. Maybe re-word it like One caveat with stacked PHCs is that they uncover bugs which were impossible to trigger otherwise, as it is more difficult to ensure correctness of all possible code flows. This is especially true of DSA since it does not require any modifications to the MAC drivers to setup. One example has to do with this line of code, already presented earlier:: > skb_shinfo(skb)->tx_flags |= SKBTX_IN_PROGRESS; > >
diff --git a/Documentation/networking/timestamping.rst b/Documentation/networking/timestamping.rst index 5fa4e2274dd9..9a1f4cb4ce9e 100644 --- a/Documentation/networking/timestamping.rst +++ b/Documentation/networking/timestamping.rst @@ -711,14 +711,14 @@ discoverable and attachable to a ``struct phy_device`` through Device Tree, and for the rest, they use the same mii_ts infrastructure as those. See 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:: +3.2.4 Known bugs +^^^^^^^^^^^^^^^^ + +One caveat with 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:: skb_shinfo(skb)->tx_flags |= SKBTX_IN_PROGRESS;
One more quirk of the timestamping infrastructure will be documented shortly. Rename the section from "Other caveats for MAC drivers" to simply "Known bugs". This uncovers some bad phrasing at the beginning of the section, which is now corrected. Signed-off-by: Vladimir Oltean <olteanv@gmail.com> --- Documentation/networking/timestamping.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)