From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-1.mimecast.com (us-smtp-1.mimecast.com [205.139.110.120]) by mx.groups.io with SMTP id smtpd.web10.10093.1576764587758410655 for ; Thu, 19 Dec 2019 06:09:48 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=W48oiDje; spf=pass (domain: redhat.com, ip: 205.139.110.120, mailfrom: philmd@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1576764586; 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=4zY/pei76vT41UQ7JA8Zy84+uFrvUvSBHs5IuUF3ujo=; b=W48oiDjem3BTBJG1hHVRVapFoDSe5rg7SZsAkdGO/CBV9xP93Spbn9OZRlHIz7QnjH7Fs0 zqPjL0gOAI4gAEGXf4O0DNV9MhZ8g+uN6L1EUmNhHDaHcK4YRNY5l0KEkdOB7HuM3jpaE6 L8dbk7Lj9T0XW7tpMVbpZCPBR8kLw4o= 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-134-VGPUbdHmN-KHKBOFkApJLA-1; Thu, 19 Dec 2019 09:09:44 -0500 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id C956D100550E; Thu, 19 Dec 2019 14:09:43 +0000 (UTC) Received: from x1w.redhat.com (unknown [10.36.118.122]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 0BE175C3FA; Thu, 19 Dec 2019 14:09:41 +0000 (UTC) From: =?UTF-8?B?UGhpbGlwcGUgTWF0aGlldS1EYXVkw6k=?= To: devel@edk2.groups.io Cc: Ray Ni , Zhichao Gao , Philippe Mathieu-Daude Subject: [PATCH v2 2/2] ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER Date: Thu, 19 Dec 2019 15:09:32 +0100 Message-Id: <20191219140932.25428-3-philmd@redhat.com> In-Reply-To: <20191219140932.25428-1-philmd@redhat.com> References: <20191219140932.25428-1-philmd@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-MC-Unique: VGPUbdHmN-KHKBOFkApJLA-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. Reviewed-by: Zhichao Gao 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