Received: by 10.192.165.156 with SMTP id m28csp193018imm; Tue, 17 Apr 2018 08:36:43 -0700 (PDT) X-Google-Smtp-Source: AIpwx48keTbXjj9fihpMZZtg5XN26xM8GC5jevOdoN71su//H2VIB4t3HgI+V26o3Fg5JIA8G2Qd X-Received: by 2002:a17:902:7508:: with SMTP id i8-v6mr2417621pll.215.1523979403435; Tue, 17 Apr 2018 08:36:43 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1523979403; cv=none; d=google.com; s=arc-20160816; b=r42XZNJY7pLO+Rt1653332eRxFSLu+mMxiH+oeYAaAoNZruYptoXhUcX88oyb0nYKp 8HLvzJBHjrAIQUJ6vPk3Nw5AIEfbqoZ9+mvmn3RqSbqWfeBcRz+3XoD7H6tK1bG4JI1s TDKCcVwIYbl9vcdEcOQS6VXKhFfapbDYDTgAUXk8hi6yfsPjO9Yrrm2bul245qhpOMO/ d/k87M53F2I4TXk46ab3dY1vdjx5d1fuGfhazWhoogiDTs0RfHg6ds0N5WsH0B3OfnRt hHBO8RcKzdbdzYVMZHbC0BqX6n10CrM330OmkApnn8w9buDrJ8v1A52ZUbVWOfAFsmBc CMDA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:references:in-reply-to:message-id:date :subject:cc:to:from:dkim-signature:arc-authentication-results; bh=pFVa8UChjt88Sb1aip39w+x6+lytthy+XOvOofff2QI=; b=TAa03szCg9+5/WpY9J9YEN0CKO13d+Z/03R0cYHy6jXS0OrJxJhyNqOvdIwmKUO10B AtDa4L75SB/7mlO/z6VcrCBayqUjlGBMr/TcdDv5UqM6UII7mwSI7hoblUuAiWRy5WSH srFPLNR7p+TXWWhzUhO7nmQHX8il14idCRa8BiqFVMoLK+7wUdxl3Sc5jukLXm+DNCXc +lMiVryqt7y7BFSh/Q+tgffzkczOQMceW//P1JauSlTsxEhzLIp0M93jn2HLnlUPEJ5r U98u5fLiduZMpywZfpqqWDS4SbzK9TZrd7K6jUhnubeXluNXF5nx91wDexWNDWC2Kgzw Avyw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=fMTiNIYc; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id 1-v6si13926806ply.119.2018.04.17.08.36.29; Tue, 17 Apr 2018 08:36:43 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=fMTiNIYc; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752902AbeDQPdX (ORCPT + 99 others); Tue, 17 Apr 2018 11:33:23 -0400 Received: from mail-it0-f66.google.com ([209.85.214.66]:37259 "EHLO mail-it0-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752359AbeDQPdS (ORCPT ); Tue, 17 Apr 2018 11:33:18 -0400 Received: by mail-it0-f66.google.com with SMTP id 71-v6so16747460ith.2 for ; Tue, 17 Apr 2018 08:33:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=pFVa8UChjt88Sb1aip39w+x6+lytthy+XOvOofff2QI=; b=fMTiNIYci/LL9QWFUtJ/5qHFE+FhPGrpPfRy1+GmD5H0LHCxQp9Fa9JgC+p8AmYJP4 nxoEE/vsItzs/q3jMTecJE3BOXnmTAvcjUpYQBlTHq/yGqtZGTBEhIQEOwR9WdJRUDsP R3uwKSKLwW+a2MhzLCxSZci/3XxDAAKh5/kJMgDkc+JTErMInzxnJJMv4x+sZAtGYX3v dfv+0CJjmg7I0kBGNKkm4N24Pg4oML2zHnHHDZWvu5LLnGrrunsFyz2Sr67SeAa+J/D+ DWpdXK7h3WokoFK1f2FcxuBCdXXGq2dyKQeojeGw+oYbHtuQ6uWVGnPYbwIXWOL1Rr5R F6fw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=pFVa8UChjt88Sb1aip39w+x6+lytthy+XOvOofff2QI=; b=gYEF/OzEE+m+s74em1cRJ/1QcJ5aBhoc8Bl3+tl7pdtT1GONwk3t8kh2qUAYVQTbq3 c+7f9E7Rbfx4iodVXu7iIhi2u94nSP75j5KMHDa/AJ5bPKCh8fl2Z6zUqLf2vme6UEYZ BzHzx8ywF+LpBM0XbpzBCEpaqLB7i0Wp9KjDQLfrVwVni11MSpRfyuyNuMtYQ0grlHBh PAuNJN4ZslWbq1wQN5aykIJdHnQALzdik2S7zcy4cTF9IMYJRWHi2hkrtfG80IWC07sy JKRvbK+NfGwJ5J/3OpqBDlThXF+QYEVmYIJVYz8MPd4IfK2ps3fRtifEMt8gDjAr0808 Gt+A== X-Gm-Message-State: ALQs6tDH9Dv4T7wM3xMz8GCTGhiNYfq09Utc1BpjaKcNX9l3JJ8O7NUs CbvNc/NGbAPVo4rtCJT4Chy4vAhN X-Received: by 2002:a24:624b:: with SMTP id d72-v6mr1827454itc.70.1523979197328; Tue, 17 Apr 2018 08:33:17 -0700 (PDT) Received: from localhost.localdomain (184-175-36-239.dsl.teksavvy.com. [184.175.36.239]) by smtp.gmail.com with ESMTPSA id y20sm7474131ioy.27.2018.04.17.08.33.16 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 17 Apr 2018 08:33:16 -0700 (PDT) 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/9] firmware: some documentation fixes Date: Tue, 17 Apr 2018 11:32:59 -0400 Message-Id: <20180417153307.3693-2-andresx7@gmail.com> X-Mailer: git-send-email 2.14.1 In-Reply-To: <20180417153307.3693-1-andresx7@gmail.com> References: <20180417153307.3693-1-andresx7@gmail.com> Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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