From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.6 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,SPF_HELO_NONE, SPF_PASS,USER_AGENT_SANE_2 autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C42D4C388F9 for ; Sun, 8 Nov 2020 16:56:40 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 70AC02068D for ; Sun, 8 Nov 2020 16:56:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1604854600; bh=HmpnTGD+sCqkzYKB+VNNoQPDyYLZ8DVZYqWfmSgpAfA=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=YhRC8RnQQwuFCmPce7djXOjjoGE3gMGzkpwJ9VsjFqD0sbEZkMVY1berY/0YMSDp+ nhfp8pSbjNzacww5wcsFvu1LDsNEj5AKDUmdw6bvTOea6J4pa+KMFLnqQWJvy6GvDM RhMP4EOIA3JWgLISBvssP7Z1sDAHd38wClAPj7vI= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727929AbgKHQ4j (ORCPT ); Sun, 8 Nov 2020 11:56:39 -0500 Received: from mail.kernel.org ([198.145.29.99]:35208 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727570AbgKHQ4j (ORCPT ); Sun, 8 Nov 2020 11:56:39 -0500 Received: from archlinux (cpc149474-cmbg20-2-0-cust94.5-4.cable.virginm.net [82.4.196.95]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 289C720678; Sun, 8 Nov 2020 16:56:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1604854597; bh=HmpnTGD+sCqkzYKB+VNNoQPDyYLZ8DVZYqWfmSgpAfA=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=jTr8zTsz0WaJ6nnvT5Eg1Ll2ihGmqcyn+2SF+Wf/mrD2qllK/kFqFW/v7wcgZNefk zS7dIr/q6PaG6DfI7dBacAjjo5nnHikNbE1GU0b2Tz2VVRAwvJAMwi+yrMpSam0vAS yISkL1OxDj/prQqrSSSyaYuB90OjYqoYVe7sJd6Y= Date: Sun, 8 Nov 2020 16:56:21 +0000 From: Jonathan Cameron To: Mauro Carvalho Chehab Cc: Greg Kroah-Hartman , Fabrice Gasnier , Linux Doc Mailing List , "Gautham R. Shenoy" , "Jason A. Donenfeld" , Javier =?UTF-8?B?R29uesOhbGV6?= , Jonathan Corbet , "Martin K. Petersen" , "Rafael J. Wysocki" , Alexander Shishkin , Alexandre Belloni , Alexandre Torgue , Andrew Donnellan , Andy Shevchenko , Baolin Wang , Benson Leung , Boris Ostrovsky , Bruno Meneguele , Chunyan Zhang , Dan Murphy , Dan Williams , Enric Balletbo i Serra , Felipe Balbi , Frederic Barrat , Guenter Roeck , Hanjun Guo , Heikki Krogerus , Jens Axboe , Johannes Thumshirn , Juergen Gross , Konstantin Khlebnikov , Kranthi Kuntala , Lakshmi Ramasubramanian , Lars-Peter Clausen , Len Brown , Leonid Maksymchuk , Ludovic Desroches , Mario Limonciello , Mark Gross , Maxime Coquelin , Michael Ellerman , Mika Westerberg , Mike Kravetz , Mimi Zohar , Nayna Jain , Nicolas Ferre , Niklas Cassel , Oded Gabbay , Oleh Kravchenko , Orson Zhai , Pavel Machek , Pawan Gupta , Peter Meerwald-Stadler , Peter Rosin , Petr Mladek , Philippe Bergheaud , Richard Cochran , Sebastian Reichel , Sergey Senozhatsky , Stefano Stabellini , Thinh Nguyen , Thomas Gleixner , Tom Rix , Vaibhav Jain , Vineela Tummalapalli , Vishal Verma , linux-acpi@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org, linux-mm@kvack.org, linux-pm@vger.kernel.org, linux-stm32@st-md-mailman.stormreply.com, linux-usb@vger.kernel.org, linuxppc-dev@lists.ozlabs.org, netdev@vger.kernel.org, xen-devel@lists.xenproject.org, Jonathan Cameron Subject: Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible with ReST output Message-ID: <20201108165621.4d0da3f4@archlinux> In-Reply-To: <20201102154250.45bee17f@coco.lan> References: <58cf3c2d611e0197fb215652719ebd82ca2658db.1604042072.git.mchehab+huawei@kernel.org> <5326488b-4185-9d67-fc09-79b911fbb3b8@st.com> <20201030110925.3e09d59e@coco.lan> <20201102124641.GA881895@kroah.com> <20201102154250.45bee17f@coco.lan> X-Mailer: Claws Mail 3.17.7 (GTK+ 2.24.32; x86_64-pc-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Mon, 2 Nov 2020 15:42:50 +0100 Mauro Carvalho Chehab wrote: > Em Mon, 2 Nov 2020 13:46:41 +0100 > Greg Kroah-Hartman escreveu: > > > On Mon, Nov 02, 2020 at 12:04:36PM +0100, Fabrice Gasnier wrote: > > > On 10/30/20 11:09 AM, Mauro Carvalho Chehab wrote: > > > > Em Fri, 30 Oct 2020 10:19:12 +0100 > > > > Fabrice Gasnier escreveu: > > > > > > > >> Hi Mauro, > > > >> > > > >> [...] > > > >> > > > >>> > > > >>> +What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available > > > >>> +KernelVersion: 4.12 > > > >>> +Contact: benjamin.gaignard@st.com > > > >>> +Description: > > > >>> + Reading returns the list possible quadrature modes. > > > >>> + > > > >>> +What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode > > > >>> +KernelVersion: 4.12 > > > >>> +Contact: benjamin.gaignard@st.com > > > >>> +Description: > > > >>> + Configure the device counter quadrature modes: > > > >>> + > > > >>> + channel_A: > > > >>> + Encoder A input servers as the count input and B as > > > >>> + the UP/DOWN direction control input. > > > >>> + > > > >>> + channel_B: > > > >>> + Encoder B input serves as the count input and A as > > > >>> + the UP/DOWN direction control input. > > > >>> + > > > >>> + quadrature: > > > >>> + Encoder A and B inputs are mixed to get direction > > > >>> + and count with a scale of 0.25. > > > >>> + > > > >> > > > > > > > > Hi Fabrice, > > > > > > > >> I just noticed that since Jonathan question in v1. > > > >> > > > >> Above ABI has been moved in the past as discussed in [1]. You can take a > > > >> look at: > > > >> b299d00 IIO: stm32: Remove quadrature related functions from trigger driver > > > >> > > > >> Could you please remove the above chunk ? > > > >> > > > >> With that, for the stm32 part: > > > >> Acked-by: Fabrice Gasnier > > > > > > > > > > > > Hmm... probably those were re-introduced due to a rebase. This > > > > series were originally written about 1,5 years ago. > > > > > > > > I'll drop those hunks. > > > > > > Hi Mauro, Greg, > > > > > > I just figured out this patch has been applied with above hunk. > > > > > > This should be dropped: is there a fix on its way already ? > > > (I may have missed it) > > > > Can you send a fix for just this hunk? > > Hmm... > > $ git grep /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available > Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available > Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available > Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available > > Even re-doing the changes from > changeset b299d00420e2 ("IIO: stm32: Remove quadrature related functions from trigger driver") > at Documentation/ABI/testing/sysfs-bus-iio-timer-stm32, there's still > a third duplicate of some of those, as reported by the script: > > $ ./scripts/get_abi.pl validate 2>&1|grep quadra > Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:117 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:14 > Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 3 times: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:111 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8 > > As in_count_quadrature_mode_available is also defined at: > Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 > > The best here seems to have a patch that will also drop the other > duplication of this, probably moving in_count_quadrature_mode_available > to a generic node probably placing it inside > Documentation/ABI/testing/sysfs-bus-iio. In this particular case it may be valid to do that, but it's not in general without loosing information - see below. > > Comments? > > Thanks, > Mauro > > PS.: the IIO subsystem is the one that currently has more duplicated > ABI entries: That was intentional. Often these provide more information on the ABI for a particular device than is present in the base ABI doc. A bit like when we have additional description for dt binding properties for a particular device, even though they are standard properties. Often a standard property allows for more values than the specific one for a particular device. There can also be obscuring coupling between sysfs attributes due to hardware restrictions that we would like to provide some explanatory info on. I suppose we could add all this information to the parent doc but that is pretty ugly and will make that doc very nasty to read. Jonathan > > $ ./scripts/get_abi.pl validate 2>&1|grep iio > 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_count0_quadrature_mode is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:117 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:14 > Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 3 times: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:111 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