* Re: [PATCH 00/10] Fix documentation warnings at linux-next @ 2021-01-15 6:12 Lukas Bulwahn 2021-01-15 9:49 ` Mauro Carvalho Chehab 2021-01-15 16:37 ` Jonathan Corbet 0 siblings, 2 replies; 12+ messages in thread From: Lukas Bulwahn @ 2021-01-15 6:12 UTC (permalink / raw) To: mchehab+huawei; +Cc: corbet, linux-doc, linux-kernel [reduced the recipient list to the main responsible ones and list] Hi Mauro, hi Jonathan, We both, Mauro and I, have been submitting patches to address the documentation warnings on linux-next. If it is okay with you, Mauro, I would like to take responsibility for the task to send out the patches to address all warnings on linux-next in make htmldocs and follow up with all the discussions. I can also provide a short weekly summary (probably always on Friday) on what is pending where and what I could not resolve by myself. Is that okay for you? If at some point I do not have the time to take care anymore, I will let you know. Best regards, Lukas ^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 00/10] Fix documentation warnings at linux-next 2021-01-15 6:12 [PATCH 00/10] Fix documentation warnings at linux-next Lukas Bulwahn @ 2021-01-15 9:49 ` Mauro Carvalho Chehab 2021-01-15 12:05 ` Lukas Bulwahn 2021-01-15 13:47 ` Jonathan Cameron 2021-01-15 16:37 ` Jonathan Corbet 1 sibling, 2 replies; 12+ messages in thread From: Mauro Carvalho Chehab @ 2021-01-15 9:49 UTC (permalink / raw) To: Lukas Bulwahn; +Cc: corbet, linux-doc, linux-kernel, Jonathan Cameron Hi Lukas, Em Fri, 15 Jan 2021 07:12:38 +0100 Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu: > [reduced the recipient list to the main responsible ones and list] > > Hi Mauro, hi Jonathan, > > We both, Mauro and I, have been submitting patches to address the > documentation warnings on linux-next. If it is okay with you, Mauro, I > would like to take responsibility for the task to send out the patches > to address all warnings on linux-next in make htmldocs and follow up > with all the discussions. I can also provide a short weekly summary > (probably always on Friday) on what is pending where and what I could > not resolve by myself. > > Is that okay for you? > > If at some point I do not have the time to take care anymore, I will > let you know. Yeah, sure! Anyway, after applying the patches I sent this week, the warnings I'm getting are all due to the validation scripts I wrote. So, if everything gets merged (either yours or my version), we'll have zero Sphinx/kernel-doc warnings again. The script-validation warnings are: 1. Broken cross references -------------------------- $ scripts/documentation-file-ref-check Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst It sounds that part of the above is due to DT patches that weren't merged yet, but there are a few others that can be solved, but may require discussions with some Kernel developers/maintainers. 2. Duplicated ABI definitions ----------------------------- $ scripts/get_abi.pl validate Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394 Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395 Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396 Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397 Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398 Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399 Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0 Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8 Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599 Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588 Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38 Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0 Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1 Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8 Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 ./Documentation/ABI/testing/sysfs-bus-iio:45 Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4 Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0 Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27 Perhaps you could check with Jonathan Cameron some strategy to address the IIO warnings. Thanks, Mauro ^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 00/10] Fix documentation warnings at linux-next 2021-01-15 9:49 ` Mauro Carvalho Chehab @ 2021-01-15 12:05 ` Lukas Bulwahn 2021-01-15 12:36 ` Mauro Carvalho Chehab 2021-01-15 13:47 ` Jonathan Cameron 1 sibling, 1 reply; 12+ messages in thread From: Lukas Bulwahn @ 2021-01-15 12:05 UTC (permalink / raw) To: Mauro Carvalho Chehab Cc: Jonathan Corbet, open list:DOCUMENTATION, Linux Kernel Mailing List, Jonathan Cameron On Fri, Jan 15, 2021 at 10:49 AM Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote: > > Hi Lukas, > > Em Fri, 15 Jan 2021 07:12:38 +0100 > Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu: > > > [reduced the recipient list to the main responsible ones and list] > > > > Hi Mauro, hi Jonathan, > > > > We both, Mauro and I, have been submitting patches to address the > > documentation warnings on linux-next. If it is okay with you, Mauro, I > > would like to take responsibility for the task to send out the patches > > to address all warnings on linux-next in make htmldocs and follow up > > with all the discussions. I can also provide a short weekly summary > > (probably always on Friday) on what is pending where and what I could > > not resolve by myself. > > > > Is that okay for you? > > > > If at some point I do not have the time to take care anymore, I will > > let you know. > > Yeah, sure! > > Anyway, after applying the patches I sent this week, the warnings > I'm getting are all due to the validation scripts I wrote. So, if > everything gets merged (either yours or my version), we'll have zero > Sphinx/kernel-doc warnings again. > It is a never ending story... I already have seen two new warnings on today's linux-next and sent out patches. > $ scripts/documentation-file-ref-check > $ scripts/get_abi.pl validate I will also try out those two scripts, but I cannot commit to follow-up on all of those yet. I am also looking into addressing all kerneldoc warnings, even if not pulled in by make htmldocs. Lukas ^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 00/10] Fix documentation warnings at linux-next 2021-01-15 12:05 ` Lukas Bulwahn @ 2021-01-15 12:36 ` Mauro Carvalho Chehab 2021-01-15 12:41 ` Mauro Carvalho Chehab 0 siblings, 1 reply; 12+ messages in thread From: Mauro Carvalho Chehab @ 2021-01-15 12:36 UTC (permalink / raw) To: Lukas Bulwahn Cc: Jonathan Corbet, open list:DOCUMENTATION, Linux Kernel Mailing List, Jonathan Cameron Em Fri, 15 Jan 2021 13:05:56 +0100 Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu: > On Fri, Jan 15, 2021 at 10:49 AM Mauro Carvalho Chehab > <mchehab+huawei@kernel.org> wrote: > > > > Hi Lukas, > > > > Em Fri, 15 Jan 2021 07:12:38 +0100 > > Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu: > > > > > [reduced the recipient list to the main responsible ones and list] > > > > > > Hi Mauro, hi Jonathan, > > > > > > We both, Mauro and I, have been submitting patches to address the > > > documentation warnings on linux-next. If it is okay with you, Mauro, I > > > would like to take responsibility for the task to send out the patches > > > to address all warnings on linux-next in make htmldocs and follow up > > > with all the discussions. I can also provide a short weekly summary > > > (probably always on Friday) on what is pending where and what I could > > > not resolve by myself. > > > > > > Is that okay for you? > > > > > > If at some point I do not have the time to take care anymore, I will > > > let you know. > > > > Yeah, sure! > > > > Anyway, after applying the patches I sent this week, the warnings > > I'm getting are all due to the validation scripts I wrote. So, if > > everything gets merged (either yours or my version), we'll have zero > > Sphinx/kernel-doc warnings again. > > > > It is a never ending story... I already have seen two new warnings on > today's linux-next and sent out patches. Yes, I know. After 5.10, it is easier to track new stuff, as Sphinx/kernel-doc warnings were all shut up there. > > > $ scripts/documentation-file-ref-check > > $ scripts/get_abi.pl validate > > I will also try out those two scripts, but I cannot commit to > follow-up on all of those yet. Yeah, some of those are not trivial to address. FYI, those are called by default after make allmodconfig/allyesconfig. > I am also looking into addressing all > kerneldoc warnings, even if not pulled in by make htmldocs. Make sense. There are lots of kerneldoc warnings for files that aren't currently part of the docs building system. It makes sense to fix those and add them to the Sphinx build logic. Here, I have a local script that checks for those: for i in $(git grep -h "\.\.\s*kernel-doc::" Documentation/|cut -d':' -f 3|grep -vE "\bsource$"|sort|uniq); do ./scripts/kernel-doc --none $i done It reports 101 warnings against next-20210114. Thanks, Mauro ^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 00/10] Fix documentation warnings at linux-next 2021-01-15 12:36 ` Mauro Carvalho Chehab @ 2021-01-15 12:41 ` Mauro Carvalho Chehab 0 siblings, 0 replies; 12+ messages in thread From: Mauro Carvalho Chehab @ 2021-01-15 12:41 UTC (permalink / raw) To: Lukas Bulwahn Cc: Jonathan Corbet, open list:DOCUMENTATION, Linux Kernel Mailing List, Jonathan Cameron Em Fri, 15 Jan 2021 13:36:23 +0100 Mauro Carvalho Chehab <mchehab+huawei@kernel.org> escreveu: > Em Fri, 15 Jan 2021 13:05:56 +0100 > Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu: > > > On Fri, Jan 15, 2021 at 10:49 AM Mauro Carvalho Chehab > > <mchehab+huawei@kernel.org> wrote: > > > > > > Hi Lukas, > > > > > > Em Fri, 15 Jan 2021 07:12:38 +0100 > > > Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu: > > > > > > > [reduced the recipient list to the main responsible ones and list] > > > > > > > > Hi Mauro, hi Jonathan, > > > > > > > > We both, Mauro and I, have been submitting patches to address the > > > > documentation warnings on linux-next. If it is okay with you, Mauro, I > > > > would like to take responsibility for the task to send out the patches > > > > to address all warnings on linux-next in make htmldocs and follow up > > > > with all the discussions. I can also provide a short weekly summary > > > > (probably always on Friday) on what is pending where and what I could > > > > not resolve by myself. > > > > > > > > Is that okay for you? > > > > > > > > If at some point I do not have the time to take care anymore, I will > > > > let you know. > > > > > > Yeah, sure! > > > > > > Anyway, after applying the patches I sent this week, the warnings > > > I'm getting are all due to the validation scripts I wrote. So, if > > > everything gets merged (either yours or my version), we'll have zero > > > Sphinx/kernel-doc warnings again. > > > > > > > It is a never ending story... I already have seen two new warnings on > > today's linux-next and sent out patches. > > Yes, I know. After 5.10, it is easier to track new stuff, as > Sphinx/kernel-doc warnings were all shut up there. > > > > > > $ scripts/documentation-file-ref-check > > > $ scripts/get_abi.pl validate > > > > I will also try out those two scripts, but I cannot commit to > > follow-up on all of those yet. > > Yeah, some of those are not trivial to address. > > FYI, those are called by default after make allmodconfig/allyesconfig. > > > I am also looking into addressing all > > kerneldoc warnings, even if not pulled in by make htmldocs. > > Make sense. There are lots of kerneldoc warnings for files that > aren't currently part of the docs building system. It makes sense to > fix those and add them to the Sphinx build logic. > > Here, I have a local script that checks for those: > > for i in $(git grep -h "\.\.\s*kernel-doc::" Documentation/|cut -d':' -f 3|grep -vE "\bsource$"|sort|uniq); do > ./scripts/kernel-doc --none $i > done > > It reports 101 warnings against next-20210114. In time: those are for the ones that are included, but that doesn't have all symbols added. I have another one somewhere that does a more deeply check. I submitted it as a RFC sometime ago to the docs ML: https://git.linuxtv.org/mchehab/experimental.git/tree/scripts/docs_check_exports?h=doc_export_symbol&id=3f7d1e1b0bcdbe1d95eaa4b256259dfaa08faece Such script checks only exported symbols. Thanks, Mauro ^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 00/10] Fix documentation warnings at linux-next 2021-01-15 9:49 ` Mauro Carvalho Chehab 2021-01-15 12:05 ` Lukas Bulwahn @ 2021-01-15 13:47 ` Jonathan Cameron 2021-01-17 15:42 ` Jonathan Cameron 1 sibling, 1 reply; 12+ messages in thread From: Jonathan Cameron @ 2021-01-15 13:47 UTC (permalink / raw) To: Mauro Carvalho Chehab Cc: Lukas Bulwahn, corbet, linux-doc, linux-kernel, jic23 On Fri, 15 Jan 2021 10:49:47 +0100 Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote: > Hi Lukas, > > Em Fri, 15 Jan 2021 07:12:38 +0100 > Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu: > > > [reduced the recipient list to the main responsible ones and list] > > > > Hi Mauro, hi Jonathan, > > > > We both, Mauro and I, have been submitting patches to address the > > documentation warnings on linux-next. If it is okay with you, Mauro, I > > would like to take responsibility for the task to send out the patches > > to address all warnings on linux-next in make htmldocs and follow up > > with all the discussions. I can also provide a short weekly summary > > (probably always on Friday) on what is pending where and what I could > > not resolve by myself. > > > > Is that okay for you? > > > > If at some point I do not have the time to take care anymore, I will > > let you know. > > Yeah, sure! > > Anyway, after applying the patches I sent this week, the warnings > I'm getting are all due to the validation scripts I wrote. So, if > everything gets merged (either yours or my version), we'll have zero > Sphinx/kernel-doc warnings again. > > The script-validation warnings are: > > 1. Broken cross references > -------------------------- > > $ scripts/documentation-file-ref-check > Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst > Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml > Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst > Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml > Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > > It sounds that part of the above is due to DT patches that weren't > merged yet, but there are a few others that can be solved, but may > require discussions with some Kernel developers/maintainers. > > 2. Duplicated ABI definitions > ----------------------------- > > $ scripts/get_abi.pl validate > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394 > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395 > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396 > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397 > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398 > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399 > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0 > Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8 > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599 > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588 > Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38 > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0 > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1 > Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8 > Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 ./Documentation/ABI/testing/sysfs-bus-iio:45 > Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4 > Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0 > Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27 > > Perhaps you could check with Jonathan Cameron some strategy to address > the IIO warnings. I'm being a bit rubbish on those ones. All need a bit of thought... I'll try to kill off a few of them this weekend as *touch wood* my review queue is looking fairly short. Jonathan > > Thanks, > Mauro ^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 00/10] Fix documentation warnings at linux-next 2021-01-15 13:47 ` Jonathan Cameron @ 2021-01-17 15:42 ` Jonathan Cameron 2021-01-19 9:17 ` William Breathitt Gray 0 siblings, 1 reply; 12+ messages in thread From: Jonathan Cameron @ 2021-01-17 15:42 UTC (permalink / raw) To: Jonathan Cameron Cc: Mauro Carvalho Chehab, Lukas Bulwahn, corbet, linux-doc, linux-kernel, linux-iio, Fabrice Gasnier, Benjamin Gaignard, William Breathitt Gray On Fri, 15 Jan 2021 13:47:20 +0000 Jonathan Cameron <Jonathan.Cameron@Huawei.com> wrote: > On Fri, 15 Jan 2021 10:49:47 +0100 > Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote: > > > Hi Lukas, > > > > Em Fri, 15 Jan 2021 07:12:38 +0100 > > Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu: > > > > > [reduced the recipient list to the main responsible ones and list] > > > > > > Hi Mauro, hi Jonathan, > > > > > > We both, Mauro and I, have been submitting patches to address the > > > documentation warnings on linux-next. If it is okay with you, Mauro, I > > > would like to take responsibility for the task to send out the patches > > > to address all warnings on linux-next in make htmldocs and follow up > > > with all the discussions. I can also provide a short weekly summary > > > (probably always on Friday) on what is pending where and what I could > > > not resolve by myself. > > > > > > Is that okay for you? > > > > > > If at some point I do not have the time to take care anymore, I will > > > let you know. > > > > Yeah, sure! > > > > Anyway, after applying the patches I sent this week, the warnings > > I'm getting are all due to the validation scripts I wrote. So, if > > everything gets merged (either yours or my version), we'll have zero > > Sphinx/kernel-doc warnings again. > > > > The script-validation warnings are: > > > > 1. Broken cross references > > -------------------------- > > > > $ scripts/documentation-file-ref-check > > Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst > > Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > > Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > > Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > > Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml > > Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst > > Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml > > Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > > Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > > > > It sounds that part of the above is due to DT patches that weren't > > merged yet, but there are a few others that can be solved, but may > > require discussions with some Kernel developers/maintainers. > > > > 2. Duplicated ABI definitions > > ----------------------------- > > > > $ scripts/get_abi.pl validate > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394 > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395 > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396 > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397 > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398 > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399 > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0 > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8 > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599 > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588 > > Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38 > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0 > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1 > > Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8 > > Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 ./Documentation/ABI/testing/sysfs-bus-iio:45 > > Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4 > > Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0 > > Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27 > > > > Perhaps you could check with Jonathan Cameron some strategy to address > > the IIO warnings. > > I'm being a bit rubbish on those ones. All need a bit of thought... > > I'll try to kill off a few of them this weekend as *touch wood* my > review queue is looking fairly short. As I mentioned in the cover letter for the series I've just sent out, I ran into a bit of an understanding gap around the two counter cases. This isn't helped by the fact it is at least partly deprecated ABI given the counter subsystem has much richer ABI for these types of devices. @Fabrice, Benjamin and William. What do we do about that one? Thanks, Jonathan > > Jonathan > > > > > Thanks, > > Mauro > ^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 00/10] Fix documentation warnings at linux-next 2021-01-17 15:42 ` Jonathan Cameron @ 2021-01-19 9:17 ` William Breathitt Gray 2021-01-19 10:41 ` Jonathan Cameron 0 siblings, 1 reply; 12+ messages in thread From: William Breathitt Gray @ 2021-01-19 9:17 UTC (permalink / raw) To: Jonathan Cameron Cc: Jonathan Cameron, Mauro Carvalho Chehab, Lukas Bulwahn, corbet, linux-doc, linux-kernel, linux-iio, Fabrice Gasnier, Benjamin Gaignard [-- Attachment #1: Type: text/plain, Size: 9528 bytes --] On Sun, Jan 17, 2021 at 03:42:18PM +0000, Jonathan Cameron wrote: > On Fri, 15 Jan 2021 13:47:20 +0000 > Jonathan Cameron <Jonathan.Cameron@Huawei.com> wrote: > > > On Fri, 15 Jan 2021 10:49:47 +0100 > > Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote: > > > > > Hi Lukas, > > > > > > Em Fri, 15 Jan 2021 07:12:38 +0100 > > > Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu: > > > > > > > [reduced the recipient list to the main responsible ones and list] > > > > > > > > Hi Mauro, hi Jonathan, > > > > > > > > We both, Mauro and I, have been submitting patches to address the > > > > documentation warnings on linux-next. If it is okay with you, Mauro, I > > > > would like to take responsibility for the task to send out the patches > > > > to address all warnings on linux-next in make htmldocs and follow up > > > > with all the discussions. I can also provide a short weekly summary > > > > (probably always on Friday) on what is pending where and what I could > > > > not resolve by myself. > > > > > > > > Is that okay for you? > > > > > > > > If at some point I do not have the time to take care anymore, I will > > > > let you know. > > > > > > Yeah, sure! > > > > > > Anyway, after applying the patches I sent this week, the warnings > > > I'm getting are all due to the validation scripts I wrote. So, if > > > everything gets merged (either yours or my version), we'll have zero > > > Sphinx/kernel-doc warnings again. > > > > > > The script-validation warnings are: > > > > > > 1. Broken cross references > > > -------------------------- > > > > > > $ scripts/documentation-file-ref-check > > > Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst > > > Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > > > Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > > > Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > > > Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml > > > Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst > > > Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml > > > Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > > > Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > > > > > > It sounds that part of the above is due to DT patches that weren't > > > merged yet, but there are a few others that can be solved, but may > > > require discussions with some Kernel developers/maintainers. > > > > > > 2. Duplicated ABI definitions > > > ----------------------------- > > > > > > $ scripts/get_abi.pl validate > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394 > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395 > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396 > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397 > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398 > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399 > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0 > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8 > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599 > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588 > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38 > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0 > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1 > > > Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8 > > > Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 ./Documentation/ABI/testing/sysfs-bus-iio:45 > > > Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4 > > > Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0 > > > Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27 > > > > > > Perhaps you could check with Jonathan Cameron some strategy to address > > > the IIO warnings. > > > > I'm being a bit rubbish on those ones. All need a bit of thought... > > > > I'll try to kill off a few of them this weekend as *touch wood* my > > review queue is looking fairly short. > > As I mentioned in the cover letter for the series I've just sent out, I ran into > a bit of an understanding gap around the two counter cases. This isn't helped > by the fact it is at least partly deprecated ABI given the counter subsystem > has much richer ABI for these types of devices. > > @Fabrice, Benjamin and William. > What do we do about that one? > > Thanks, > > Jonathan I'd consider the IIO counter ABI as entirely deprecated -- the Counter subsystem supports all the functionality that's provided by the IIO counter ABI, as well as additional functionality that is missing. Regarding the iio:deviceX/in_count_quadrature_mode_available attribute: superseded by the Counter subsystem counterX/countY/function attribute. The IIO counter ABI allows users to select between a quadrature counting mode or a non-quadrature counting mode; unfortunately, it does not specify what kind of quadrature or what kind of non-quadrature counting is actually being performed by the device. Because the 104-quad-8 and stm32-lptimer-cnt drivers were the only ones to use this attribute, they are luckily in sync -- both define the same possible modes available: "quadrature" and "non-quadrature". You could simply consolidate this attribute to the main sys-bus-iio file in order to resolve this warning. Given that it has already been superceded by the Counter subsystem, I'd also be all right with just removing the IIO Counter ABI entirely from the codebase, or alternatively setting a future date for removal. William Breathitt Gray > > > > Jonathan > > > > > > > > Thanks, > > > Mauro > > > [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 833 bytes --] ^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 00/10] Fix documentation warnings at linux-next 2021-01-19 9:17 ` William Breathitt Gray @ 2021-01-19 10:41 ` Jonathan Cameron 2021-01-19 14:07 ` Fabrice Gasnier 0 siblings, 1 reply; 12+ messages in thread From: Jonathan Cameron @ 2021-01-19 10:41 UTC (permalink / raw) To: William Breathitt Gray Cc: Jonathan Cameron, Mauro Carvalho Chehab, Lukas Bulwahn, corbet, linux-doc, linux-kernel, linux-iio, Fabrice Gasnier, Benjamin Gaignard On Tue, 19 Jan 2021 18:17:05 +0900 William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > On Sun, Jan 17, 2021 at 03:42:18PM +0000, Jonathan Cameron wrote: > > On Fri, 15 Jan 2021 13:47:20 +0000 > > Jonathan Cameron <Jonathan.Cameron@Huawei.com> wrote: > > > > > On Fri, 15 Jan 2021 10:49:47 +0100 > > > Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote: > > > > > > > Hi Lukas, > > > > > > > > Em Fri, 15 Jan 2021 07:12:38 +0100 > > > > Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu: > > > > > > > > > [reduced the recipient list to the main responsible ones and list] > > > > > > > > > > Hi Mauro, hi Jonathan, > > > > > > > > > > We both, Mauro and I, have been submitting patches to address the > > > > > documentation warnings on linux-next. If it is okay with you, Mauro, I > > > > > would like to take responsibility for the task to send out the patches > > > > > to address all warnings on linux-next in make htmldocs and follow up > > > > > with all the discussions. I can also provide a short weekly summary > > > > > (probably always on Friday) on what is pending where and what I could > > > > > not resolve by myself. > > > > > > > > > > Is that okay for you? > > > > > > > > > > If at some point I do not have the time to take care anymore, I will > > > > > let you know. > > > > > > > > Yeah, sure! > > > > > > > > Anyway, after applying the patches I sent this week, the warnings > > > > I'm getting are all due to the validation scripts I wrote. So, if > > > > everything gets merged (either yours or my version), we'll have zero > > > > Sphinx/kernel-doc warnings again. > > > > > > > > The script-validation warnings are: > > > > > > > > 1. Broken cross references > > > > -------------------------- > > > > > > > > $ scripts/documentation-file-ref-check > > > > Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst > > > > Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > > > > Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > > > > Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt > > > > Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml > > > > Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst > > > > Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml > > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml > > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml > > > > Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml > > > > Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > > > > Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst > > > > > > > > It sounds that part of the above is due to DT patches that weren't > > > > merged yet, but there are a few others that can be solved, but may > > > > require discussions with some Kernel developers/maintainers. > > > > > > > > 2. Duplicated ABI definitions > > > > ----------------------------- > > > > > > > > $ scripts/get_abi.pl validate > > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1 > > > > Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8 > > > > Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 ./Documentation/ABI/testing/sysfs-bus-iio:45 > > > > Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4 > > > > Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0 > > > > Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27 > > > > > > > > Perhaps you could check with Jonathan Cameron some strategy to address > > > > the IIO warnings. > > > > > > I'm being a bit rubbish on those ones. All need a bit of thought... > > > > > > I'll try to kill off a few of them this weekend as *touch wood* my > > > review queue is looking fairly short. > > > > As I mentioned in the cover letter for the series I've just sent out, I ran into > > a bit of an understanding gap around the two counter cases. This isn't helped > > by the fact it is at least partly deprecated ABI given the counter subsystem > > has much richer ABI for these types of devices. > > > > @Fabrice, Benjamin and William. > > What do we do about that one? > > > > Thanks, > > > > Jonathan > > I'd consider the IIO counter ABI as entirely deprecated -- the Counter > subsystem supports all the functionality that's provided by the IIO > counter ABI, as well as additional functionality that is missing. > > Regarding the iio:deviceX/in_count_quadrature_mode_available attribute: > superseded by the Counter subsystem counterX/countY/function attribute. > The IIO counter ABI allows users to select between a quadrature counting > mode or a non-quadrature counting mode; unfortunately, it does not > specify what kind of quadrature or what kind of non-quadrature counting > is actually being performed by the device. > > Because the 104-quad-8 and stm32-lptimer-cnt drivers were the only ones > to use this attribute, they are luckily in sync -- both define the same > possible modes available: "quadrature" and "non-quadrature". You could > simply consolidate this attribute to the main sys-bus-iio file in order > to resolve this warning. > > Given that it has already been superceded by the Counter subsystem, I'd > also be all right with just removing the IIO Counter ABI entirely from > the codebase, or alternatively setting a future date for removal. I agree that we should look to remove this ABI. If we can establish no one is relying on it today then we can drop quickly. If not it would be good to establish when we drop it. Fabrice, Benjami any thoughts on the stm32-lptimer-cnt? I'm going to hazard a guess that there aren't many 104-quad-8 users that you don't know about William, so if you think we can immediately drop the interface from that, lets do so, whether or not we can clean up the stm32 one at the same time. Jonathan > > William Breathitt Gray > > > > > > > Jonathan > > > > > > > > > > > Thanks, > > > > Mauro > > > > > > ^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 00/10] Fix documentation warnings at linux-next 2021-01-19 10:41 ` Jonathan Cameron @ 2021-01-19 14:07 ` Fabrice Gasnier 0 siblings, 0 replies; 12+ messages in thread From: Fabrice Gasnier @ 2021-01-19 14:07 UTC (permalink / raw) To: Jonathan Cameron, William Breathitt Gray Cc: Jonathan Cameron, Mauro Carvalho Chehab, Lukas Bulwahn, corbet, linux-doc, linux-kernel, linux-iio, Benjamin Gaignard, Olivier MOYSAN On 1/19/21 11:41 AM, Jonathan Cameron wrote: > On Tue, 19 Jan 2021 18:17:05 +0900 > William Breathitt Gray <vilhelm.gray@gmail.com> wrote: > >> On Sun, Jan 17, 2021 at 03:42:18PM +0000, Jonathan Cameron wrote: >>> On Fri, 15 Jan 2021 13:47:20 +0000 >>> Jonathan Cameron <Jonathan.Cameron@Huawei.com> wrote: >>> >>>> On Fri, 15 Jan 2021 10:49:47 +0100 >>>> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote: >>>> >>>>> Hi Lukas, >>>>> >>>>> Em Fri, 15 Jan 2021 07:12:38 +0100 >>>>> Lukas Bulwahn <lukas.bulwahn@gmail.com> escreveu: >>>>> >>>>>> [reduced the recipient list to the main responsible ones and list] >>>>>> >>>>>> Hi Mauro, hi Jonathan, >>>>>> >>>>>> We both, Mauro and I, have been submitting patches to address the >>>>>> documentation warnings on linux-next. If it is okay with you, Mauro, I >>>>>> would like to take responsibility for the task to send out the patches >>>>>> to address all warnings on linux-next in make htmldocs and follow up >>>>>> with all the discussions. I can also provide a short weekly summary >>>>>> (probably always on Friday) on what is pending where and what I could >>>>>> not resolve by myself. >>>>>> >>>>>> Is that okay for you? >>>>>> >>>>>> If at some point I do not have the time to take care anymore, I will >>>>>> let you know. >>>>> >>>>> Yeah, sure! >>>>> >>>>> Anyway, after applying the patches I sent this week, the warnings >>>>> I'm getting are all due to the validation scripts I wrote. So, if >>>>> everything gets merged (either yours or my version), we'll have zero >>>>> Sphinx/kernel-doc warnings again. >>>>> >>>>> The script-validation warnings are: >>>>> >>>>> 1. Broken cross references >>>>> -------------------------- >>>>> >>>>> $ scripts/documentation-file-ref-check >>>>> Warning: Documentation/arm/booting.rst references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst >>>>> Warning: Documentation/devicetree/bindings/hwmon/ntc_thermistor.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt >>>>> Warning: Documentation/devicetree/bindings/input/adc-joystick.yaml references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt >>>>> Warning: Documentation/devicetree/bindings/power/supply/da9150-charger.txt references a file that doesn't exist: Documentation/devicetree/bindings/iio/iio-bindings.txt >>>>> Warning: Documentation/devicetree/bindings/regulator/rohm,bd9576-regulator.yaml references a file that doesn't exist: Documentation/devicetree/bindings/mfd/rohm,bd9576-pmic.yaml >>>>> Warning: Documentation/translations/zh_CN/arm/Booting references a file that doesn't exist: Documentation/devicetree/booting-without-of.rst >>>>> Warning: Documentation/virt/kvm/vcpu-requests.rst references a file that doesn't exist: Documentation/core-api/atomic_ops.rst >>>>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/pinctrl/toshiba,tmpv7700-pinctrl.yaml >>>>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/misc/hisilicon-hikey-usb.yaml >>>>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/display/intel,kmb_display.yaml >>>>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/media/i2c/ov2680.yaml >>>>> Warning: include/linux/rculist_nulls.h references a file that doesn't exist: Documentation/core-api/atomic_ops.rst >>>>> Warning: tools/memory-model/Documentation/simple.txt references a file that doesn't exist: Documentation/core-api/atomic_ops.rst >>>>> >>>>> It sounds that part of the above is due to DT patches that weren't >>>>> merged yet, but there are a few others that can be solved, but may >>>>> require discussions with some Kernel developers/maintainers. >>>>> >>>>> 2. Duplicated ABI definitions >>>>> ----------------------------- >>>>> >>>>> $ scripts/get_abi.pl validate >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 ./Documentation/ABI/testing/sysfs-bus-iio:394 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 ./Documentation/ABI/testing/sysfs-bus-iio:395 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 ./Documentation/ABI/testing/sysfs-bus-iio:396 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 ./Documentation/ABI/testing/sysfs-bus-iio:397 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 ./Documentation/ABI/testing/sysfs-bus-iio:398 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 ./Documentation/ABI/testing/sysfs-bus-iio:399 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 ./Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 ./Documentation/ABI/testing/sysfs-bus-iio:599 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 ./Documentation/ABI/testing/sysfs-bus-iio:588 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 ./Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1 >>>>> Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 ./Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8 >>>>> Warning: /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 ./Documentation/ABI/testing/sysfs-bus-iio:45 >>>>> Warning: /sys/class/backlight/<backlight>/l1_daylight_max is defined 2 times: ./Documentation/ABI/testing/sysfs-class-backlight-adp8860:12 ./Documentation/ABI/testing/sysfs-class-backlight-driver-adp8870:4 >>>>> Warning: /sys/class/leds/<led>/repeat is defined 2 times: ./Documentation/ABI/testing/sysfs-class-led-trigger-pattern:28 ./Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0 >>>>> Warning: /sys/kernel/iommu_groups/reserved_regions is defined 2 times: ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:15 ./Documentation/ABI/testing/sysfs-kernel-iommu_groups:27 >>>>> >>>>> Perhaps you could check with Jonathan Cameron some strategy to address >>>>> the IIO warnings. >>>> >>>> I'm being a bit rubbish on those ones. All need a bit of thought... >>>> >>>> I'll try to kill off a few of them this weekend as *touch wood* my >>>> review queue is looking fairly short. >>> >>> As I mentioned in the cover letter for the series I've just sent out, I ran into >>> a bit of an understanding gap around the two counter cases. This isn't helped >>> by the fact it is at least partly deprecated ABI given the counter subsystem >>> has much richer ABI for these types of devices. >>> >>> @Fabrice, Benjamin and William. >>> What do we do about that one? >>> >>> Thanks, >>> >>> Jonathan >> >> I'd consider the IIO counter ABI as entirely deprecated -- the Counter >> subsystem supports all the functionality that's provided by the IIO >> counter ABI, as well as additional functionality that is missing. >> >> Regarding the iio:deviceX/in_count_quadrature_mode_available attribute: >> superseded by the Counter subsystem counterX/countY/function attribute. >> The IIO counter ABI allows users to select between a quadrature counting >> mode or a non-quadrature counting mode; unfortunately, it does not >> specify what kind of quadrature or what kind of non-quadrature counting >> is actually being performed by the device. >> >> Because the 104-quad-8 and stm32-lptimer-cnt drivers were the only ones >> to use this attribute, they are luckily in sync -- both define the same >> possible modes available: "quadrature" and "non-quadrature". You could >> simply consolidate this attribute to the main sys-bus-iio file in order >> to resolve this warning. >> >> Given that it has already been superceded by the Counter subsystem, I'd >> also be all right with just removing the IIO Counter ABI entirely from >> the codebase, or alternatively setting a future date for removal. > > I agree that we should look to remove this ABI. If we can establish no one > is relying on it today then we can drop quickly. If not it would be good > to establish when we drop it. > > Fabrice, Benjami any thoughts on the stm32-lptimer-cnt? Hi Jonathan, William, I apologize for the late reply, being busy on other topics. I think the stm32 timer driver need some cleanup to remove this ABI: - stm32-lptimer-counter indeed is similar to 104-quad-8 driver. It still registers an IIO device with the "preset" attribute pointed out in the doc warning. Yes, the counter interface covers the same. So, I agree this ABI could be removed here. Still, I don't know if there are users for the IIO counter ABI. Dummy question... Is it needed to drop driver part and ABI, at the same time ? - stm32-timer-trigger driver which resides in iio, also registers preset attr being pointed out above. I'm more concerned there: I think some modes may depend on the preset attr, even for the trigger. Partial removal was done by Benjamin earlier (after stm32-timer-cnt addition). still I need to double check this. At least dropping the stm32-lptimer-counter part, should avoid the Warning here. So it may probably be ok in the short term? Please advise, Best Regards, Fabrice > > I'm going to hazard a guess that there aren't many 104-quad-8 users > that you don't know about William, so if you think we can immediately drop > the interface from that, lets do so, whether or not we can clean up > the stm32 one at the same time. > > Jonathan > >> >> William Breathitt Gray >> >>>> >>>> Jonathan >>>> >>>>> >>>>> Thanks, >>>>> Mauro >>>> >>> >> > ^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH 00/10] Fix documentation warnings at linux-next 2021-01-15 6:12 [PATCH 00/10] Fix documentation warnings at linux-next Lukas Bulwahn 2021-01-15 9:49 ` Mauro Carvalho Chehab @ 2021-01-15 16:37 ` Jonathan Corbet 1 sibling, 0 replies; 12+ messages in thread From: Jonathan Corbet @ 2021-01-15 16:37 UTC (permalink / raw) To: Lukas Bulwahn; +Cc: mchehab+huawei, linux-doc, linux-kernel On Fri, 15 Jan 2021 07:12:38 +0100 Lukas Bulwahn <lukas.bulwahn@gmail.com> wrote: > We both, Mauro and I, have been submitting patches to address the > documentation warnings on linux-next. If it is okay with you, Mauro, I > would like to take responsibility for the task to send out the patches > to address all warnings on linux-next in make htmldocs and follow up > with all the discussions. I can also provide a short weekly summary > (probably always on Friday) on what is pending where and what I could > not resolve by myself. > > Is that okay for you? I'm certainly not going to complain about warning fixes! If you want to take up this work, all I can say is - I'm looking forward to the patches. Thanks for doing this. jon ^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH 00/10] Fix documentation warnings at linux-next @ 2021-01-14 7:53 Mauro Carvalho Chehab 0 siblings, 0 replies; 12+ messages in thread From: Mauro Carvalho Chehab @ 2021-01-14 7:53 UTC (permalink / raw) To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, Chao Yu, Daniel Vetter, David Airlie, Felipe Balbi, Harry Wei, Ingo Molnar, Jaegeuk Kim, Mauro Carvalho Chehab, Moritz Fischer, Peter Zijlstra, Tom Rix, Will Deacon, Wu Hao, amd-gfx, dri-devel, kvm, linux-f2fs-devel, linux-fpga, linux-media, linux-usb This series fixes the documentation warnings found at next-20210114. Most of the changes here are trivial. While those patches could be merged via the docs tree during the next merge window, It sounds better to have those patches merged directly via each maintainer's tree, where the new warnings were introduced. Regards, Mauro Mauro Carvalho Chehab (10): doc/zh_CN: fix Sphinx errors ABI: sysfs-fs-f2fs: fix a table identation KVM: x86: hyper-v: add a blank line to remove building warnings ABI: sysfs-firmware-sgi_uv docs: fpga: dfl.rst: Fix a couple building issues drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup dwc3: document gadget_max_speed doc: zh_CN/mips: fix doc cross-references media: v4l2-subdev.rst: fix a missing whitespace seqlock: kernel-doc: fix a prototype Documentation/ABI/testing/sysfs-firmware-sgi_uv | 1 + Documentation/ABI/testing/sysfs-fs-f2fs | 3 ++- Documentation/driver-api/media/v4l2-subdev.rst | 2 +- Documentation/fpga/dfl.rst | 4 ++-- Documentation/translations/zh_CN/mips/booting.rst | 2 +- Documentation/translations/zh_CN/mips/features.rst | 2 +- Documentation/translations/zh_CN/mips/index.rst | 2 +- Documentation/translations/zh_CN/mips/ingenic-tcu.rst | 6 +++--- Documentation/virt/kvm/api.rst | 1 + drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +- drivers/usb/dwc3/core.h | 1 + include/linux/seqlock.h | 2 +- 12 files changed, 16 insertions(+), 12 deletions(-) -- 2.29.2 ^ permalink raw reply [flat|nested] 12+ messages in thread
end of thread, other threads:[~2021-01-19 23:43 UTC | newest] Thread overview: 12+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2021-01-15 6:12 [PATCH 00/10] Fix documentation warnings at linux-next Lukas Bulwahn 2021-01-15 9:49 ` Mauro Carvalho Chehab 2021-01-15 12:05 ` Lukas Bulwahn 2021-01-15 12:36 ` Mauro Carvalho Chehab 2021-01-15 12:41 ` Mauro Carvalho Chehab 2021-01-15 13:47 ` Jonathan Cameron 2021-01-17 15:42 ` Jonathan Cameron 2021-01-19 9:17 ` William Breathitt Gray 2021-01-19 10:41 ` Jonathan Cameron 2021-01-19 14:07 ` Fabrice Gasnier 2021-01-15 16:37 ` Jonathan Corbet -- strict thread matches above, loose matches on Subject: below -- 2021-01-14 7:53 Mauro Carvalho Chehab
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).