From nobody Thu Apr 18 08:14:02 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) client-ip=66.175.222.12; envelope-from=bounce+27952+51553+1787277+3901457@groups.io; helo=web01.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+51553+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575308474; cv=none; d=zohomail.com; s=zohoarc; b=Gyb0c39sAQKD8zeDzoHsiMz0ZxK/guUUPaKvF0TjGOFs0ztKlpdvO/ad+L3MTAV9zuo6Fe0jqj6Sbh6cbeHwh6/xTsZg+dnn99SDeebhdKB33fd0x5b60fY/UsegHnTdZla5amcnAVJ+W7DcofAZnaWqO8Yp54UxqV+gDUwFW4A= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575308474; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=V20I6+aj+hcLTbN95YrEY+HO+HA4kE0a7UsJClD2k7w=; b=neHf8odj8TVG4Jkj/ddocpCfanZIGds9tt0Idtj6AP8iGwjwFjPYzciEizuTaYD+WngrtQk+T+oACzQ137Gtx7jIk8guHQst3E8CZ9mrhBzE8squP1MCxsvYImSk2jyVf8knh7F7nbRRgyI3bLQH99widoPLus3HydaQZpjSGIU= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+51553+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from web01.groups.io (web01.groups.io [66.175.222.12]) by mx.zohomail.com with SMTPS id 1575308474702590.5893264749545; Mon, 2 Dec 2019 09:41:14 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id aaaaYY1788612xaaaaaaaaaa; Mon, 02 Dec 2019 09:41:13 -0800 X-Received: from us-smtp-delivery-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.61]) by mx.groups.io with SMTP id smtpd.web09.4646.1575308473253798874 for ; Mon, 02 Dec 2019 09:41:13 -0800 X-Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-56-DXxnaEEiOVeiNiJffiBP-w-1; Mon, 02 Dec 2019 12:41:06 -0500 X-Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 1E6441183E16; Mon, 2 Dec 2019 17:41:05 +0000 (UTC) X-Received: from x1w.redhat.com (ovpn-204-21.brq.redhat.com [10.40.204.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 69B6F19C6A; Mon, 2 Dec 2019 17:41:02 +0000 (UTC) From: =?UTF-8?B?UGhpbGlwcGUgTWF0aGlldS1EYXVkw6k=?= To: devel@edk2.groups.io Cc: Ray Ni , Zhichao Gao , Philippe Mathieu-Daude Subject: [edk2-devel] [PATCH 2/2] ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER Date: Mon, 2 Dec 2019 18:40:51 +0100 Message-Id: <20191202174051.11062-3-philmd@redhat.com> In-Reply-To: <20191202174051.11062-1-philmd@redhat.com> References: <20191202174051.11062-1-philmd@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-MC-Unique: DXxnaEEiOVeiNiJffiBP-w-1 X-Mimecast-Spam-Score: 0 Precedence: Bulk List-Unsubscribe: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,philmd@redhat.com X-Gm-Message-State: aaaaaaaaaaaaaaaaaaaaaaaax1787277AA= Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1575308473; bh=jOAVw8UXXnQnC6glXgC/VsnwlyG/xwRG7lCvmYBNuV8=; h=Cc:Content-Type:Date:From:Reply-To:Subject:To; b=wszb/NjXkU05IgRAjVLTJijgFfqam6Z0hi6avq4P4/K1fo2mITnOoiFezirPmirZF7z tBDO7Uxs/paxbsmXBBqTnfSq9J+4uvjNJ3I6I5Kz75TFBULcDgOIVe2PaLrQmbNlVAFLA YUmJH7mJS0l+RC0bmH+M4wdwDuOzhT+Fuhw= X-ZohoMail-DKIM: pass (identity @groups.io) ShellParametersProtocol::UpdateArgcArgv() can return a EFI_INVALID_PARAMETER value. Document it. Signed-off-by: Philippe Mathieu-Daude --- ShellPkg/Application/Shell/ShellParametersProtocol.h | 1 + ShellPkg/Application/Shell/ShellParametersProtocol.c | 1 + 2 files changed, 2 insertions(+) diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.h b/ShellPk= g/Application/Shell/ShellParametersProtocol.h index da103086ab9a..721cb34f5835 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.h +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.h @@ -71,6 +71,7 @@ CleanUpShellParametersProtocol ( @param[out] OldArgc pointer to old number of items in = Argv list =20 @retval EFI_SUCCESS operation was sucessful, Argv and = Argc are valid + @return EFI_INVALID_PARAMETER some parameters are invalid @retval EFI_OUT_OF_RESOURCES a memory allocation failed. **/ EFI_STATUS diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.c b/ShellPk= g/Application/Shell/ShellParametersProtocol.c index 83fe4eda3fb8..4555a9639d95 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.c +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c @@ -1341,6 +1341,7 @@ RestoreStdInStdOutStdErr ( @param[out] OldArgc Pointer to old number of items in= Argv list. =20 @retval EFI_SUCCESS Operation was sucessful, Argv and = Argc are valid. + @return EFI_INVALID_PARAMETER Some parameters are invalid. @retval EFI_OUT_OF_RESOURCES A memory allocation failed. **/ EFI_STATUS --=20 2.21.0 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#51553): https://edk2.groups.io/g/devel/message/51553 Mute This Topic: https://groups.io/mt/65090011/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-