[PATCH] Add/update function level documentation and add reference to amdgpu_vm.c in amdgpu.rst

[Michel Dänzer]

On 2018-06-11 05:33 PM, Michel Dänzer wrote:
> On 2018-06-11 05:14 PM, Andrey Grodzovsky wrote:
>> @@ -94,6 +96,15 @@ struct amdgpu_prt_cb {
>>  	struct dma_fence_cb cb;
>>  };
>>  
>> +/**
>> + * amdgpu_vm_bo_base_init - Adds bo to the list of bos associated with the vm
>> + * @base: base structure for tracking BO usage in a VM
>> + * @vm: vm to which bo is to be added
>> + * @bo: amdgpu buffer object
> 
> Most function comments seem to have an empty line between the function
> name and the first parameter. Either works, and I don't particularly cre
> which one we go for, but we should probably try to be consistent either way.

On further thought, I suggest always having an empty line, because the
function name / summary can span multiple lines.


-- 
Earthling Michel Dänzer               |               http://www.amd.com
Libre software enthusiast             |             Mesa and X developer