From patchwork Tue May 25 12:23:53 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 12278645 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=-19.4 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable 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 9A147C4707F for ; Tue, 25 May 2021 12:24:00 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 783146142B for ; Tue, 25 May 2021 12:24:00 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232353AbhEYMZ3 (ORCPT ); Tue, 25 May 2021 08:25:29 -0400 Received: from mail.kernel.org ([198.145.29.99]:36522 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232305AbhEYMZ2 (ORCPT ); Tue, 25 May 2021 08:25:28 -0400 Received: by mail.kernel.org (Postfix) with ESMTPSA id E0D0361409; Tue, 25 May 2021 12:23:58 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1621945438; bh=sriZ/GA+KVZn8IQOjLCkBr9AX4FKzSKvGn0xqPQ5O9w=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=LO1BMNviHxXyhfwBtxtUtlrJYs/qVYeGYF+b+2mxL1byOG9xlwlcZp4E1O5bys9ZC ABKLMwEM793CJe0ftkcFDV7P4y/cxpTL2v682EZ3AN2WU2/8Jc5RiCw+kr5ofeYtHw XiQyyV7E/tTOeTJMynAc1qOGXSt9/lf+IMqMJeVmrtBNcG72L3M5ls+eFBI3nfoBB5 O+6dW6lfSJGW84YiCec+tKrNz45wQ9edvlJz+S9tzx6v+N5iILVK/6W06TydfDBt0l xmeM95xWmY3INLQ63z8MQ5DGV/C+B73MLQj4h33NdAyEEsbi2BfaCWuRhM/QP7ICSp I5aryZQamhgwQ== Received: by mail.kernel.org with local (Exim 4.94.2) (envelope-from ) id 1llW6G-000tUD-L1; Tue, 25 May 2021 14:23:56 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , Jonathan Cameron , Lars-Peter Clausen , linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org, Matthew Wilcox Subject: [PATCH 2/2] iio: ABI: sysfs-bus-iio: avoid a warning when doc is built Date: Tue, 25 May 2021 14:23:53 +0200 Message-Id: X-Mailer: git-send-email 2.31.1 In-Reply-To: References: MIME-Version: 1.0 Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-iio@vger.kernel.org The description of those vars produce this warning: Documentation/ABI/testing/sysfs-bus-iio:799: WARNING: Inline emphasis start-string without end-string. Due to an asterisk, which is the markup for emphasis. One possible fix would be to use ``*_timeout`` to avoid it, but looking at the descriptions of other fields in this file, a common pattern is to refer to "these" when talking about the API calls that are described. So, change the text in order to preserve the meaning while avoiding the need of using an asterisk there. Reported-by: Jonathan Corbet Reported-by: Matthew Wilcox Signed-off-by: Mauro Carvalho Chehab --- Documentation/ABI/testing/sysfs-bus-iio | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio index 433fe0ab74be..dcc52828a204 100644 --- a/Documentation/ABI/testing/sysfs-bus-iio +++ b/Documentation/ABI/testing/sysfs-bus-iio @@ -801,7 +801,7 @@ Contact: linux-iio@vger.kernel.org Description: When adaptive thresholds are used, the tracking signal may adjust too slowly to step changes in the raw signal. - *_timeout (in seconds) specifies a time for which the + Thus these specifiy the time in seconds for which the difference between the slow tracking signal and the raw signal is allowed to remain out-of-range before a reset event occurs in which the tracking signal is made equal