[Intel-gfx] [PATCH] drm/i915/doc: Drop stale references to GuC specific loader

[Michal Wajdeczko]

On Thu, 16 Nov 2017 07:23:26 +0100, Sagar Arun Kamble  
<sagar.a.kamble at intel.com> wrote:

>
>
> On 11/15/2017 4:44 PM, Michal Wajdeczko wrote:
>> In previous commit ("drm/i915/guc: Rename intel_guc_loader.c to
>> intel_guc_fw.c") we unintentionally lost some of the structured
>> comments referenced by kernel doc. Drop these stale references
>> until we provide necessary updates to heavily re-factored code.
>>
>> Reported-by: Ville Syrjälä <ville.syrjala at linux.intel.com>
>> Signed-off-by: Michal Wajdeczko <michal.wajdeczko at intel.com>
>> Cc: Ville Syrjälä <ville.syrjala at linux.intel.com>
> I see old documentation is still preserved in intel_guc_fw.c so adding  
> referring it now will be good I guess.

Not quite. Old documentation is now spread across few files and it does
not follow structured format required by kerneldoc tools.

Documentation in intel_guc_fw.c is for its public functions only, and when
added to .rst alone it will not bring any value as user will still miss the
base documentation about the firmware.

Thanks for the review,
Michal

> Refactoring documentation can be added on top.
> Change looks good to me.
> Reviewed-by: Sagar Arun Kamble <sagar.a.kamble at intel.com>
>> ---
>>   Documentation/gpu/i915.rst | 9 ---------
>>   1 file changed, 9 deletions(-)
>>
>> diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
>> index 2e7ee03..fe725a2 100644
>> --- a/Documentation/gpu/i915.rst
>> +++ b/Documentation/gpu/i915.rst
>> @@ -338,15 +338,6 @@ objects, which has the goal to make space in gpu  
>> virtual address spaces.
>>   GuC
>>   ===
>>   -GuC-specific firmware loader
>> -----------------------------
>> -
>> -.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
>> -   :doc: GuC-specific firmware loader
>> -
>> -.. kernel-doc:: drivers/gpu/drm/i915/intel_guc_loader.c
>> -   :internal:
>> -
>>   GuC-based command submission
>>   ----------------------------
>>