Standardize the --version and --help text command-line options Updated tools to correctly display the Build number when using command-line option --version and exit successfully after termination. Ecc was also updated to print informational messages after the options are parsed.
Cc: Zhu Yonghong <[email protected]> Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Larry Hauch <[email protected]> Reviewed-by: Reviewer Name <[email protected]> --- BaseTools/Source/C/BootSectImage/bootsectimage.c | 14 ++++++------ BaseTools/Source/C/EfiLdrImage/EfiLdrImage.c | 17 ++++++++------- BaseTools/Source/C/Split/Split.c | 14 ++++++------ BaseTools/Source/C/VfrCompile/VfrCompiler.cpp | 8 +++---- BaseTools/Source/C/VfrCompile/VfrCompiler.h | 4 ++-- BaseTools/Source/C/VolInfo/VolInfo.c | 26 ++++++++++++++--------- BaseTools/Source/Python/BPDG/BPDG.py | 6 +++--- BaseTools/Source/Python/BPDG/StringTable.py | 14 ++++++------ BaseTools/Source/Python/Ecc/Ecc.py | 11 +++++----- BaseTools/Source/Python/UPT/Logger/StringTable.py | 6 +++--- BaseTools/Source/Python/UPT/UPT.py | 4 ++-- 11 files changed, 65 insertions(+), 59 deletions(-) diff --git a/BaseTools/Source/C/BootSectImage/bootsectimage.c b/BaseTools/Source/C/BootSectImage/bootsectimage.c index b4fb340..4f876ae 100644 --- a/BaseTools/Source/C/BootSectImage/bootsectimage.c +++ b/BaseTools/Source/C/BootSectImage/bootsectimage.c @@ -4,7 +4,7 @@ Abstract: Patch the BPB information in boot sector image file. Patch the MBR code in MBR image file. -Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR> +Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -33,8 +33,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. // // Utility version information // -#define UTILITY_MAJOR_VERSION 0 -#define UTILITY_MINOR_VERSION 1 +#define UTILITY_MAJOR_VERSION 1 +#define UTILITY_MINOR_VERSION 0 void Version ( @@ -56,10 +56,7 @@ Returns: --*/ { - printf ("%s Version %d.%d %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION); - printf ("Copyright (c) 1999-2014 Intel Corporation. All rights reserved.\n"); - printf ("\n The BootSectImage tool prints information or patch destination file by source\n"); - printf (" file for BIOS Parameter Block (BPB) or Master Boot Record (MBR).\n"); + printf ("%s Version %d.%d Build %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION); } void @@ -82,6 +79,9 @@ Returns: --*/ { Version(); + printf ("Copyright (c) 1999-2016 Intel Corporation. All rights reserved.\n"); + printf ("\n The BootSectImage tool prints information or patch destination file by source\n"); + printf (" file for BIOS Parameter Block (BPB) or Master Boot Record (MBR).\n"); printf ("\nUsage: \n\ BootSectImage\n\ [-f, --force force patch even if the FAT type of SrcImage and DstImage mismatch]\n\ diff --git a/BaseTools/Source/C/EfiLdrImage/EfiLdrImage.c b/BaseTools/Source/C/EfiLdrImage/EfiLdrImage.c index 31d697e..88cc345 100644 --- a/BaseTools/Source/C/EfiLdrImage/EfiLdrImage.c +++ b/BaseTools/Source/C/EfiLdrImage/EfiLdrImage.c @@ -6,7 +6,7 @@ FILE := EFILDR_HEADER <PeImageFileContent> + The order of EFILDR_IMAGE is same as the order of placing PeImageFileContent. -Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR> +Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -51,8 +51,8 @@ typedef struct { // // Utility version information // -#define UTILITY_MAJOR_VERSION 0 -#define UTILITY_MINOR_VERSION 1 +#define UTILITY_MAJOR_VERSION 1 +#define UTILITY_MINOR_VERSION 0 void Version ( @@ -74,9 +74,8 @@ Returns: --*/ { - printf ("%s Version %d.%d %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION); - printf ("Copyright (c) 1999-2014 Intel Corporation. All rights reserved.\n"); - printf ("\n The EfiLdrImage tool is used to combine PE files into EFILDR image with Efi loader header.\n"); + printf ("%s Version %d.%d Build %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION); + exit (0); } VOID @@ -85,7 +84,9 @@ Usage ( ) { printf ("Usage: EfiLdrImage -o OutImage LoaderImage PeImage1 PeImage2 ... PeImageN\n"); - exit (1); + printf ("%s Version %d.%d Build %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION); + printf ("Copyright (c) 1999-2016 Intel Corporation. All rights reserved.\n"); + printf ("\n The EfiLdrImage tool is used to combine PE files into EFILDR image with Efi loader header.\n"); } EFI_STATUS @@ -180,7 +181,7 @@ Returns: SetUtilityName (UTILITY_NAME); if (argc == 1) { - Usage(); + printf ("Usage: EfiLdrImage -o OutImage LoaderImage PeImage1 PeImage2 ... PeImageN\n"); return STATUS_ERROR; } diff --git a/BaseTools/Source/C/Split/Split.c b/BaseTools/Source/C/Split/Split.c index 44a0968..c6f547c 100644 --- a/BaseTools/Source/C/Split/Split.c +++ b/BaseTools/Source/C/Split/Split.c @@ -2,7 +2,7 @@ Split a file into two pieces at the request offset. -Copyright (c) 1999 - 2015, Intel Corporation. All rights reserved.<BR> +Copyright (c) 1999 - 2016, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -34,8 +34,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. // // Utility version information // -#define UTILITY_MAJOR_VERSION 0 -#define UTILITY_MINOR_VERSION 1 +#define UTILITY_MAJOR_VERSION 1 +#define UTILITY_MINOR_VERSION 0 void Version ( @@ -57,10 +57,7 @@ Returns: --*/ { - printf ("%s Version %d.%d %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION); - printf ("Copyright (c) 1999-2015 Intel Corporation. All rights reserved.\n"); - printf ("\n SplitFile creates two Binary files either in the same directory as the current working\n"); - printf (" directory or in the specified directory.\n"); + printf ("%s Version %d.%d Build %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION); } void @@ -83,6 +80,9 @@ Returns: --*/ { Version(); + printf ("Copyright (c) 1999-2016 Intel Corporation. All rights reserved.\n"); + printf ("\n SplitFile creates two Binary files either in the same directory as the current working\n"); + printf (" directory or in the specified directory.\n"); printf ("\nUsage: \n\ Split\n\ -f, --filename inputFile to split\n\ diff --git a/BaseTools/Source/C/VfrCompile/VfrCompiler.cpp b/BaseTools/Source/C/VfrCompile/VfrCompiler.cpp index 063266a..695ce6c 100644 --- a/BaseTools/Source/C/VfrCompile/VfrCompiler.cpp +++ b/BaseTools/Source/C/VfrCompile/VfrCompiler.cpp @@ -2,7 +2,7 @@ VfrCompiler main class and main function. -Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR> +Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -412,8 +412,8 @@ CVfrCompiler::Usage ( UINT32 Index; CONST CHAR8 *Help[] = { " ", - "VfrCompile version " VFR_COMPILER_VERSION __BUILD_VERSION, - "Copyright (c) 2004-2014 Intel Corporation. All rights reserved.", + "VfrCompile version " VFR_COMPILER_VERSION "Build " __BUILD_VERSION, + "Copyright (c) 2004-2016 Intel Corporation. All rights reserved.", " ", "Usage: VfrCompile [options] VfrFile", " ", @@ -451,7 +451,7 @@ CVfrCompiler::Version ( { UINT32 Index; CONST CHAR8 *Help[] = { - "VfrCompile version " VFR_COMPILER_VERSION __BUILD_VERSION, + "VfrCompile version " VFR_COMPILER_VERSION "Build " __BUILD_VERSION, NULL }; for (Index = 0; Help[Index] != NULL; Index++) { diff --git a/BaseTools/Source/C/VfrCompile/VfrCompiler.h b/BaseTools/Source/C/VfrCompile/VfrCompiler.h index 6a6779c..f2d9814 100644 --- a/BaseTools/Source/C/VfrCompile/VfrCompiler.h +++ b/BaseTools/Source/C/VfrCompile/VfrCompiler.h @@ -2,7 +2,7 @@ VfrCompiler internal defintions. -Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR> +Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -23,7 +23,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include "ParseInf.h" #define PROGRAM_NAME "VfrCompile" -#define VFR_COMPILER_VERSION " 2.00 (UEFI 2.4) " +#define VFR_COMPILER_VERSION " 2.01 (UEFI 2.4) " // // This is how we invoke the C preprocessor on the VFR source file // to resolve #defines, #includes, etc. To make C source files diff --git a/BaseTools/Source/C/VolInfo/VolInfo.c b/BaseTools/Source/C/VolInfo/VolInfo.c index 87e78d4..43794ca 100644 --- a/BaseTools/Source/C/VolInfo/VolInfo.c +++ b/BaseTools/Source/C/VolInfo/VolInfo.c @@ -1,7 +1,7 @@ /** @file The tool dumps the contents of a firmware volume -Copyright (c) 1999 - 2015, Intel Corporation. All rights reserved.<BR> +Copyright (c) 1999 - 2016, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -46,8 +46,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. EFI_GUID gEfiCrc32GuidedSectionExtractionProtocolGuid = EFI_CRC32_GUIDED_SECTION_EXTRACTION_PROTOCOL_GUID; -#define UTILITY_MAJOR_VERSION 0 -#define UTILITY_MINOR_VERSION 83 +#define UTILITY_MAJOR_VERSION 1 +#define UTILITY_MINOR_VERSION 0 #define UTILITY_NAME "VolInfo" @@ -168,12 +168,11 @@ Returns: // // Print utility header // - printf ("%s Version %d.%d %s, %s\n", + printf ("%s Version %d.%d Build %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, - __BUILD_VERSION, - __DATE__ + __BUILD_VERSION ); // @@ -231,7 +230,7 @@ Returns: // if (argc != 1) { Usage (); - return -1; + return STATUS_ERROR; } // // Look for help options @@ -239,9 +238,14 @@ Returns: if ((strcmp(argv[0], "-h") == 0) || (strcmp(argv[0], "--help") == 0) || (strcmp(argv[0], "-?") == 0) || (strcmp(argv[0], "/?") == 0)) { Usage(); - return STATUS_ERROR; + return STATUS_SUCCESS; + } + // + // Version has already been printed, return success. + // + if (strcmp(argv[0], "--version") == 0) { + return STATUS_SUCCESS; } - // // Open the file containing the FV // @@ -1846,7 +1850,7 @@ Returns: // // Copyright declaration // - fprintf (stdout, "Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.\n\n"); + fprintf (stdout, "Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.\n\n"); fprintf (stdout, " Display Tiano Firmware Volume FFS image information\n\n"); // @@ -1857,6 +1861,8 @@ Returns: Parse basename to file-guid cross reference file(s).\n"); fprintf (stdout, " --offset offset\n\ Offset of file to start processing FV at.\n"); + fprintf (stdout, " --version\n\ + Display version of this tool and exit.\n"); fprintf (stdout, " -h, --help\n\ Show this help message and exit.\n"); diff --git a/BaseTools/Source/Python/BPDG/BPDG.py b/BaseTools/Source/Python/BPDG/BPDG.py index b124031..b1e328f 100644 --- a/BaseTools/Source/Python/BPDG/BPDG.py +++ b/BaseTools/Source/Python/BPDG/BPDG.py @@ -6,7 +6,7 @@ # file of PCD layout for use during the build when the platform integrator selects to use # automatic offset calculation. # -# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR> +# Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR> # # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License @@ -33,7 +33,7 @@ import StringTable as st import GenVpd PROJECT_NAME = st.LBL_BPDG_LONG_UNI -VERSION = (st.LBL_BPDG_VERSION + " " + gBUILD_VERSION) +VERSION = (st.LBL_BPDG_VERSION + " Build " + gBUILD_VERSION) ## Tool entrance method # @@ -91,7 +91,7 @@ def MyOptionParser(): # # Process command line firstly. # - parser = OptionParser(version="%s - Version %s\n" % (PROJECT_NAME, VERSION), + parser = OptionParser(version="%s - Version %s" % (PROJECT_NAME, VERSION), description='', prog='BPDG', usage=st.LBL_BPDG_USAGE diff --git a/BaseTools/Source/Python/BPDG/StringTable.py b/BaseTools/Source/Python/BPDG/StringTable.py index a661da0..bbcb451 100644 --- a/BaseTools/Source/Python/BPDG/StringTable.py +++ b/BaseTools/Source/Python/BPDG/StringTable.py @@ -1,7 +1,7 @@ ## @file # This file is used to define strings used in the BPDG tool # -# Copyright (c) 2010, Intel Corporation. All rights reserved.<BR> +# Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR> # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License # which accompanies this distribution. The full text of the license may be found at @@ -32,7 +32,7 @@ MAP_FILE_COMMENT_TEMPLATE = \ # # This file lists all VPD informations for a platform fixed/adjusted by BPDG tool. # -# Copyright (c) 2010, Intel Corporation. All rights reserved.<BR> +# Copyright (c) 2010 -2016, Intel Corporation. All rights reserved.<BR> # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License # which accompanies this distribution. The full text of the license may be found at @@ -46,14 +46,14 @@ MAP_FILE_COMMENT_TEMPLATE = \ LBL_BPDG_LONG_UNI = (u"Intel(r) Binary Product Data Generation Tool (Intel(r) BPDG)") -LBL_BPDG_VERSION = (u"0.1") +LBL_BPDG_VERSION = (u"1.0") LBL_BPDG_USAGE = \ ( -""" -BPDG options -o Filename.bin -m Filename.map Filename.txt -Intel(r) Binary Product Data Generation Tool (Intel(r) BPDG) -Copyright (c) 2010 Intel Corporation All Rights Reserved. +"""BPDG options -o Filename.bin -m Filename.map Filename.txt +Copyright (c) 2010 - 2016, Intel Corporation All Rights Reserved. + Intel(r) Binary Product Data Generation Tool (Intel(r) BPDG) + Required Flags: -o BIN_FILENAME, --vpd-filename=BIN_FILENAME Specify the file name for the VPD binary file diff --git a/BaseTools/Source/Python/Ecc/Ecc.py b/BaseTools/Source/Python/Ecc/Ecc.py index c2ad4fa..94f9a42 100644 --- a/BaseTools/Source/Python/Ecc/Ecc.py +++ b/BaseTools/Source/Python/Ecc/Ecc.py @@ -1,7 +1,7 @@ ## @file # This file is used to be the main entrance of ECC tool # -# Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR> +# Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR> # This program and the accompanying materials # are licensed and made available under the terms and conditions of the BSD License # which accompanies this distribution. The full text of the license may be found at @@ -49,9 +49,9 @@ from Common.MultipleWorkspace import MultipleWorkspace as mws class Ecc(object): def __init__(self): # Version and Copyright - self.VersionNumber = ("0.01" + " " + gBUILD_VERSION) + self.VersionNumber = ("1.0" + " Build " + gBUILD_VERSION) self.Version = "%prog Version " + self.VersionNumber - self.Copyright = "Copyright (c) 2009 - 2010, Intel Corporation All rights reserved." + self.Copyright = "Copyright (c) 2009 - 2016, Intel Corporation All rights reserved." self.InitDefaultConfigIni() self.OutputFile = 'output.txt' @@ -65,6 +65,7 @@ class Ecc(object): # Parse the options and args self.ParseOption() + EdkLogger.info(time.strftime("%H:%M:%S, %b.%d %Y ", time.localtime()) + "[00:00]" + "\n") # # Check EFI_SOURCE (Edk build convention). EDK_SOURCE will always point to ECP @@ -104,7 +105,7 @@ class Ecc(object): GlobalData.gGlobalDefines["EDK_SOURCE"] = EdkSourceDir GlobalData.gGlobalDefines["ECP_SOURCE"] = EcpSourceDir - + EdkLogger.info("Loading ECC configuration ... done") # Generate checkpoints list EccGlobalData.gConfig = Configuration(self.ConfigFile) @@ -327,7 +328,6 @@ class Ecc(object): # Parse options # def ParseOption(self): - EdkLogger.quiet("Loading ECC configuration ... done") (Options, Target) = self.EccOptionParser() if Options.Workspace: @@ -437,7 +437,6 @@ if __name__ == '__main__': # Initialize log system EdkLogger.Initialize() EdkLogger.IsRaiseError = False - EdkLogger.quiet(time.strftime("%H:%M:%S, %b.%d %Y ", time.localtime()) + "[00:00]" + "\n") StartTime = time.clock() Ecc = Ecc() diff --git a/BaseTools/Source/Python/UPT/Logger/StringTable.py b/BaseTools/Source/Python/UPT/Logger/StringTable.py index 69e36f3..0d4d263 100644 --- a/BaseTools/Source/Python/UPT/Logger/StringTable.py +++ b/BaseTools/Source/Python/UPT/Logger/StringTable.py @@ -1,7 +1,7 @@ ## @file # This file is used to define strings used in the UPT tool # -# Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR> +# Copyright (c) 2011 - 2016, Intel Corporation. All rights reserved.<BR> # # This program and the accompanying materials are licensed and made available # under the terms and conditions of the BSD License which accompanies this @@ -39,10 +39,10 @@ MSG_USAGE_STRING = _("\n" ## # Version and Copyright # -MSG_VERSION_NUMBER = _("1.0") +MSG_VERSION_NUMBER = _("1.1") MSG_VERSION = _("UEFI Packaging Tool (UEFIPT) - Revision " + \ MSG_VERSION_NUMBER) -MSG_COPYRIGHT = _("Copyright (c) 2011 - 2015 Intel Corporation All Rights Reserved.") +MSG_COPYRIGHT = _("Copyright (c) 2011 - 2016 Intel Corporation All Rights Reserved.") MSG_VERSION_COPYRIGHT = _("\n %s\n %s" % (MSG_VERSION, MSG_COPYRIGHT)) MSG_USAGE = _("%s [options]\n%s" % ("UPT", MSG_VERSION_COPYRIGHT)) MSG_DESCRIPTION = _("The UEFIPT is used to create, " + \ diff --git a/BaseTools/Source/Python/UPT/UPT.py b/BaseTools/Source/Python/UPT/UPT.py index 17decda..59c4a88 100644 --- a/BaseTools/Source/Python/UPT/UPT.py +++ b/BaseTools/Source/Python/UPT/UPT.py @@ -2,7 +2,7 @@ # # This file is the main entry for UPT # -# Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR> +# Copyright (c) 2011 - 2016, Intel Corporation. All rights reserved.<BR> # # This program and the accompanying materials are licensed and made available # under the terms and conditions of the BSD License which accompanies this @@ -99,7 +99,7 @@ def SetLogLevel(Opt): def Main(): Logger.Initialize() - Parser = OptionParser(version=(MSG_VERSION + ' ' + gBUILD_VERSION), description=MSG_DESCRIPTION, + Parser = OptionParser(version=(MSG_VERSION + ' Build ' + gBUILD_VERSION), description=MSG_DESCRIPTION, prog="UPT.exe", usage=MSG_USAGE) Parser.add_option("-d", "--debug", action="store", type="int", dest="debug_level", help=ST.HLP_PRINT_DEBUG_INFO) -- 2.6.4.windows.1 _______________________________________________ edk2-devel mailing list [email protected] https://lists.01.org/mailman/listinfo/edk2-devel
