• James Seo's avatar
    Documentation: conf.py: Add __force to c_id_attributes · 34d9f62e
    James Seo authored
    Fixes the following error in the docs build that occurs with recent
    versions of Sphinx when parsing kerneldocs for a function with the
    '__force' macro in its signature:
    
      ./include/linux/err.h:51: WARNING: Error in declarator or parameters
      Error in declarator or parameters
      Invalid C declaration: Expected identifier, got keyword: void [error at 35]
        void * ERR_CAST (__force const void *ptr)
        -----------------------------------^
    
    Currently, almost all of the few in-signature occurrences of '__force'
    are in the error pointer functions. Of those, ERR_CAST() is the only
    one with kerneldocs, but the kerneldocs aren't even being used to
    generate documentation. This change will allow all the error pointer
    functions to be properly documented.
    
    In addition to '__force', <linux/compiler_types.h> also defines
    '__nocast', '__safe', and '__private'. These are not currently used in
    any function signatures and do not need to be added to the docs config.
    Signed-off-by: default avatarJames Seo <james@equiv.tech>
    Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
    Link: https://lore.kernel.org/r/20230509175543.2065835-2-james@equiv.tech
    34d9f62e
conf.py 16.4 KB