LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: "Luis R. Rodriguez" <mcgrof@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	"Rafael J. Wysocki" <rjw@rjwysocki.net>,
	Len Brown <len.brown@intel.com>, Pavel Machek <pavel@ucw.cz>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Masanari Iida <standby24x7@gmail.com>,
	linux-pm@vger.kernel.org, Kees Cook <keescook@chromium.org>
Subject: Re: [PATCH 02/18] docs: fix location of request_firmware & friends
Date: Wed, 9 May 2018 09:26:18 -0300	[thread overview]
Message-ID: <20180509092618.4a3801ac@vento.lan> (raw)
In-Reply-To: <20180508154908.GD27853@wotan.suse.de>

Em Tue, 8 May 2018 15:49:08 +0000
"Luis R. Rodriguez" <mcgrof@kernel.org> escreveu:

> On Mon, May 07, 2018 at 06:35:38AM -0300, Mauro Carvalho Chehab wrote:
> > commit 5d6d1ddd2730 ("firmware: move firmware loader into its own directory")
> > and other commits renamed the old firmware_class.c file and split it
> > into separate files, but documentation was not changed accordingly,
> > causing Sphinx errors.
> > 
> > Change the location accordingly at the documentation files.
> > 
> > While here, add a missing entry at request_firmware.rst for
> > release_firmware() function.
> > 
> > Fixes: 5d6d1ddd2730 ("firmware: move firmware loader into its own directory")
> > Cc: Kees Cook <keescook@chromium.org>
> > Cc: Luis R. Rodriguez <mcgrof@kernel.org>
> > Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > ---
> >  Documentation/dell_rbu.txt                      |  4 ++--
> >  .../driver-api/firmware/fallback-mechanisms.rst |  2 +-
> >  .../driver-api/firmware/request_firmware.rst    | 17 +++++++++++------
> >  Documentation/driver-api/infrastructure.rst     |  2 +-
> >  Documentation/power/suspend-and-cpuhotplug.txt  |  2 +-
> >  5 files changed, 16 insertions(+), 11 deletions(-)
> > 
> > diff --git a/Documentation/dell_rbu.txt b/Documentation/dell_rbu.txt
> > index 0fdb6aa2704c..befeff80e7ec 100644
> > --- a/Documentation/dell_rbu.txt
> > +++ b/Documentation/dell_rbu.txt
> > @@ -121,8 +121,8 @@ read back the image downloaded.
> >  
> >  .. note::
> >  
> > -   This driver requires a patch for firmware_class.c which has the modified
> > -   request_firmware_nowait function.
> > +   This driver requires a patch for drivers/base/firmware_loader/main.c
> > +   which has the modified request_firmware_nowait() function.
> >  
> >     Also after updating the BIOS image a user mode application needs to execute
> >     code which sends the BIOS update request to the BIOS. So on the next reboot  
> 
> This part looks good and is needed.

Ok. I'll submit this as a separate patch.

> 
> > diff --git a/Documentation/driver-api/firmware/fallback-mechanisms.rst b/Documentation/driver-api/firmware/fallback-mechanisms.rst
> > index f353783ae0be..7aed31b5a439 100644
> > --- a/Documentation/driver-api/firmware/fallback-mechanisms.rst
> > +++ b/Documentation/driver-api/firmware/fallback-mechanisms.rst
> > @@ -72,7 +72,7 @@ the firmware requested, and establishes it in the device hierarchy by
> >  associating the device used to make the request as the device's parent.
> >  The sysfs directory's file attributes are defined and controlled through
> >  the new device's class (firmware_class) and group (fw_dev_attr_groups).
> > -This is actually where the original firmware_class.c file name comes from,
> > +This is actually where drivers/base/firmware_loader/fallback.c comes from,  
> 
> Not this part.
> 
> What I meant to keep well documented here was not just only the old firmware
> file name for the code, but also the module name firmware_class, and its
> respective sysfs class name which is registered. From what I recall testing, we
> could not rename the module now because of this. I believe it had to do with
> the modular case, given the sysfs class could still be registered.
> 
> The fact that I forget the exact *issue* which prevented the module rename shows
> how important it is to document this.
> 
> Folks 10 years from now may wonder why the hell that name stuck, and the point was
> to document that the *original* loader was the sysfs fallback mechanism.

