Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <954bbab1-65c9-e909-d41a-e730433a73c4@nvidia.com>
Date:   Tue, 29 Mar 2022 15:38:26 -0700
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.5.0
Subject: Re: [PATCH v5 01/11] Documentation: Add HTE subsystem guide
Content-Language: en-US
To:     Jonathan Corbet <corbet@lwn.net>,
        Bagas Sanjaya <bagasdotme@gmail.com>, thierry.reding@gmail.com,
        jonathanh@nvidia.com, smangipudi@nvidia.com,
        linux-kernel@vger.kernel.org, linux-tegra@vger.kernel.org,
        linux-gpio@vger.kernel.org, linus.walleij@linaro.org,
        bgolaszewski@baylibre.com, warthog618@gmail.com,
        devicetree@vger.kernel.org, linux-doc@vger.kernel.org,
        robh+dt@kernel.org
References: <20220329054521.14420-1-dipenp@nvidia.com>
 <20220329054521.14420-2-dipenp@nvidia.com>
 <db81d120-039d-f49f-9a48-c91e96777a61@gmail.com>
 <875ynw7p9x.fsf@meer.lwn.net>
From:   Dipen Patel <dipenp@nvidia.com>
In-Reply-To: <875ynw7p9x.fsf@meer.lwn.net>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?YlVzVkxSNE5HSFZBQ2k5anpDejBEcW9nMjJZQkpsdGlmcEp4ZGRFUmxBb3hk?=
 =?utf-8?B?L3dTWjJSOVAxUXBvRS95RzIzUXBpTmI4L0Fhc2YxQ1VZYnhkeTRENjBaTUJN?=
 =?utf-8?B?NlpSZUNUUzNoNCtJVDA5RkJWL2R3UnZMRjdlWDJoRWtEVFVtM1ZBb1Z2QXR2?=
 =?utf-8?B?ZW1KajdoWTdLcXdxeVhSVEVpV1B2eWZPVUc5RmdieC9teWh3bnU5ZDBSZUQz?=
 =?utf-8?B?V2k1VHcxZmk0NGxtMDUyL2J6ZXZJNDRmSnJhUzlLcCtDeUpzUXdkUjZjODhD?=
 =?utf-8?B?Qm1ndUlpenNHeXBKMk8wejZJU2ZlUlE5cTM5NU84YlYvcTJaMUR4K2lDMzRK?=
 =?utf-8?B?M1FsamxuNlF1OVRkYzNiYUkxV3JENWRRYmJBKzN6MWUxUFVheDNnSUovWEFQ?=
 =?utf-8?B?Y3k3Z01UZ21GOU1hTHl3N0c1akV5eENTbi9ES3ZvbEs3Y2tXazhDeVBSTXdy?=
 =?utf-8?B?QUVlUy9UZE45TXg4N2k1RCtyK3lPMU9IbnZGOGtwcE5oM21SWFUyOTBwb0tT?=
 =?utf-8?B?c2RkZ2VVSTdTOGVENk1YSjBGcGNveGs4OEhiWjllbk11aUcwOEJ6c241Z2xC?=
 =?utf-8?B?R2JXamRoVXBiRXlkSFFMUmRPNVRCaFRBUFlTaVBZYkxzTTJCdHFQRmh1em93?=
 =?utf-8?B?bUhGVDBIbDdSMjNvNEdzTXdBTzdvUDZiZHZpazFRR3FyQVIvOUJSMDhSTWRV?=
 =?utf-8?B?Ky9BcmpIQWpZWEgwenZFKy9TbkVMUlh3a241eEl0Rk9IVXkzeWI3QkNjMWsy?=
 =?utf-8?B?R0FPWHQvcEcycStuYzllNUF1VkY3TllIWENhWkFGa09ZSXdkcURQRVM5dGcy?=
 =?utf-8?B?U2l1QTNpV214aktXWlMwQUdJZ0VIRTFnRE5mWGZsa1BNamFReHpTeVZPbzlx?=
 =?utf-8?B?VkdQNHVJdDNxRU1WdUx4eXFCbUlXUFdMQXJJbXA2K2MwZTBwY3V0L1Zhbzc1?=
 =?utf-8?B?NU9YOWx1cnNpUXRqVjVBRTQySHZKZWdLaVluRW5WWkJ2VVhnV3ROQUYyd1Q5?=
 =?utf-8?B?N1ppZk5qeS85U0J4bVFrNitVRktMaHdqWmJQZWFxWUpsR2FZbndYQUl1UUNx?=
 =?utf-8?B?S2thODJNNVpCK2ZQY28xTFNmN3VQU2ZZRUd6dHJaV1FsejVyM1VBME83c2hs?=
 =?utf-8?B?ODB4TE4zcVpFekpESStBVmRIWjVERVMzZElvblRjRnhNT01jTWhYZHVNcnlJ?=
 =?utf-8?B?NzNpQUtpQzMzanNYRGcySGo5Wm1BMzl1UDdEb2J3M3MrWGluQ2dkSEVvTDZW?=
 =?utf-8?B?SHNSSi9VZkR0dG15RlkzUHRSVjZvaTRxMThtZTNQMXhaeEo2NUNKMVRFQkZ5?=
 =?utf-8?B?N3J5MGdXcmt4cGw3dDRJZXU2MXRhS0JYM2ZPWHhUUGErR1lBWTFUSGdPcjBi?=
 =?utf-8?B?eWJHYmpxYUloZEJNajVwalBwS3ZaWm4xNHJ2ZWZ3ZmlZTDdwUVNWNTFtZ3hy?=
 =?utf-8?B?ZXFZa0liUlVCNk5WdzZ4R2VwVUtudSs4WGNJTk5IYnB2SzFJd1hFYjJTdVJo?=
 =?utf-8?B?MmNsM3BaZGlLcThqVlVOdjJFREpsMnIxcFpFU2gyZDc0YzZkK1lkUnFQL3dS?=
 =?utf-8?B?THpMTWY2N21CZ0FYZFViZTBndFBXQUNBUmxDa1c2ZDRVRkUrakNHeXExNUtW?=
 =?utf-8?B?bEYxSWRSUjRuVmNPS0EwekZGdHFvc2pjM1lod1pmS2M4LzNXTk9pY3czNytX?=
 =?utf-8?B?am5PMjczdmxRMnQxU3labmhnUThhRjBFVUhpMDF6Nkc3YkplWHZMaG9hS1lZ?=
 =?utf-8?B?d2UzMlEvN2Q1SnBFVlBmdUpQRnhOMjVTRm9rbytnRzJaa3BFbm5zVEVsU3lR?=
 =?utf-8?B?WkNxckRXeGs0NUFtNFRlYm5ZNUh3UUdwRGNqUHRadTl6TGJGWmpKTTljaXdT?=
 =?utf-8?B?bGc0eUI1TFdsL2p2dGJxL042RURSbWx3enpta05jNDJCZDNwL2FnNzZzaU1w?=
 =?utf-8?B?SFJic3hab1NZdVI5dVEzSVNlaE9Td2NOSGJHZE9WTjBxVGxwZG15MlkzZ0lx?=
 =?utf-8?B?ZWJFRzhUakZnMUg5Z0lFQkdhS2FmRnpLZGV3cHdBMndaaHZOZlliam4vODhG?=
 =?utf-8?B?Rys1THI0UG4xZVU5bTRlM3NpaGZGcGk4M1k5QzlTQkpJb2dtTmpUZjFIWlg4?=
 =?utf-8?B?QlA5OWh1NTVjSFp5c2gxa0pGSjJ1cmlFaWJLNlVYdkZtMHI4SEFRbE1yUFN1?=
 =?utf-8?B?dmp6Uk1qaE9Ca1hJaVFtVUVHVy9WaW5hQ3E5U3B2MlFTaGt4TmpvTEZCYVpO?=
 =?utf-8?B?V3o2RGcyVG1ocEdRaGNRK3Bub2lTQkhRMGNiTUxpeHY4bGVUNC9pdlNsZFZL?=
 =?utf-8?B?WTU5dHZ1ZFJPQXk2WThmMjhVV3daYkJFbHd2SUpYQmpMOXV6ZFJ2QT09?=
X-OriginatorOrg: Nvidia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 83f05799-f8b1-4600-da31-08da11d4d567
X-MS-Exchange-CrossTenant-AuthSource: BY5PR12MB4116.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Mar 2022 22:38:23.9000
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 2JV3nBkVPg+hD2HbvKv/wf6hyC2nwcD83hRW+SbboaIA/TOL6PwDSVACAP8fbYIcD3FN92OLtKRZ9F+Prv+gwA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR1201MB0169
X-Spam-Status: No, score=-1.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FORGED_SPF_HELO,
        NICE_REPLY_A,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,
        SPF_NONE,T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no
        version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Hi,

On 3/29/22 8:27 AM, Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> 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