BaseTools/UserManuals/GenDepex_Utility_Man_Page.rtf

   1 {\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;}}
   2 {\colortbl ;\red8\green96\blue168;\red0\green0\blue0;}
   3 {\stylesheet{ Normal;}{\s1 heading 1;}{\s2 heading 2;}}
   4 {\*\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
   5 \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
   6 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\tx1440\cf1\b\f0\fs28 Synopsis\par
   7 \pard\nowidctlpar\sb200\cf2\fs18 GenDepex.exe [options] [dependency_expression_file]\f1\par
   8 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\f0\fs28 Description\par
   9 \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
  10 \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
  11 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 Options\par
  12 \pard\nowidctlpar\sb200\cf2\fs18 dependency_expression_file\f1\par
  13 \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
  14 \pard\nowidctlpar\sb200\b\f0 -o FILE, --output=FILE\par
  15 \pard\nowidctlpar\li360\sb200\b0 Specify the name of depex file that contains the generated binary PI dependency expression.\f1\par
  16 \pard\nowidctlpar\sb200\b\f0 -t MODULETYPE, --module-type=MODULETYPE\par
  17 \pard\nowidctlpar\li360\sb200\b0 The type of module is for which the dependency expression serves. Only EDKII module type is supported.\f1\par
  18 \pard\nowidctlpar\sb200\b\f0 -e EXPRESSION, --dependency-expression=EXPRESSION\par
  19 \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
  20 \pard\nowidctlpar\sb200\b -m, --optimize\f1\par
  21 \pard\nowidctlpar\fi360\sb200\b0\f0 Do some simple optimization on the expression to remove the duplicated guid.\f1\par
  22 \pard\nowidctlpar\sb200\b\f0 -v, --verbose\f1\par
  23 \b0\f0  \tab Run with verbose information.\f1\par
  24 \b\f0 -d DEBUG, --debug=DEBUG [0-9]\f1\par
  25 \pard\nowidctlpar\fi360\sb200\b0\f0 Enable debug messages at specified level.\par
  26 \pard\nowidctlpar\sb200\b -q, --quiet\f1\par
  27 \pard\nowidctlpar\fi360\sb200\b0\f0 Run with little information in quiet mode.\f1\par
  28 \pard\nowidctlpar\sb200\b\f0 --version\f1\par
  29 \pard\nowidctlpar\fi360\sb200\b0\f0 Show program's version number and exit\par
  30 \pard\nowidctlpar\sb200\b -h, --help\par
  31 \pard\nowidctlpar\li360\sb200\b0 Show this help message and exit\f1\par
  32 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Example\par
  33 \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
  34 \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
  35 \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
  36 \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
  37 \b0\f0 Same to \par
  38 \b GenDepex -o test.depex -t DXE_DRIVER -e "\{ 0x26baccb2, 0x6f42, 0x11d4, \{0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81\} \} END"\par
  39 \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
  40 \b\f0 GenDepex \endash o test.depex \endash t DXE_DRIVER test.iii\par
  41 \b0 Test.iii file is the preprocessed dxs file like:\par
  42 DEPENDENCY_START\par
  43   \{ 0x26baccb2, 0x6f42, 0x11d4, \{0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81\} \} AND\par
  44   \{ 0xf617b358, 0x12cf, 0x414a, 0xa0, 0x69, 0x60, 0x67, 0x7b, 0xda, 0x13, 0xb3 \}\par
  45 DEPENDENCY_END\par
  46 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 Bugs\par
  47 \pard\nowidctlpar\sb200\cf2\b0\fs18 No known bugs.\par
  48 Report bugs to edk2-buildtools-devel@lists.sourceforge.net\f1\par
  49 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\f0\fs28 Files\par
  50 \pard\nowidctlpar\sb200\cf2\b0\fs18 None\par
  51 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 See also\par
  52 \pard\nowidctlpar\sb200\cf2\b0\fs18 None\par
  53 \pard\keep\keepn\nowidctlpar\s2\li-1440\sb400\sa60\sl-340\slmult0\cf1\b\fs28 License\par
  54 \pard\nowidctlpar\cf2\b0\fs18 Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.\par
  55 This program and the accompanying materials are licensed and made available \par
  56 under the terms and conditions of the BSD License which accompanies this \par
  57 distribution.  The full text of the license may be found at\par
  58 http://opensource.org/licenses/bsd-license.php\par
  59 \par
  60 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\par
  61 \pard\nowidctlpar\sb200 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\par
  62 \cf0\f1\par
  63 \pard\nowidctlpar\f2\fs20\par
  64 }
  65