From patchwork Wed Apr 25 16:25:39 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andres Rodriguez X-Patchwork-Id: 10363857 X-Patchwork-Delegate: kvalo@adurom.com Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 1E7F76038F for ; Wed, 25 Apr 2018 16:26:21 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 0C3F128C90 for ; Wed, 25 Apr 2018 16:26:21 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 00BBF287B5; Wed, 25 Apr 2018 16:26:20 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, FREEMAIL_FROM, MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 98D6928793 for ; Wed, 25 Apr 2018 16:26:20 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1755951AbeDYQZx (ORCPT ); Wed, 25 Apr 2018 12:25:53 -0400 Received: from mail-io0-f195.google.com ([209.85.223.195]:36338 "EHLO mail-io0-f195.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755474AbeDYQZs (ORCPT ); Wed, 25 Apr 2018 12:25:48 -0400 Received: by mail-io0-f195.google.com with SMTP id d73-v6so2151398iog.3; Wed, 25 Apr 2018 09:25:48 -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=6lJ+zBCVRFW3h8uLh6HvigmV7SM1YD3wMghcWKOBrjk=; b=DGnnb0QiylQb//h5vk2pbSXVekSjExBrkKXKOq/j95cponlsXRxzM5tEH4jbdLaiCw jqn7p4WvK3Wo+iASBEp6ya4rh17enVdOqZTVyu/gtjgWS4tTphIlcqpvt+u84rseLzAS WTgQuk9qmcHvDOWfBPrQDcDEQ3J6rdgvb90NPZecIyPy/o0iH8FZcUolxMCGEOThh+p8 LJu20/iyTxsMxZbKgUc4LNk6zLv7od/ogvHkEP6J0fe1sIKTzycfu60h++nRMK233zRG dEGe0g4ZHV7DDHHKyvbQe3hfWB/XkMSI5kdw+L+XhSsSuoxupChA0ZzisSMi+uIAxe0R ziZQ== 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=6lJ+zBCVRFW3h8uLh6HvigmV7SM1YD3wMghcWKOBrjk=; b=eSZECzcfF0Ge06i575JuzIbeH6xam3mgpcqA1kXdOWAcGpxglsWp2Y7aRGhuloLEAa P6v+uStSriXSz+1cwWrCLJcsR1Rd+bogCn5mUafAlK1YYPVNDS4SRbiIS8ju2nz8daDl sP58sfA6JBbb/z7ZP//qFIN/3UzRifcgjvTc+yFf74PJAHNysnnzlWIdd/ZQHNS9ri/m hbp6t3TlEc97mC50bF4D43BKNDQm8smkCY2BwXChv4JcddilOqig82FwQA5hoSN/rl1x vJKZt00QzBYhMeMyQ/q7s2m/6EPuQ6F4M+ZBfmLilrzrTLquXWEr/HGrW30nqXNSCkOE 34aA== X-Gm-Message-State: ALQs6tCbDk2YNVXEDL/EUcRQgWviH4J3D5aLz3P+cKZPaSrPyEreHxzv 8MuW4SChQDEzCX8Mo8nHRfBXg0nV2KE= X-Google-Smtp-Source: AB8JxZo9AvLBxp+nyLkbQuLIRsqKl3NK79Pp2qep4KOpK/Xf4v3z3cnzX9+Tjsy6PHGuIU7apSFCeg== X-Received: by 2002:a6b:1c06:: with SMTP id c6-v6mr8356809ioc.247.1524673547469; Wed, 25 Apr 2018 09:25:47 -0700 (PDT) Received: from localhost.localdomain (184-175-36-239.dsl.teksavvy.com. [184.175.36.239]) by smtp.gmail.com with ESMTPSA id 2-v6sm6795491itk.1.2018.04.25.09.25.46 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 25 Apr 2018 09:25:46 -0700 (PDT) From: Andres Rodriguez To: linux-kernel@vger.kernel.org Cc: andresx7@gmail.com, gregkh@linuxfoundation.org, mcgrof@kernel.org, alexdeucher@gmail.com, christian.koenig@amd.com, kvalo@codeaurora.org, arend.vanspriel@broadcom.com, linux-wireless@vger.kernel.org, ath10k@lists.infradead.org, hdegoede@redhat.com Subject: [PATCH 1/2] firmware: some documentation fixes Date: Wed, 25 Apr 2018 12:25:39 -0400 Message-Id: <20180425162540.11574-1-andresx7@gmail.com> X-Mailer: git-send-email 2.14.1 In-Reply-To: <20180425152617.GA5058@kroah.com> References: <20180425152617.GA5058@kroah.com> Sender: linux-wireless-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-wireless@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Including: - Fixup outdated kernel-doc paths - Slightly too short title underline - Some typos Signed-off-by: Andres Rodriguez --- Hey Greg, Here is the patch rebased on gregkh/driver-core-linus as requested. Note that there is a patch by Hans de Goede that contains some of the path fixes as well. I also included an extra patch to fix the htmldocs build. I think we are in time to squash the fix into the offending commit. Regards, Andres Documentation/driver-api/firmware/request_firmware.rst | 6 +++--- drivers/base/firmware_loader/fallback.c | 4 ++-- drivers/base/firmware_loader/fallback.h | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/driver-api/firmware/request_firmware.rst b/Documentation/driver-api/firmware/request_firmware.rst index 20f21ed427a5..d5ec95a7195b 100644 --- a/Documentation/driver-api/firmware/request_firmware.rst +++ b/Documentation/driver-api/firmware/request_firmware.rst @@ -50,11 +50,11 @@ 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_loader/main.c :functions: firmware_request_cache diff --git a/drivers/base/firmware_loader/fallback.c b/drivers/base/firmware_loader/fallback.c index 31b5015b59fe..358354148dec 100644 --- a/drivers/base/firmware_loader/fallback.c +++ b/drivers/base/firmware_loader/fallback.c @@ -537,8 +537,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. *