Yeah, I was in doubt about this one too. Yet, IMHO, mentioning a filename
that got removed will also be problematic 10 years from now. Perhaps you 
could say something similar to:

	Originally, the only firmware loading mechanism available was the
	one that it is now used as fallback. The file containing it used
	to be named after it, as firmware_class.c (nowadays, the fallback
	mechanism is at drivers/base/firmware_loader/fallback.c).

This way, you keep providing the explanations while pointing to the new
location of the code.

Just my 2 cents.

Thanks,
Mauro

  reply	other threads:[~2018-05-09 12:26 UTC|newest]

Thread overview: 87+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-07  9:35 [PATCH 00/18] Fix some build warnings/errors with Sphinx Mauro Carvalho Chehab
2018-05-07  9:35 ` [PATCH 01/18] docs: can.rst: fix a footnote reference Mauro Carvalho Chehab
2018-05-07 18:41   ` Oliver Hartkopp
2018-05-07  9:35 ` [PATCH 02/18] docs: fix location of request_firmware & friends Mauro Carvalho Chehab
2018-05-08  3:07   ` Greg Kroah-Hartman
2018-05-08 15:49   ` Luis R. Rodriguez
2018-05-09 12:26     ` Mauro Carvalho Chehab [this message]
2018-05-07  9:35 ` [PATCH 03/18] docs: */index.rst: Add newer documents to their respective index.rst Mauro Carvalho Chehab
2018-05-08  3:07   ` Greg Kroah-Hartman
2018-05-08 15:59   ` Jonathan Corbet
2018-05-07  9:35 ` [PATCH 04/18] docs: admin-guide: add bcache documentation Mauro Carvalho Chehab
2018-05-08 16:01   ` Jonathan Corbet
2018-05-07  9:35 ` [PATCH 05/18] docs: core-api: add cachetlb documentation Mauro Carvalho Chehab
2018-05-07 12:29   ` Andrea Parri
2018-05-08 14:40     ` Jani Nikula
2018-05-08 16:02       ` Andrea Parri
2018-05-08 16:28         ` Andrea Parri
2018-05-08 18:05       ` Mauro Carvalho Chehab
2018-05-08 18:28         ` Mauro Carvalho Chehab
2018-05-08 19:05           ` Andrea Parri
2018-05-08 16:04   ` Jonathan Corbet
2018-05-08 16:51     ` Andrea Parri
2018-05-07  9:35 ` [PATCH 06/18] docs: core-api: add cgroup-v2 documentation Mauro Carvalho Chehab
2018-05-08 15:51   ` Jonathan Corbet
2018-05-09 12:02     ` Mauro Carvalho Chehab
2018-05-07  9:35 ` [PATCH 07/18] docs: core-api: add circular-buffers documentation Mauro Carvalho Chehab
2018-05-07 12:31   ` Andrea Parri
2018-05-08 16:08   ` Jonathan Corbet
2018-05-07  9:35 ` [PATCH 08/18] docs: driver-api: add clk documentation Mauro Carvalho Chehab
2018-05-08  3:07   ` Greg Kroah-Hartman
2018-05-08 16:10   ` Jonathan Corbet
2018-05-07  9:35 ` [PATCH 09/18] net: mac80211.h: fix a bad comment line Mauro Carvalho Chehab
2018-05-07 12:37   ` Kalle Valo
2018-05-07 12:38     ` Johannes Berg
2018-05-09 12:04       ` Mauro Carvalho Chehab
2018-05-09 12:04         ` Johannes Berg
2018-05-07  9:35 ` [PATCH 10/18] rcu: rcupdate.h: get rid of Sphinx warnings at rcu_pointer_handoff() Mauro Carvalho Chehab
2018-05-07 14:23   ` Paul E. McKenney
2018-05-09 11:55     ` Mauro Carvalho Chehab
2018-05-14 19:40       ` Paul E. McKenney
2018-05-07  9:35 ` [PATCH 11/18] docs: crypto_engine.rst: Fix two parse warnings Mauro Carvalho Chehab
2018-05-07  9:35 ` [PATCH 12/18] time: timer.c: adjust a kernel-doc comment Mauro Carvalho Chehab
2018-05-13 14:00   ` [tip:timers/core] timers: Adjust " tip-bot for Mauro Carvalho Chehab
2018-05-07  9:35 ` [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings Mauro Carvalho Chehab
2018-05-09  8:41   ` Peter Zijlstra
2018-05-09 14:45     ` Jonathan Corbet
2018-05-09 15:20       ` Peter Zijlstra
2018-05-09 18:35         ` Jonathan Corbet
2018-05-09 18:50           ` Markus Heiser
2018-05-09 19:31           ` Peter Zijlstra
2018-05-10 12:23       ` Andrea Parri
2018-05-10 13:15         ` Jonathan Corbet
2018-05-10 16:52           ` Andrea Parri
2018-05-10 17:45             ` Mauro Carvalho Chehab
2018-05-10  8:38   ` Christoph Hellwig
2018-05-10  9:38     ` Mauro Carvalho Chehab
2018-05-10 12:20       ` Peter Zijlstra
2018-05-10 13:04         ` Mauro Carvalho Chehab
2018-05-10 13:30       ` Jonathan Corbet
2018-05-10 13:31         ` Jonathan Corbet
2018-05-10 14:21         ` Mauro Carvalho Chehab
2018-05-10 15:38           ` Jonathan Corbet
2018-05-10 16:42             ` Mauro Carvalho Chehab
2018-05-10 17:14               ` Mauro Carvalho Chehab
2018-05-11  7:06               ` Markus Heiser
2018-05-07  9:35 ` [PATCH 14/18] fbdev: modedb.c: fix a kernel-doc markup Mauro Carvalho Chehab
2018-05-15 10:22   ` Bartlomiej Zolnierkiewicz
2018-05-07  9:35 ` [PATCH 15/18] iio: iio.h: use nested struct support on " Mauro Carvalho Chehab
2018-05-07 17:08   ` Jonathan Cameron
2018-05-09 12:00     ` Mauro Carvalho Chehab
2018-05-07  9:35 ` [PATCH 16/18] mtd: rawnand.h: use nested union kernel-doc markups Mauro Carvalho Chehab
2018-05-07  9:46   ` Boris Brezillon
2018-05-07 11:32     ` Mauro Carvalho Chehab
2018-05-09 12:02       ` Boris Brezillon
2018-05-09 12:10       ` Mauro Carvalho Chehab
2018-05-09 12:22         ` Boris Brezillon
2018-05-09 13:28           ` Mauro Carvalho Chehab
2018-05-09 15:56   ` Boris Brezillon
2018-05-07  9:35 ` [PATCH 17/18] docs: uio-howto.rst: use a code block to solve a warning Mauro Carvalho Chehab
2018-05-08  3:07   ` Greg Kroah-Hartman
2018-05-07  9:35 ` [PATCH 18/18] w1: w1_io.c: fix a kernel-doc warning Mauro Carvalho Chehab
2018-05-08 11:03   ` Evgeniy Polyakov
2018-05-09 12:32     ` Mauro Carvalho Chehab
2018-05-09 13:11       ` Jonathan Corbet
2018-05-10 10:37         ` Evgeniy Polyakov
2018-05-08 16:13 ` [PATCH 00/18] Fix some build warnings/errors with Sphinx Jonathan Corbet
2018-05-08 17:36   ` Luis R. Rodriguez

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180509092618.4a3801ac@vento.lan \
    --to=mchehab+samsung@kernel.org \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=keescook@chromium.org \
    --cc=len.brown@intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=mcgrof@kernel.org \
    --cc=mchehab@infradead.org \
    --cc=pavel@ucw.cz \
    --cc=rjw@rjwysocki.net \
    --cc=standby24x7@gmail.com \
    --subject='Re: [PATCH 02/18] docs: fix location of request_firmware & friends' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

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).