Hi, On 3/29/22 8:27 AM, Jonathan Corbet wrote: > Bagas Sanjaya <bagasdotme@xxxxxxxxx> writes: > >> On 29/03/22 12.45, Dipen Patel wrote: >>> +============================================ >>> +The Linux Hardware Timestamping Engine (HTE) >>> +============================================ >>> + >>> +:Author: Dipen Patel >>> + >> Please learn how to convey semantics with rst format, see further comments >> below. > That is the Sphinx "field list" syntax; it's pretty heavily used > throughout the kernel documentation and doesn't seem to merit that sort > of response...? > > [...] > >>> +The struct hte_ts_data is used to pass timestamp details between the consumers >>> +and the providers. It expresses timestamp data in nanoseconds in u64 data >>> +type. For now all the HTE APIs using struct hte_ts_data require tsc to be in >>> +nanoseconds. An example of the typical hte_ts_data data life cycle, for the >>> +GPIO line is as follows:: >>> + >> When we talk about name terms found in actual code (like keywords or variable >> names), it is customary to enclose them inside inline code (for example, >> ``struct what`` or ``u64 what``). > It's also customary to minimize markup. In the case of "struct > whatever" the markup is actively harmful since it interferes with the > automatic recognition and cross-referencing of the type. I agree, I will keep only necessary reference in this section. > > jon
