Received-SPF: pass (google.com: domain of linux-kernel+bounces-39236-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: Thomas Gleixner <tglx@linutronix.de>
To: Simon Horman <horms@kernel.org>, Peter Hilber
 <peter.hilber@opensynergy.com>
Cc: linux-kernel@vger.kernel.org, "D, Lakshmi Sowjanya"
 <lakshmi.sowjanya.d@intel.com>, jstultz@google.com, giometti@enneenne.com,
 corbet@lwn.net, andriy.shevchenko@linux.intel.com, "Dong, Eddie"
 <eddie.dong@intel.com>, "Hall, Christopher S"
 <christopher.s.hall@intel.com>, Sean Christopherson <seanjc@google.com>,
 Paolo Bonzini <pbonzini@redhat.com>, Ingo Molnar <mingo@redhat.com>,
 Borislav Petkov <bp@alien8.de>, Dave Hansen <dave.hansen@linux.intel.com>,
 x86@kernel.org, "H. Peter Anvin" <hpa@zytor.com>, Wanpeng Li
 <wanpengli@tencent.com>, Vitaly Kuznetsov <vkuznets@redhat.com>, Mark
 Rutland <mark.rutland@arm.com>, Marc Zyngier <maz@kernel.org>, Daniel
 Lezcano <daniel.lezcano@linaro.org>, Richard Cochran
 <richardcochran@gmail.com>, kvm@vger.kernel.org, netdev@vger.kernel.org
Subject: Re: [RFC PATCH v2 2/7] x86/tsc: Add clocksource ID, set
 system_counterval_t.cs_id
In-Reply-To: <20231224162709.GA230301@kernel.org>
References: <20231215220612.173603-1-peter.hilber@opensynergy.com>
 <20231215220612.173603-3-peter.hilber@opensynergy.com>
 <20231224162709.GA230301@kernel.org>
Date: Thu, 25 Jan 2024 21:13:10 +0100
Message-ID: <87le8dgoix.ffs@tglx>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain

On Sun, Dec 24 2023 at 16:27, Simon Horman wrote:
> On Fri, Dec 15, 2023 at 11:06:07PM +0100, Peter Hilber wrote:
>> @@ -1327,12 +1334,15 @@ EXPORT_SYMBOL(convert_art_to_tsc);
>>   * that this flag is set before conversion to TSC is attempted.
>>   *
>>   * Return:
>> - * struct system_counterval_t - system counter value with the pointer to the
>> + * struct system_counterval_t - system counter value with the ID of the
>>   *	corresponding clocksource
>>   *	@cycles:	System counter value
>>   *	@cs:		Clocksource corresponding to system counter value. Used
>>   *			by timekeeping code to verify comparability of two cycle
>>   *			values.
>> + *	@cs_id:		Clocksource ID corresponding to system counter value.
>> + *			Used by timekeeping code to verify comparability of two
>> + *			cycle values.
>
> None of the documented parameters to convert_art_ns_to_tsc() above
> correspond to the parameters of convert_art_ns_to_tsc() below.

Obviously not because they document the return value. The sole argument
of the function @art_ns is documented correctly.

> The same patch that corrects the kernel doc for convert_art_ns_to_tsc()
> could also correct the kernel doc for tsc_refine_calibration_work()
> by documenting it's work parameter.

That's a separate cleanup. Feel free to send a patch for that.

Thanks,

        tglx