| Message ID | 20230228065618.2686550-6-xiang.ye@intel.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Add Intel LJCA device driver | expand |
Hi Ye,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on lee-mfd/for-mfd-next]
[also build test WARNING on lee-mfd/for-mfd-fixes wsa/i2c/for-next broonie-spi/for-next linus/master v6.2 next-20230228]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Ye-Xiang/mfd-Add-support-for-Intel-LJCA-device/20230228-150024
base: https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git for-mfd-next
patch link: https://lore.kernel.org/r/20230228065618.2686550-6-xiang.ye%40intel.com
patch subject: [PATCH v3 5/5] Documentation: Add ABI doc for attributes of LJCA device
reproduce:
# https://github.com/intel-lab-lkp/linux/commit/4073fac1618098db6eaffaa9b3b8cef9968bfd12
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Ye-Xiang/mfd-Add-support-for-Intel-LJCA-device/20230228-150024
git checkout 4073fac1618098db6eaffaa9b3b8cef9968bfd12
make menuconfig
# enable CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS
make htmldocs
If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <lkp@intel.com>
| Link: https://lore.kernel.org/oe-kbuild-all/202303011034.QrSQepq1-lkp@intel.com/
All warnings (new ones prefixed by >>):
>> Documentation/ABI/testing/sysfs-bus-usb-devices-ljca:12: WARNING: Unexpected indentation.
>> Documentation/ABI/testing/sysfs-bus-usb-devices-ljca:12: WARNING: Block quote ends without a blank line; unexpected unindent.
vim +12 Documentation/ABI/testing/sysfs-bus-usb-devices-ljca
> 12 Date: July 2023
diff --git a/Documentation/ABI/testing/sysfs-bus-usb-devices-ljca b/Documentation/ABI/testing/sysfs-bus-usb-devices-ljca new file mode 100644 index 000000000000..43b95effdefc --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-usb-devices-ljca @@ -0,0 +1,22 @@ +What: /sys/bus/usb/.../version +Date: July 2023 +KernelVersion: 6.4 +Contact: Ye Xiang <xiang.ye@intel.com> +Description: + Provides the current firmware version of LJCA device. + The format is Major.Minor.Patch.Build, where + Major, Minor, Patch, and Build are decimal numbers. + For example: 1.0.0.256 + +What: /sys/bus/usb/.../cmd +Date: July 2023 +KernelVersion: 6.4 +Contact: Ye Xiang <xiang.ye@intel.com> +Description: + Commands supported by LJCA device. + When read, it will return valid commands. + When write with a command, it will execute the command. + Valid commands are [dfu, debug] + dfu: Echo dfu to this file so as to put the device into + DFU mode so the firmware can be updated. + debug: Enable debug logging.
Add sysfs attributes Documentation entries for LJCA device Signed-off-by: Ye Xiang <xiang.ye@intel.com> --- .../ABI/testing/sysfs-bus-usb-devices-ljca | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-bus-usb-devices-ljca