[PATCH] drm/amdgpu: update documentation for amdgpu_drv.c

[Alex Deucher]

On Thu, Jun 28, 2018 at 2:02 PM, Jiang, Sonny <Sonny.Jiang at amd.com> wrote:
> Hi Alex,
>
>
> What's your opinion about Michel's suggestion?

You should definitely update amdgpu.rst to include the new
documentation section.  As for whether to have separate sections or
one big section for the parameters, I could go either way.  If we have
one big section, people will likely forget to update it when they add
a new parameter.  On the other hand, if we have separate sections for
each option, people will likely forget to update amdgpu.rst to add the
new parameter.

Alex

>
>
> Thanks,
>
> Sonny
>
> ________________________________
> From: Michel Dänzer <michel at daenzer.net>
> Sent: Thursday, June 28, 2018 4:39:57 AM
> To: Jiang, Sonny
> Cc: amd-gfx at lists.freedesktop.org
> Subject: Re: [PATCH] drm/amdgpu: update documentation for amdgpu_drv.c
>
>
> Hi Sonny,
>
>
> would it be possible to put the documentation of each parameter directly
> next to its definition / declaration? Otherwise, I'm afraid the
> documentation will quickly fall out of date WRT the code.
>
>
>> +/**
>> + * DOC: module_parameters
>
> Otherwise, this needs to be referenced in Documentation/gpu/amdgpu.rst,
> or the contents of this comment don't show up in the generated
> documentation.
>
>
> --
> Earthling Michel Dänzer               |               http://www.amd.com
> Libre software enthusiast             |             Mesa and X developer
>
> _______________________________________________
> amd-gfx mailing list
> amd-gfx at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx
>