From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 4A2C0C433FE for ; Thu, 13 Oct 2022 12:57:27 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id EB62C84F2E; Thu, 13 Oct 2022 14:57:24 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=baylibre.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=baylibre-com.20210112.gappssmtp.com header.i=@baylibre-com.20210112.gappssmtp.com header.b="Lq+1CoEu"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 9576184F33; Thu, 13 Oct 2022 14:57:23 +0200 (CEST) Received: from mail-wr1-x435.google.com (mail-wr1-x435.google.com [IPv6:2a00:1450:4864:20::435]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id D9C5A84F27 for ; Thu, 13 Oct 2022 14:57:20 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=baylibre.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=mkorpershoek@baylibre.com Received: by mail-wr1-x435.google.com with SMTP id bv10so2707426wrb.4 for ; Thu, 13 Oct 2022 05:57:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=baylibre-com.20210112.gappssmtp.com; s=20210112; h=cc:to:message-id:content-transfer-encoding:mime-version:subject :date:from:from:to:cc:subject:date:message-id:reply-to; bh=0ambD4UTV38Kh6oag6/a9ShLm62tYgnnpv/NnZbp47s=; b=Lq+1CoEuEGjpq0eeWeYWCYBxBj9ujQu3kJYiysvYFaVW+dF6LLH6MeEXvIBpAiI0Bu JIqIUDw24+EOH3RQDbjyN5eM2onZ4iuKqxJZsw7Er/rg9P1AasJ7WNaYCwsneQURKfXX EzTCYbjwk+NJ6jGycrS0LZL9g07oHSCLfz0dgInjPxQbxo0WEwNW15lJDcpX9n3+iiu4 N8kwYrOEnqDMgPK4RDjUq1DzC3/v1B00pUsMa/0LETB6EsBJ3bAyhpPZ7GnCXqagYti7 +gfuhRDe/EbfLiEvGbGtks9Zl0JhYKNc2agEZc94K5F9kZiJIhrK9dS9YHosAx/iRNjj 8AvA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:message-id:content-transfer-encoding:mime-version:subject :date:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=0ambD4UTV38Kh6oag6/a9ShLm62tYgnnpv/NnZbp47s=; b=AWRqzZSfmkhdqZgCtzZtV1WnZCMohYsb+nAYXuzvtaRqNIhv15xdUpDpejH7Kcqm/M RJKtgWPnHuj2m36Dr2iPQDTtguqbRSO1JkKm19i8ld6VcvRSgM0xZ/EgkQHCcT0Y3mVR e0Sjs0H6RIxOxlWdC8KFIJKOg1d5jSuNi+2NGYfU4UUT0iofwg4zrMZ1/WvVGTLDN63g io3C/qoCCwIRedDSBeLodsg+E8oPkvUFpak+VWiYRwgS6CuMVINCcJcNotWs0xeG3ld+ TxchwCrMmgDPmHAzHmrfJOX8SLYwGL/RQj39SFCL1erXdA8Onm/sxnlAjhgcxW048xE9 XokQ== X-Gm-Message-State: ACrzQf1P4wKFY3rTXLqwxVSRPBxBsDT+3dAxU0CMoGArAiPSnSrnL+ju te/uhbKcPcr8tQqncaYP82DmdWFTxdyrSA== X-Google-Smtp-Source: AMsMyM6e4DSrl96w9EG9EoLaZPDYYCd0aYX7pyFEET3AtbfHMSm23jYVSeDD5XtsPFUFMhg/0udgfA== X-Received: by 2002:adf:dfc1:0:b0:22f:edf7:b11b with SMTP id q1-20020adfdfc1000000b0022fedf7b11bmr14798765wrn.583.1665665840282; Thu, 13 Oct 2022 05:57:20 -0700 (PDT) Received: from [192.168.2.252] ([82.66.159.240]) by smtp.gmail.com with ESMTPSA id t2-20020adfe442000000b0021badf3cb26sm2382217wrm.63.2022.10.13.05.57.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Oct 2022 05:57:19 -0700 (PDT) From: Mattijs Korpershoek Date: Thu, 13 Oct 2022 14:57:13 +0200 Subject: [PATCH] blk: fix a couple of trivial documentation typos MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit Message-Id: <20221013-blk-doc-typos-v1-0-8031607c6a4c@baylibre.com> To: Simon Glass Cc: u-boot@lists.denx.de, Heinrich Schuchardt , Mattijs Korpershoek X-Mailer: b4 0.11.0-dev-5166b X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.6 at phobos.denx.de X-Virus-Status: Clean In some cases, the param variable is wrong, and in other cases we have undocumented arguments. Fix the docs. Signed-off-by: Mattijs Korpershoek --- --- include/blk.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/include/blk.h b/include/blk.h index 8806c382d4e7..f71ce990acf8 100644 --- a/include/blk.h +++ b/include/blk.h @@ -119,7 +119,7 @@ int blkcache_init(void); * @param start - starting block number * @param blkcnt - number of blocks to read * @param blksz - size in bytes of each block - * @param buf - buffer to contain cached data + * @param buffer - buffer to contain cached data * * Return: - 1 if block returned from cache, 0 otherwise. */ @@ -136,7 +136,7 @@ int blkcache_read(int iftype, int dev, * @param start - starting block number * @param blkcnt - number of blocks available * @param blksz - size in bytes of each block - * @param buf - buffer containing data to cache + * @param buffer - buffer containing data to cache * */ void blkcache_fill(int iftype, int dev, @@ -250,7 +250,7 @@ struct blk_ops { * The MMC standard provides for two boot partitions (numbered 1 and 2), * rpmb (3), and up to 4 addition general-purpose partitions (4-7). * - * @desc: Block device to update + * @dev: Block device to update * @hwpart: Hardware partition number to select. 0 means the raw * device, 1 is the first partition, 2 is the second, etc. * @return 0 if OK, -ve on error @@ -642,6 +642,7 @@ int blk_print_part_devnum(enum uclass_id uclass_id, int devnum); * * @uclass_id: Block device type * @devnum: Device number + * @start: Start block number to read (0=first) * @blkcnt: Number of blocks to read * @buffer: Address to write data to * Return: number of blocks read, or -ve error number on error @@ -654,6 +655,7 @@ ulong blk_read_devnum(enum uclass_id uclass_id, int devnum, lbaint_t start, * * @uclass_id: Block device type * @devnum: Device number + * @start: Start block number to write (0=first) * @blkcnt: Number of blocks to write * @buffer: Address to read data from * Return: number of blocks written, or -ve error number on error @@ -776,7 +778,7 @@ int blk_find_next(enum blk_flag_t flags, struct udevice **devp); * a uclass in order from start to end. Devices are probed if necessary, * and ready for use. * - * @flags: Indicates type of device to return + * @flags: Indicates type of device to probe * @dev: struct udevice * to hold the current device. Set to NULL when there * are no more devices. */ --- base-commit: 0e49f5c26caf9972137a474065afd4bdfe5ec062 change-id: 20221013-blk-doc-typos-de90e92ccd6b Best regards, -- Mattijs Korpershoek