From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: ARC-Seal: i=1; a=rsa-sha256; t=1523917485; cv=none; d=google.com; s=arc-20160816; b=MKqZCPo2NKJFnKjPjUQ8CQ2QCEh3PTPq1vsSqVPn845G2sTiA2QF9qcVvcRKOGp5Zc 7ki5qbQ+W9GmNOrrMJj//3LqiwxI3/6HJj5x1hC9Da00/FmQyWHX0Uhr9DyJFZ+SPJlT xtIBgkM4pjIFCWp3twXZ8745Z/QVqj5paxYhgqvt6SLr8NyYcAas61QMzjZ0EhIcrg63 YKtObqjDvZj/DNL4cZF/CuX6oyXCpJSy7OLrPLcPSxS3nayoLQccQ75wkhlFHfakPFtX FwvFwxRhcnMO/EptYfQIQuqSjcTSBFxfruXNPPfy6TROXFwjaUusgulNXZi9ArnMzs11 Bgew== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature:arc-authentication-results; bh=pFVa8UChjt88Sb1aip39w+x6+lytthy+XOvOofff2QI=; b=GDuukOy5bCe/Q7PCFMjabB8ER0uoumCo7q0Veq5bk+l9DTfnoKrPcInl6TCjheeiDi C1ziuwM79p2VCBNi48afHdahLbFys6E988pwlCGOM8GK3N99556u/eVo7D+IdK8a3RLr GlKURJuDjBBW3Cwb3b2bUUPDaKgLLptxMM0y1FAMKF4AbpSt1yY5w0mUVrZEQTL0ZeMj 5RrCMOzlycr/oUXj3WNo2h9JZSIGR4L6RBqDyYo1PpUOtC6gmBgrXPdT0AC4KN2tJGtL /DJ+sV5Vk47dzyn/jutthfIhBNS0/j3XgP+jdjzZJ0R0YF7FpX4VbKwQ/G3Buhmwd4H1 5PhA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=qNOg6akX; spf=pass (google.com: domain of andresx7@gmail.com designates 209.85.220.65 as permitted sender) smtp.mailfrom=andresx7@gmail.com; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=qNOg6akX; spf=pass (google.com: domain of andresx7@gmail.com designates 209.85.220.65 as permitted sender) smtp.mailfrom=andresx7@gmail.com; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com X-Google-Smtp-Source: AIpwx49pes0h2aUHdyLkeb0BXM2cc1J+MzXZaAqXV6/ZQnfhrTjtb5ehD5gH82PLuIls1Od7NtcRnw== From: Andres Rodriguez To: linux-kernel@vger.kernel.org Cc: andresx7@gmail.com, gregkh@linuxfoundation.org, mcgrof@kernel.org, alexdeucher@gmail.com, ckoenig.leichtzumerken@gmail.com, kvalo@codeaurora.org, arend.vanspriel@broadcom.com Subject: [PATCH 1/8] firmware: some documentation fixes Date: Mon, 16 Apr 2018 18:24:20 -0400 Message-Id: <20180416222427.29683-2-andresx7@gmail.com> X-Mailer: git-send-email 2.14.1 In-Reply-To: <20180416222427.29683-1-andresx7@gmail.com> References: <20180416222427.29683-1-andresx7@gmail.com> X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: =?utf-8?q?1597943300827298159?= X-GMAIL-MSGID: =?utf-8?q?1597943300827298159?= X-Mailing-List: linux-kernel@vger.kernel.org List-ID: Including: - Fixup outdated kernel-doc paths - Slightly too short title underline - Some typos Signed-off-by: Andres Rodriguez --- Documentation/driver-api/firmware/request_firmware.rst | 16 ++++++++-------- drivers/base/firmware_loader/fallback.c | 4 ++-- drivers/base/firmware_loader/fallback.h | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/Documentation/driver-api/firmware/request_firmware.rst b/Documentation/driver-api/firmware/request_firmware.rst index 9305bf4db38e..7632f8807472 100644 --- a/Documentation/driver-api/firmware/request_firmware.rst +++ b/Documentation/driver-api/firmware/request_firmware.rst @@ -17,17 +17,17 @@ an error is returned. firmware_request ---------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: firmware_request firmware_request_direct ----------------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: firmware_request_direct firmware_request_into_buf ------------------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: firmware_request_into_buf Asynchronous firmware requests @@ -41,7 +41,7 @@ in atomic contexts. firmware_request_nowait ----------------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: firmware_request_nowait Special optimizations on reboot @@ -50,12 +50,12 @@ Special optimizations on reboot Some devices have an optimization in place to enable the firmware to be retained during system reboot. When such optimizations are used the driver author must ensure the firmware is still available on resume from suspend, -this can be done with firmware_request_cache() insted of requesting for the -firmare to be loaded. +this can be done with firmware_request_cache() instead of requesting for the +firmware to be loaded. firmware_request_cache() ------------------------ -.. kernel-doc:: drivers/base/firmware_class.c +------------------------ +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: firmware_request_cache request firmware API expected driver use diff --git a/drivers/base/firmware_loader/fallback.c b/drivers/base/firmware_loader/fallback.c index 71f529de5243..da97fc26119c 100644 --- a/drivers/base/firmware_loader/fallback.c +++ b/drivers/base/firmware_loader/fallback.c @@ -536,8 +536,8 @@ fw_create_instance(struct firmware *firmware, const char *fw_name, } /** - * fw_load_sysfs_fallback - load a firmware via the syfs fallback mechanism - * @fw_sysfs: firmware syfs information for the firmware to load + * fw_load_sysfs_fallback - load a firmware via the sysfs fallback mechanism + * @fw_sysfs: firmware sysfs information for the firmware to load * @opt_flags: flags of options, FW_OPT_* * @timeout: timeout to wait for the load * diff --git a/drivers/base/firmware_loader/fallback.h b/drivers/base/firmware_loader/fallback.h index dfebc644ed35..f8255670a663 100644 --- a/drivers/base/firmware_loader/fallback.h +++ b/drivers/base/firmware_loader/fallback.h @@ -6,7 +6,7 @@ #include /** - * struct firmware_fallback_config - firmware fallback configuratioon settings + * struct firmware_fallback_config - firmware fallback configuration settings * * Helps describe and fine tune the fallback mechanism. * -- 2.14.1