Re: [PATCH] xhci: Add missing parameter description to xhci_get_endpoint_index()

[Greg KH <gregkh@linuxfoundation.org>]

On Mon, May 05, 2025 at 11:43:05PM +0800, Hans Zhang wrote:
> 
> 
> On 2025/5/5 23:35, Hans Zhang wrote:
> > 
> > 
> > On 2025/5/5 13:00, Greg KH wrote:
> > > On Mon, May 05, 2025 at 12:04:15AM +0800, Hans Zhang wrote:
> > > > Fix kernel-doc warning by documenting the @desc parameter:
> > > > 
> > > > drivers/usb/host/xhci.c:1369: warning: Function parameter or
> > > > struct member
> > > > 'desc' not described in 'xhci_get_endpoint_index'
> > > > 
> > > > Add detailed description of the @desc parameter and clarify the indexing
> > > > logic for control endpoints vs other types. This brings the
> > > > documentation
> > > > in line with kernel-doc requirements while maintaining technical
> > > > accuracy.
> > > > 
> > > > Signed-off-by: Hans Zhang <18255117159@163.com>
> > > 
> > > What commit id does this fix?
> > > 
> > 
> > Hi Greg,
> > 
> > export ARCH=arm64
> > make defconfig
> > make Image W=1 -j16
> > 
> > ./aarch64-none-linux-gnu-gcc -v
> > Using built-in specs.
> > COLLECT_GCC=./aarch64-none-linux-gnu-gcc
> > COLLECT_LTO_WRAPPER=/media/zhb/hans/code/cix_linux_gcc/arm-gnu-toolchain-12.3.rel1-x86_64-aarch64-none-linux-gnu/bin/../libexec/gcc/aarch64-none-linux-gnu/12.3.1/lto-wrapper
> > Target: aarch64-none-linux-gnu
> > Configured with:
> > /data/jenkins/workspace/GNU-toolchain/arm-12/src/gcc/configure
> > --target=aarch64-none-linux-gnu --prefix=
> > --with-sysroot=/aarch64-none-linux-gnu/libc --with-build-sysroot=/data/jenkins/workspace/GNU-toolchain/arm-12/build-aarch64-none-linux-gnu/install//aarch64-none-linux-gnu/libc
> > --with-bugurl=https://bugs.linaro.org/ --enable-gnu-indirect-function
> > --enable-shared --disable-libssp --disable-libmudflap
> > --enable-checking=release --enable-languages=c,c++,fortran --with-gmp=/data/jenkins/workspace/GNU-toolchain/arm-12/build-aarch64-none-linux-gnu/host-tools --with-mpfr=/data/jenkins/workspace/GNU-toolchain/arm-12/build-aarch64-none-linux-gnu/host-tools --with-mpc=/data/jenkins/workspace/GNU-toolchain/arm-12/build-aarch64-none-linux-gnu/host-tools --with-isl=/data/jenkins/workspace/GNU-toolchain/arm-12/build-aarch64-none-linux-gnu/host-tools
> > --enable-fix-cortex-a53-843419 --with-pkgversion='Arm GNU Toolchain
> > 12.3.Rel1 (Build arm-12.35)'
> > Thread model: posix
> > Supported LTO compression algorithms: zlib
> > gcc version 12.3.1 20230626 (Arm GNU Toolchain 12.3.Rel1 (Build arm-12.35))
> > 
> > 
> > I'm debugging the problem of pci and modified the iinclude/linux/pci.h
> > file. If the above compilation method is adopted, the following warnings
> > will occur. Use my patch and the warning disappears.
> > 
> > Compilation warning:
> > drivers/usb/host/xhci.c:1370: warning: Function parameter or struct
> > member 'desc' not described in 'xhci_get_endpoint_index'
> > 
> > 
> > The reproduction method can also be modified by modifying the
> > drivers/usb/host/xhci.c file and then compiling, and the above warning
> > will appear.
> > 
> > Please review whether this needs to be fixed. If not, please ignore this
> > patch.
> > 
> > 
> 
> Hi Greg,
> 
> This patch does not fix specific code errors. Instead, it improves the
> parameter documentation of the xhci_get_endpoint_index function (adding a
> description for @desc) to enhance code readability. Therefore, it does not
> fix any issues with historical submissions and is an independent document
> improvement patch.

It fixes when that parameter was added to that function, OR it fixes
when the comment block was added to document that function, right?  So
either way, it does "Fix" something...

thanks,

greg k-h