Received: by 10.192.165.156 with SMTP id m28csp1167193imm; Mon, 16 Apr 2018 15:29:10 -0700 (PDT) X-Google-Smtp-Source: AIpwx4/hcSXzNvVaobwcX5XK6jtjLxCSYfluEe3IZSJHAR79f1qnGhh2Gt4mbvJ9M/uV3sLLcKDF X-Received: by 10.99.117.24 with SMTP id q24mr9917194pgc.1.1523917750361; Mon, 16 Apr 2018 15:29:10 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1523917750; cv=none; d=google.com; s=arc-20160816; b=vUQXOzIMyyquzb+S+DFzPtstEYJT1mHqIfJVwHPvDfBqwVikQR8IHbmWHWqAKhBLd5 p/T8QnzEIkrlKu1li8vbJEePhWoksH6Wd3CFUkpSdtWFc04zufWkKrp42cQh3PphMTmw XBJJFxVpq2rOnK50EEHFjOD8pyPQjl4Wxw7tEuGMeQmobtsxpT9wLLQPD0FY2SHhDolK FGxoZUXqKCEf0PvvqyeQWC/iMn27zP/Fx2WvdqueftTor5UtpfQYlvAEZPRxmt3HANer chFWzyAp5CweDfzTeW8cL4T64QS/6529PNr9tdlQFN/S5A0YYUMjp8foGofRshh5Bqdl HSZQ== 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=muRBIyZhYjn3XqSYnh0uYYKCkk8ZkgquMLV6BBfN2FRT5vIoCiLAbFR1XCi1FfxGq0 xkDpa0yaUnSD+EOUE9B0B+1LmhzqQPoH9mfoEw8lOY6/bvm7rRwW8OwnLFuKdNiYkpL4 qCkhdrCY6eXFgL5DgO8Cwph+rRQtwje+5r28kOF6qqedQ7Oqg4c9R1Pn34SE5MCLLVA5 6reC6vtMG5wElEdPVOG2hvk0bzVGx2rJaUuOGxA/pYKKX7d5CNiG0CbW+Te2nNQMv1/+ wrjYfA0eL6BY5VGpt7ZS4BOhje4sAFMxiRP2ZwlRq0qWjVkDNLhND42+xbomh5nC26Zy GTLQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=qNOg6akX; 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 l1si10434804pga.536.2018.04.16.15.28.56; Mon, 16 Apr 2018 15:29:10 -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=qNOg6akX; 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 S1753229AbeDPW0R (ORCPT + 99 others); Mon, 16 Apr 2018 18:26:17 -0400 Received: from mail-it0-f67.google.com ([209.85.214.67]:37659 "EHLO mail-it0-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751194AbeDPWYp (ORCPT ); Mon, 16 Apr 2018 18:24:45 -0400 Received: by mail-it0-f67.google.com with SMTP id 71-v6so13679678ith.2 for ; Mon, 16 Apr 2018 15:24:45 -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=qNOg6akX2P9NXTCFY1t+2NMo4dZ/v4mLV3SXfJCijG2nol7p3jWX+e1ZESV44qZigF cUHG6eJD7sN6hJTpG/lK83zSHxN6LA8u+M3VpHDU/8/9RSnhRtILs7sHyB+J9jUvXXkL RbITY3ZiVb/UwOtPf77i3AcIIHdQ0zhumR9BpFKnQXij8KnK8CY3XlXuF5rSJFFt0l/H WKYdfI72u1S3VXT9fZSkP7wR6WPt1T1MvC1/T3URVOGsFe8XwyECGtqAobo+AHhr47lg 9v4hSh02SOzCZ5u/O56OALvQibZwOHUmLKAQML1CYUoFr3/h46znLAJlF2XUmiev1OYG GUWw== 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=ntje3bQusufLsr8znkIkPL370aa2Th9z8VyWN2BhjK5JSJ62P8Du5kC0bBzm3rx6b7 eSvgIZ5FlDYT8b7C2fPtrlOzUYJ1+VCM7DVHlJFDpO2KTC99pmEMkMBBkjkfbnwd/33X qrnDtsPf7YiPe/W/mlm6R0e5NDztmesZiKDWE3JpjJWKUScmOkTPB7lNsIdIh1rzjNNl fAIETmrP98clwu9ktn6g5eT2te50KRstCRL2BKICjW7agSeksyZ83veDiW1ZZ1SuMud0 QIKAlwqDnKfDVr5+DW5sgjnje0ykdyPoXu3W0w7wvMvQBFxV7AaYpyiVE/EHD53KSqvT RL4A== X-Gm-Message-State: ALQs6tCDoVOxf2cW3qEFlCbNsiMDMkjoVMfP5x+CwxcHbb6uhMmpN1P1 OTR8zdNfeql/omWKqWR1RU51kZjT X-Received: by 2002:a24:8905:: with SMTP id s5-v6mr101003itd.136.1523917484871; Mon, 16 Apr 2018 15:24:44 -0700 (PDT) Received: from localhost.localdomain (184-175-36-239.dsl.teksavvy.com. [184.175.36.239]) by smtp.gmail.com with ESMTPSA id x139-v6sm5095360itb.3.2018.04.16.15.24.43 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 16 Apr 2018 15:24:44 -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/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> 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