• Mauro Carvalho Chehab's avatar
    docs: cdomain.py: add support for a new Sphinx 3.1+ tag · 71e552ae
    Mauro Carvalho Chehab authored
    Since Sphinx 3.0, the C domain code was rewritten, but only
    after version 3.1 it got support for setting namespaces on
    C domains, with is something that it is required, in order to
    document system calls, like ioctl() and others.
    
    As part of changing the documentation subsystem to properly
    build with Sphinx 3.1+, add support for such new tag:
    
    	.. c:namespace::"
    
    Such tag optionally replaces the optional "name" tag for functions,
    setting a single namespace domain for all C references found
    at the file.
    
    With that, it should be possible to convert existing
    documentation to be compatible with both Sphinx 1.x/2.x and
    3.1+.
    Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
    71e552ae
cdomain.py 6.82 KB