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.9772.1576764587189731204 for ; Thu, 19 Dec 2019 06:09:47 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=MYZFLsyT; 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=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=yJkj2iZ74tkFbHXT3LZ1iNuVzvEnXK+g4U9fv+Co/1A=; b=MYZFLsyTjzD/un94JinOqkb0O2/orr4FtpzDPgElo2iJorbIc3qLf3KMWu7IK34OCw0pN4 HaZWpeLqdyUE7CPUDyVHSNfwsIE/NWc5NjyHzShTDSRUYFLNemo1mo0yU9cjex4fhFPpIc 8R4mM4cah3wlUWhg+L6oNhsD1yeQ9Bk= 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-98-r066dXewPDG0XWsWM6UeDw-1; Thu, 19 Dec 2019 09:09:42 -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 A3ABFDB61; Thu, 19 Dec 2019 14:09:41 +0000 (UTC) Received: from x1w.redhat.com (unknown [10.36.118.122]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 1E7315C54A; Thu, 19 Dec 2019 14:09:39 +0000 (UTC) From: =?UTF-8?B?UGhpbGlwcGUgTWF0aGlldS1EYXVkw6k=?= To: devel@edk2.groups.io Cc: Ray Ni , Zhichao Gao , Philippe Mathieu-Daude Subject: [PATCH v2 1/2] ShellPkg: Document ParseCommandLineToArgs returns EFI_INVALID_PARAMETER Date: Thu, 19 Dec 2019 15:09:31 +0100 Message-Id: <20191219140932.25428-2-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: r066dXewPDG0XWsWM6UeDw-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable ShellParametersProtocol::ParseCommandLineToArgs() 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 df0316a03091..da103086ab9a 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.h +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.h @@ -167,6 +167,7 @@ RestoreStdInStdOutStdErr ( @param[in, out] Argc pointer to number of strings in Argv arr= ay =20 @return EFI_SUCCESS the operation was sucessful + @return EFI_INVALID_PARAMETER some parameters are invalid @return 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 bcd8f0ae2112..83fe4eda3fb8 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.c +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c @@ -185,6 +185,7 @@ DEBUG_CODE_END(); @param[in, out] Argc pointer to number of strings in Argv arr= ay =20 @return EFI_SUCCESS the operation was sucessful + @return EFI_INVALID_PARAMETER some parameters are invalid @return EFI_OUT_OF_RESOURCES a memory allocation failed. **/ EFI_STATUS --=20 2.21.0