[PATCH] drm/doc: Drop :c:func: markup

Thierry Reding thierry.reding at gmail.com
Tue Dec 10 12:15:03 UTC 2019


On Tue, Dec 10, 2019 at 11:33:16AM +0100, Daniel Vetter wrote:
> On Thu, Dec 05, 2019 at 05:05:37PM +0100, Thierry Reding wrote:
> > On Wed, Dec 04, 2019 at 11:19:33AM +0100, Daniel Vetter wrote:
> > > Kernel sphinx has learned how to do that in
> > > 
> > > commit d74b0d31dddeac2b44c715588d53d9a1e5b1158e
> > > Author: Jonathan Corbet <corbet at lwn.net>
> > > Date:   Thu Apr 25 07:55:07 2019 -0600
> > > 
> > >     Docs: An initial automarkup extension for sphinx
> > > 
> > > Unfortunately it hasn't learned that yet for structures, so we're
> > > stuck with the :c:type: noise for now still.
> > > 
> > > Cc:  Jonathan Corbet <corbet at lwn.net>
> 
> Jon, any plans to also add the other auto-markup eventually? We have quite
> an impressive pile of :c:type: noise in our docs ...

I had briefly taken a look at this and typed up a prototype that was
basically doing the same thing as for :c:func: but it didn't work for
some reason. After looking at the code and some Sphinx documentation
for an hour or so without an increase in understanding I gave up.

I'm sure someone with deeper knowledge of this would be able to make it
work.

Thierry

> > > Signed-off-by: Daniel Vetter <daniel.vetter at intel.com>
> > > ---
> > >  Documentation/gpu/drm-internals.rst |  4 +-
> > >  Documentation/gpu/drm-kms.rst       |  7 ++-
> > >  Documentation/gpu/drm-mm.rst        | 68 +++++++++++++----------------
> > >  3 files changed, 36 insertions(+), 43 deletions(-)
> > 
> > Reviewed-by: Thierry Reding <treding at nvidia.com>
> 
> Thanks for taking a look, patch merged to drm-misc-next.
> 
> Cheers, Daniel
> -- 
> Daniel Vetter
> Software Engineer, Intel Corporation
> http://blog.ffwll.ch
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <https://lists.freedesktop.org/archives/dri-devel/attachments/20191210/c7333191/attachment.sig>


More information about the dri-devel mailing list