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 684B0C4332F for ; Mon, 17 Oct 2022 07:25:41 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id DBAA484F44; Mon, 17 Oct 2022 09:25:38 +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="wgbwrOct"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id B4BDC84F55; Mon, 17 Oct 2022 09:25:37 +0200 (CEST) Received: from mail-wr1-x42e.google.com (mail-wr1-x42e.google.com [IPv6:2a00:1450:4864:20::42e]) (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 DBA9084EED for ; Mon, 17 Oct 2022 09:25:34 +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-x42e.google.com with SMTP id j7so17096092wrr.3 for ; Mon, 17 Oct 2022 00:25:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=baylibre-com.20210112.gappssmtp.com; s=20210112; h=mime-version:message-id:date:references:in-reply-to:subject:cc:to :from:from:to:cc:subject:date:message-id:reply-to; bh=Zi8WOvz0z4IIB4iSztTRfGLSlgavSCkeIHH+tf1jsOI=; b=wgbwrOctV3kqebA2M3IAYWyr3979D+rUnDPIp0A1tp9I1uzKyYwXe3vjWoX+uapOwt JDXESPRhurGQZkAyrTbyFNhIAGz8XI8Es91TFtBZolnlGZQd8LnWrWOPhaRK/VT7/mGr OlSikN3ymVxl+FZag/fzn9Zbqaq0TZtTnGZ3k0mzCm4xwigkj+0qlZ7IrzbrTC6uSSON HuE/GV0AgSPSL0aUgNIF9MjYTLEGv6nIPcyok/mY4kMizPs66BvRVVXGZBDTPMtwglfU wTVc0sCWh7JWLWYVjh+Yxy71Qrdw6ZkvrSDA+3CTp6Gpaljju0D3x5Su80k+doN7u9x7 p1kw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:message-id:date:references:in-reply-to:subject:cc:to :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=Zi8WOvz0z4IIB4iSztTRfGLSlgavSCkeIHH+tf1jsOI=; b=unk/ImbNPp6CW4D38LyCP84e8oimzFwulNHhM45Kser2gvlWYZdx/I+78rIs/C2Q2c eMyLUckMmBD22mLJC960GM4N7IT1ZFDGhUA/KJVSBPz9YcWdclViWXxXRPUw1nNzlzJS AF1U8dX/TTGNufZ5IvWVFgIuTRFDdKA7r6G2t6PuRXmixciqCUBlyPyeyIXJZ+Awy0tO Qfx5IGCUyvmaaiXRb4IzkN3i5xCJfRmbtsriF3mFej3Wd0PwIJPm02j//ajCX8Oy+oI9 Ophwi+WV0Vcd96uQY5zzCkotmki1KO3WJIeT/yr458E6wx1MJVX0lgHRk3+lHldeWvGq nF2A== X-Gm-Message-State: ACrzQf3co80I0cRzhbMKmzM0XLBbNZ5TsHDlbD20pqrSxIM5ezBo/vxm +590OYB7BhHbNumbC0kS09omRtAOGucxmA== X-Google-Smtp-Source: AMsMyM4Q0NHvSpns639Yjt0vKSj/YvQ0xTsdbaxhQoJn9fG6/4b1bFhvECm0KKztpfQcmEj7MWoJ/Q== X-Received: by 2002:a5d:5b1f:0:b0:22e:51b0:2837 with SMTP id bx31-20020a5d5b1f000000b0022e51b02837mr5386777wrb.132.1665991534230; Mon, 17 Oct 2022 00:25:34 -0700 (PDT) Received: from localhost ([2a01:cb19:85e6:1900:46fa:44d1:4a76:769b]) by smtp.gmail.com with ESMTPSA id r3-20020a05600c158300b003c21ba7d7d6sm8994554wmf.44.2022.10.17.00.25.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 17 Oct 2022 00:25:33 -0700 (PDT) From: Mattijs Korpershoek To: Simon Glass Cc: u-boot@lists.denx.de, Heinrich Schuchardt Subject: Re: [PATCH] blk: fix a couple of trivial documentation typos In-Reply-To: References: <20221013-blk-doc-typos-v1-0-8031607c6a4c@baylibre.com> Date: Mon, 17 Oct 2022 09:25:32 +0200 Message-ID: <87pmeqc3o3.fsf@baylibre.com> MIME-Version: 1.0 Content-Type: text/plain 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 On ven., oct. 14, 2022 at 09:55, Simon Glass wrote: > Hi Mattijs, > > On Thu, 13 Oct 2022 at 06:57, Mattijs Korpershoek > wrote: >> >> 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 > > Actually it does not probe it, just returns it. Urgh. sorry about that. Thank you for your review. Will send a v2 without this hunk. > >> * @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 > > Regards, > Simon