Fix a pile of kernel-doc warnings in the SGX code that have been hiding for years, and were discovered after recent fix for "make htmldocs"[*].
Note, processing arch/x86/include/asm/sgx.h will still generate several warnings, but nothing actually processes arch/x86/include/asm/sgx.h today, and documenting a bunch of reserved fields seems to be counter-productive. (I found and fixed a few asm/sgx.h issues because I included the header in an .rst file to figure out why htmldocs warned about SGX_PAGE_MEASURE not being documented, but not all the other enums that used the same syntax). WARNING: ./arch/x86/include/asm/sgx.h:193 struct member 'reserved1' not described in 'sgx_secs' WARNING: ./arch/x86/include/asm/sgx.h:193 struct member 'reserved2' not described in 'sgx_secs' WARNING: ./arch/x86/include/asm/sgx.h:193 struct member 'reserved3' not described in 'sgx_secs' WARNING: ./arch/x86/include/asm/sgx.h:193 struct member 'reserved4' not described in 'sgx_secs' WARNING: ./arch/x86/include/asm/sgx.h:243 struct member 'reserved' not described in 'sgx_tcs' WARNING: ./arch/x86/include/asm/sgx.h:319 struct member 'reserved' not described in 'sgx_secinfo' WARNING: ./arch/x86/include/asm/sgx.h:338 struct member 'secinfo' not described in 'sgx_pcmd' WARNING: ./arch/x86/include/asm/sgx.h:338 struct member 'reserved' not described in 'sgx_pcmd' WARNING: ./arch/x86/include/asm/sgx.h:360 struct member 'reserved1' not described in 'sgx_sigstruct_header' WARNING: ./arch/x86/include/asm/sgx.h:386 struct member 'reserved2' not described in 'sgx_sigstruct_body' WARNING: ./arch/x86/include/asm/sgx.h:386 struct member 'reserved3' not described in 'sgx_sigstruct_body' WARNING: ./arch/x86/include/asm/sgx.h:410 struct member 'reserved4' not described in 'sgx_sigstruct' https://lore.kernel.org/all/[email protected] Sean Christopherson (5): x86/sgx: Add a missing colon in kernel-doc markup for "struct sgx_enclave_run" x86/sgx: Add kernel-doc descriptions for params passed to vDSO user handler x86/sgx: Document structs and enums with '@', not '%' x86/sgx: Remove superfluous asterisk from copyright comment in asm/sgx.h x86/sgx: Fix a typo in the kernel-doc comment for enum sgx_attribute arch/x86/include/asm/sgx.h | 64 ++++++++++++++++----------------- arch/x86/include/uapi/asm/sgx.h | 10 ++++-- 2 files changed, 40 insertions(+), 34 deletions(-) base-commit: 19e2126bba55df9de15d9100b922df1dad6d39a4 -- 2.51.2.1041.gc1ab5b90ca-goog
