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=-8.2 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS, USER_AGENT_SANE_2 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 60BCFC33CB6 for ; Wed, 22 Jan 2020 11:45:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 3E7C321734 for ; Wed, 22 Jan 2020 11:45:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729196AbgAVLpN (ORCPT ); Wed, 22 Jan 2020 06:45:13 -0500 Received: from mx2.suse.de ([195.135.220.15]:47366 "EHLO mx2.suse.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726094AbgAVLpN (ORCPT ); Wed, 22 Jan 2020 06:45:13 -0500 X-Virus-Scanned: by amavisd-new at test-mx.suse.de Received: from relay2.suse.de (unknown [195.135.220.254]) by mx2.suse.de (Postfix) with ESMTP id 2775BAC81; Wed, 22 Jan 2020 11:45:11 +0000 (UTC) Date: Wed, 22 Jan 2020 12:45:09 +0100 From: Jean Delvare To: Luca Ceresoli Cc: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org, Wolfram Sang , Peter Rosin , linux-kernel@vger.kernel.org Subject: Re: [PATCH 25/26] docs: i2c: old-module-parameters: use monospace for filenames Message-ID: <20200122124509.3ec8a3a3@endymion> In-Reply-To: <20200106074654.13842-1-luca@lucaceresoli.net> References: <20200105224006.10321-1-luca@lucaceresoli.net> <20200106074654.13842-1-luca@lucaceresoli.net> Organization: SUSE Linux X-Mailer: Claws Mail 3.17.4 (GTK+ 2.24.32; x86_64-suse-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Mon, 6 Jan 2020 08:46:54 +0100, Luca Ceresoli wrote: > Use a monospace (literal) formatting for better readability of filenames. This description and the subject are confusing. The strings you are formatting are not filenames. They may be visible as sysfs attributes and thus correspond to a filename, but primarily they are module parameters and I2C client names. > > Signed-off-by: Luca Ceresoli > --- > Documentation/i2c/old-module-parameters.rst | 10 +++++----- > 1 file changed, 5 insertions(+), 5 deletions(-) > > diff --git a/Documentation/i2c/old-module-parameters.rst b/Documentation/i2c/old-module-parameters.rst > index 80fb117883fd..fdc470a5f999 100644 > --- a/Documentation/i2c/old-module-parameters.rst > +++ b/Documentation/i2c/old-module-parameters.rst > @@ -10,9 +10,9 @@ I2C device driver binding control from user-space > Up to kernel 2.6.32, many I2C drivers used helper macros provided by > which created standard module parameters to let the user > control how the driver would probe I2C buses and attach to devices. These > -parameters were known as "probe" (to let the driver probe for an extra > -address), "force" (to forcibly attach the driver to a given device) and > -"ignore" (to prevent a driver from probing a given address). > +parameters were known as ``probe`` (to let the driver probe for an extra > +address), ``force`` (to forcibly attach the driver to a given device) and > +``ignore`` (to prevent a driver from probing a given address). > > With the conversion of the I2C subsystem to the standard device driver > binding model, it became clear that these per-module parameters were no > @@ -46,8 +46,8 @@ New method (sysfs interface):: > # echo dummy 0x2f > /sys/bus/i2c/devices/i2c-1/new_device > # modprobe > > -Of course, it is important to instantiate the "dummy" device before loading > +Of course, it is important to instantiate the ``dummy`` device before loading > the driver. The dummy device will be handled by i2c-core itself, preventing > other drivers from binding to it later on. If there is a real device at the > problematic address, and you want another driver to bind to it, then simply > -pass the name of the device in question instead of "dummy". > +pass the name of the device in question instead of ``dummy``. Reviewed-by: Jean Delvare -- Jean Delvare SUSE L3 Support