From mboxrd@z Thu Jan 1 00:00:00 1970 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 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=hUp9udmt; spf=pass (domain: redhat.com, ip: 205.139.110.61, mailfrom: philmd@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575308472; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=2WQxcS3VGHaliJ+SAyDdecU71wYYoi/0yvFgEpcpWSo=; b=hUp9udmt7P012DwpksSOaezb7w3B7u2Iz1VPi0O/Q/tqLLR32cTdqVwVWB2cQYJtkJaj90 n4G2yXCD00VJLlGLh9OPc3QLe2tZN3P1JqJZJJzj8qe2dAE8sx6aWtpJJqSk5i3TyFFVyD IuuDDyClDHc0jge/NNYFU0bdbX6J9v8= 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 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) 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: [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 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable 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