Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

usb: gadget: ncm: Fix indentations in documentation of NCM section

Currently, the section of NCM which describes attributes are having wrong
indentation.

Fix this by following the correct format recommended.

Fixes: 1900daeefd3e ("usb: gadget: ncm: Add support to update wMaxSegmentSize via configfs")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/all/20240108160221.743649b5@canb.auug.org.au/
Signed-off-by: Udipto Goswami <quic_ugoswami@quicinc.com>
Link: https://lore.kernel.org/r/20240108132720.7786-1-quic_ugoswami@quicinc.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Udipto Goswami and committed by
Greg Kroah-Hartman
20d03ae3 6613476e

+11 -11
+11 -11
Documentation/usb/gadget-testing.rst
··· 448 448 The function name to use when creating the function directory is "ncm". 449 449 The NCM function provides these attributes in its function directory: 450 450 451 - =============== ================================================== 452 - ifname network device interface name associated with this 453 - function instance 454 - qmult queue length multiplier for high and super speed 455 - host_addr MAC address of host's end of this 456 - Ethernet over USB link 457 - dev_addr MAC address of device's end of this 458 - Ethernet over USB link 459 - max_segment_size Segment size required for P2P connections. This 460 - will set MTU to (max_segment_size - 14 bytes) 461 - =============== ================================================== 451 + ======================= ================================================== 452 + ifname network device interface name associated with this 453 + function instance 454 + qmult queue length multiplier for high and super speed 455 + host_addr MAC address of host's end of this 456 + Ethernet over USB link 457 + dev_addr MAC address of device's end of this 458 + Ethernet over USB link 459 + max_segment_size Segment size required for P2P connections. This 460 + will set MTU to 14 bytes 461 + ======================= ================================================== 462 462 463 463 and after creating the functions/ncm.<instance name> they contain default 464 464 values: qmult is 5, dev_addr and host_addr are randomly selected.