Re: [PATCH v2 3/5] firmware: revamp firmware documentation

[Kalle Valo <kvalo@codeaurora.org>]

"Luis R. Rodriguez" <mcgrof@kernel.org> writes:

> Understanding this code is getting out of control without any
> notes. Give the firmware_class driver a much needed documentation love,
> and while at it convert it to the new sphinx documentation format.
>
> v2: typos and small fixes
>
> Signed-off-by: Luis R. Rodriguez <mcgrof@kernel.org>

[...]

> +To upload firmware you will echo 1 onto the loading file to indicate
> +you are loading firmware. You then cat the firmware into the data file,

s/cat/write/?

> +Refer to do_firmware_uevent() for details of the kobject event variables
> +setup. Variables passwdd with a kobject add event:

"passed" or what? I'm not quite understanding the last sentence anyway.

> +* If an asynchronous call is used the firmware cache is only set up for a
> +  device if if the second argument (uevent) to request_firmware_nowait() is
> +  true. When uevent is true it requests that a kobject uevent be sent to
> +  userspace for the firmware request. For details refer to the Fackback
> +  mechanism documented below.

Is that "fackback" typo intentional? Pretty funny at least :)

But this was really good, thanks. I learned a lot.

-- 
Kalle Valo