Add DEBUG() macros for DEBUG_CACHE to MTRR Library show all changes memory caches...

[mirror_edk2.git] / BaseTools / UserManuals / GenDepex_Utility_Man_Page.rtf

{\rtf1\ansi\ansicpg1252\deff0\deflang1033\deflangfe2052\deftab360{\fonttbl{\f0\fswiss\fprq2\fcharset0 Verdana;}{\f1\froman\fprq2\fcharset0 Times New Roman;}{\f2\fswiss\fprq2\fcharset0 Arial;}}\r
{\colortbl ;\red8\green96\blue168;\red0\green0\blue0;}\r
{\stylesheet{ Normal;}{\s1 heading 1;}{\s2 heading 2;}}\r
{\*\generator Msftedit 5.41.15.1515;}\viewkind4\uc1\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Name\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 GenDepex.exe or GenDepex.py \endash  Convert the dependency string of file to the binary PI dependency expression. \f1\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Synopsis\par\r
\pard\nowidctlpar\sb200\cf2\fs18 GenDepex.exe [options] [dependency_expression_file]\f1\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\f0\fs28 Description\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 GenDepex tool parses the input dependency expression string or the preprocessed dxs file to generate the binary PI dependency expression according to their module type. For PEIM module type, the PEI dependency expression will be generated. For DXE_DRIVER, UEFI_DRIVER, DXE_RUNTIME_DRIVER, DXE_SAL_DRIVER and DXE_SMM_DRIVER, the DXE dependency expression will be generated.\f1\par\r
\f0 GenDepex tool is not a standalone tool. When [depex] section is specified in module INF, it will be used together by Build tool. Build tool first parses the content in [depex] section to create the dependency expression string, then GenDepex will parse the generated string. When [depex] section is not specified, but File.dxs file exist, GenDepex tool will be used together with Compiler and EDKII trim too. The File.dxs first is preprocessed by Compiler, then processed by trim tool to remove all other code except for dependency content, last GenPepex will process the preprocessed dependency file.\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 Options\par\r
\pard\nowidctlpar\sb200\cf2\fs18 dependency_expression_file\f1\par\r
\pard\nowidctlpar\li360\sb200\b0\f0 Specify the name of the preprocessed dxs file to be parsed into the binary PI dependency expression.\f1\par\r
\pard\nowidctlpar\sb200\b\f0 -o FILE, --output=FILE\par\r
\pard\nowidctlpar\li360\sb200\b0 Specify the name of depex file that contains the generated binary PI dependency expression.\f1\par\r
\pard\nowidctlpar\sb200\b\f0 -t MODULETYPE, --module-type=MODULETYPE\par\r
\pard\nowidctlpar\li360\sb200\b0 The type of module is for which the dependency expression serves. Only EDKII module type is supported.\f1\par\r
\pard\nowidctlpar\sb200\b\f0 -e EXPRESSION, --dependency-expression=EXPRESSION\par\r
\pard\nowidctlpar\li360\sb200\b0 The option value is the string of dependency expression. If this option presents, the input file will be ignored.\par\r
\pard\nowidctlpar\sb200\b -m, --optimize\f1\par\r
\pard\nowidctlpar\fi360\sb200\b0\f0 Do some simple optimization on the expression to remove the duplicated guid.\f1\par\r
\pard\nowidctlpar\sb200\b\f0 -v, --verbose\f1\par\r
\b0\f0  \tab Run with verbose information.\f1\par\r
\b\f0 -d DEBUG, --debug=DEBUG [0-9]\f1\par\r
\pard\nowidctlpar\fi360\sb200\b0\f0 Enable debug messages at specified level.\par\r
\pard\nowidctlpar\sb200\b -q, --quiet\f1\par\r
\pard\nowidctlpar\fi360\sb200\b0\f0 Run with little information in quiet mode.\f1\par\r
\pard\nowidctlpar\sb200\b\f0 --version\f1\par\r
\pard\nowidctlpar\fi360\sb200\b0\f0 Show program's version number and exit\par\r
\pard\nowidctlpar\sb200\b -h, --help\par\r
\pard\nowidctlpar\li360\sb200\b0 Show this help message and exit\f1\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Example\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 1. Parse the input dependency string based on DXE_DRIVER module type to generate the binary PI dependency expression into the output test.depex file.  \par\r
\b GenDepex.exe -o test.depex -t DXE_DRIVER -e "\{ 0x26baccb2, 0x6f42, 0x11d4, \{0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81\} \f1\}\f0  AND \{ 0xf617b358, 0x12cf, 0x414a, 0xa0, 0x69, 0x60, 0x67, 0x7b, 0xda, 0x13, 0xb3 \} END"\par\r
\b0 2. Parse the input dependency string based on DXE_DRIVER module type to generate the binary PI dependency expression into the output test.depex file in the optimization mode.\f1\par\r
\b\f0 GenDepex -o test.depex -t DXE_DRIVER -e "\{ 0x26baccb2, 0x6f42, 0x11d4, \{0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81\} \} AND \{ 0x26baccb2, 0x6f42, 0x11d4, \{0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81\} \} END" -m\f1\par\r
\b0\f0 Same to \par\r
\b GenDepex -o test.depex -t DXE_DRIVER -e "\{ 0x26baccb2, 0x6f42, 0x11d4, \{0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81\} \} END"\par\r
\b0 3. Parse the input preprocessed dependency file (test.iii) based on DXE_DRIVER module type to generate the binary PI dependency expression into the output test.depex.\f1\par\r
\b\f0 GenDepex \endash o test.depex \endash t DXE_DRIVER test.iii\par\r
\b0 Test.iii file is the preprocessed dxs file like:\par\r
DEPENDENCY_START\par\r
  \{ 0x26baccb2, 0x6f42, 0x11d4, \{0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81\} \} AND\par\r
  \{ 0xf617b358, 0x12cf, 0x414a, 0xa0, 0x69, 0x60, 0x67, 0x7b, 0xda, 0x13, 0xb3 \}\par\r
DEPENDENCY_END\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 Bugs\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 No known bugs.\par\r
Report bugs to edk2-buildtools-devel@lists.sourceforge.net\f1\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Files\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 None\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 See also\par\r
\pard\nowidctlpar\sb200\cf2\b0\fs18 None\par\r
\pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 License\par\r
\pard\nowidctlpar\cf2\b0\fs18 Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.\par\r
This program and the accompanying materials are licensed and made available \par\r
under the terms and conditions of the BSD License which accompanies this \par\r
distribution.  The full text of the license may be found at\par\r
http://opensource.org/licenses/bsd-license.php\par\r
\par\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\par\r
\pard\nowidctlpar\sb200 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par\r
\cf0\f1\par\r
\pard\nowidctlpar\f2\fs20\par\r
}\r
\0