archive
/
windows-xp
mirror of https://github.com/tongzx/nt5src
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Source code of Windows XP (NT5)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6 Commits
1 Branch
0 Tags
2.0 GiB
Branch: master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
windows-xp/Source/XPSP1/NT/sdktools/build/build.htm

324 lines
17 KiB
Raw Permalink Normal View History

Add source files
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
  1. <HTML>
  2. <BODY>
  4. <A NAME=BASEDIR><H3>BASEDIR</H3></A>
  5. The BASEDIR macro refers to the base of the source tree.
  6. By default,
  7. <PRE> BASEDIR=$(_NTDRIVE)$(_NTROOT)</PRE>
  8. The following three statements are equivalent, but using the third one is recommended.
  9. <PRE>
  10. TARGETLIBS=d:\nt\public\sdk\lib\*\kernel32.lib
  11. TARGETLIBS=$(BASEDIR)\public\sdk\lib\*\kernel32.lib
  12. TARGETLIBS=$(<A HREF=#SDK_LIB_PATH>SDK_LIB_PATH</A>)\kernel32.lib
  13. </PRE>
  15. sources
  16. dirs
  17. makefile
  18. makefile.inc
  20. makefile.def
  21. makefile.plt
  22. build.dat
  23. objects.mac
  24. <A NAME=BUILD_DEFAULT_TARGETS><H3>BUILD_DEFAULT_TARGETS</H3></A>
  25. This envirnoment variable specifies the platform for which you are building. This variables allows the possibly of cross platform compilation, when such compilers are available.
  26. Here is an exmaple of this environment variable:
  27. <PRE> BUILD_DEFAULT_TARGETS=-axp64</PRE>
  30. <A NAME=BUILD_DEFAULT><H3>BUILD_DEFAULT</H3></A>
  31. This envirnoment variable specifies the default options used by build.exe
  32. Here is an example of this environment variable:
  33. <PRE> BUILD_DEFAULT=-eswM -nmake -i</PRE>
  36. <A NAME=BUILD_MAKE_PROGRAM><H3>BUILD_MAKE_PROGRAM</H3></A>
  37. This envirnoment variable specifies the default program make executed by build.exe to in order to compile a directory.
  38. The default value of this environment variable should be nmake.exe.
  41. <A NAME=BUILD_OTPIONS><H3>BUILD_OPTIONS</H3></A>
  42. By default, build.exe will traverse the entire source tree, processing the directories listed in the DIRS section of the dirs file.
  43. This envirnoment variable specifies which of the optional directories, listed under </A HREF=#OPTIONAL_DIRS>OPTIONAL_DIRS</A> should be processed by build.exe
  44. Here are some examples of this environment variable:
  45. <PRE> BUILD_OPTIONS=OptDir1 OptDir2</PRE>
  46. would cause build to also process all OptDir1 and OptDir2 directories listed under an OPTIONAL_DIRS section.
  47. <PRE> BUILD_OPTIONS=~OptDir1 OptDir2</PRE>
  48. would cause build to all OptDir2 directories listed under an OPTIONAL_DIRS section, but force it to skip over all OptDir1 directories, whether listed in the DIRS or OPTIONAL_DIRS section of a dirs file.
  51. <A NAME=CRT_INC_PATH><H3>CRT_INC_PATH</H3></A>
  52. <P>This envirnoment variable specifies the location of the C Runtime header files. The default value of this macro is:</P>
  53. <PRE> $(BASEDIR)\public\sdk\inc\crt</PRE>
  54. <P>Set this macro in your environment variables if you wish to override the default location of the C Runtime header files.<BR>
  55. This macro should no be redefined from within a sources file.</P>
  58. <A NAME=CRT_LIB_PATH><H3>CRT_LIB_PATH</H3></A>
  59. <P>This envirnoment variable specifies the location of the C Runtime libraries. The default value of this macro is:</P>
  60. <PRE> $(BASEDIR)\public\sdk\lib\crt</PRE>
  61. <P>Set this macro in your environment variables if you wish to override the default location of the C runtime libraries.<BR>
  62. This macro should no be redefined from within a sources file.</P>
  63. <P>Here is an example of the usage of this macro:</P>
  64. <PRE> TARGETLIB=$(CRT_LIB_PATH)\libcntpr.lib \<BR> $(SDK_LIB_PATH)\advapi32.lib</PRE>
  67. <A NAME=DDK_INC_PATH><H3>DDK_INC_PATH</H3></A>
  68. <P>This macro specifies the location of the DDK header files. The default value of this macro is:</P>
  69. <PRE> $(BASEDIR)\public\ddk\inc</PRE>
  70. <P>Set this macro in your environment variables if you wish to override the default location of the DDK header files.<BR>
  71. This macro should no be redefined from within a sources file.</P>
  74. <A NAME=DDK_LIB_DEST><H3>DDK_LIB_DEST</H3></A>
  75. <P>This macro specifies the destination location of a DDK library. The default value of this macro is:</P>
  76. <PRE> $(BASEDIR)\public\ddk\lib\*</PRE>
  77. <P>Set this macro in your environment variables if you wish to override the default location of the DDK libraries.<BR>
  78. This macro should no be redefined from within a sources file.</P>
  79. <P>Here is an example of the usage of this macro:</P>
  80. <PRE> TARGETPATHLIB=$(DDK_LIB_DEST)\ndis.lib</PRE>
  83. <A NAME=DDK_LIB_PATH><H3>DDK_LIB_PATH</H3></A>
  84. <P>This macro specifies the location of the DDK libraries. The default value of this macro is:</P>
  85. <PRE> $(BASEDIR)\public\ddk\lib</PRE>
  86. <P>Set this macro in your environment variables if you wish to override the default location of the DDK libraries.<BR>
  87. This macro should no be redefined from within a sources file.</P>
  88. <P>Here is an example of the usage of this macro:</P>
  89. <PRE> TARGETLIB=$(DDK_LIB_PATH)\ndis.lib \<BR> $(DDK_LIB_PATH)\tdikrnl.lib</PRE>
  92. <A NAME=DDK_LIB_PATH><H3>DDK_LIB_PATH</H3></A>
  93. <P>This macro specifies the location of the DDK libraries. The default value of this macro is:</P>
  94. <PRE> $(BASEDIR)\public\ddk\lib</PRE>
  95. <P>Set this macro in your environment variables if you wish to override the default location of the DDK libraries.<BR>
  96. This macro should no be redefined from within a sources file.</P>
  97. <P>Here is an example of the usage of this macro:</P>
  98. <PRE> TARGETLIB=$(DDK_LIB_PATH)\ndis.lib \<BR> $(DDK_LIB_PATH)\tdikrnl.lib</PRE>
  101. <A NAME=MASTER_VERSION_FILE><H3>MASTER_VERSION_FILE</H3></A>
  102. This macro contains the name of the master version file for Windows 2000.
  103. It contains, among other things, the default operating system version number
  104. which all binaries should have defined in the resource section.
  106. The default value of this variable is $(<A HREF=#SDK_INC_PATH>SDK_INC_PATH</A>)\ntverp.h
  108. You should not override this value in your environment variables unless your component is not integrated in the Windows 2000 product (please contact BryanT for more information).
  110. <A NAME=OAK_INC_PATH><H3>OAK_INC_PATH</H3></A>
  111. <P>This macro specifies the location of the OAK header files. The default value of this macro is:</P>
  112. <PRE> $(BASEDIR)\public\oak\inc</PRE>
  113. <P>Set this macro in your environment variables if you wish to override the default location of the OAK header files.<BR>
  114. This macro should no be redefined from within a sources file.</P>
  117. <A NAME=PRIVATE_INC_PATH><H3>PRIVATE_INC_PATH</H3></A>
  118. <P>This macro specifies the location of the private windows 2000 header files. The default value of this macro is:</P>
  119. <PRE> $(BASEDIR)\private\inc</PRE>
  120. <P>Set this macro in your environment variables if you wish to override the default location of the private windows 2000 header files.<BR>
  121. This macro should no be redefined from within a sources file.</P>
  124. <A NAME=SDK_LIB_DEST><H3>SDK_LIB_DEST</H3></A>
  125. <P>This macro specifies the destination location of a SDK library. The default value of this macro is:</P>
  126. <PRE> $(BASEDIR)\public\sdk\lib\*</PRE>
  127. <P>Set this macro in your environment variables if you wish to override the default location of the SDK libraries.<BR>
  128. This macro should no be redefined from within a sources file.</P>
  129. <P>Here is an example of the usage of this macro:</P>
  130. <PRE> TARGETPATHLIB=$(SDK_LIB_DEST)\kernel32.lib</PRE>
  133. <A NAME=SDK_LIB_PATH><H3>SDK_LIB_PATH</H3></A>
  134. <P>This macro specifies the location of the SDK libraries. The default value of this macro is:</P>
  135. <PRE> $(BASEDIR)\public\sdk\lib</PRE>
  136. <P>Set this macro in your environment variables if you wish to override the default location of the SDK libraries.<BR>
  137. This macro should no be redefined from within a sources file.</P>
  138. <P>Here is an example of the usage of this macro:</P>
  139. <PRE> TARGETLIB=$(SDK_LIB_PATH)\kernel32.lib \<BR> $(SDK_LIB_PATH)\advapi32.lib</PRE>
  142. <A NAME=WDM_INC_PATH><H3>WDM_INC_PATH</H3></A>
  143. <P>This macro specifies the location of the WDM header file. The default value of this macro is:</P>
  144. <PRE> $(BASEDIR)\public\ddk\inc\wdm</PRE>
  145. <P>Set this macro in your environment variables if you wish to override the default location of the WDM header files.<BR>
  146. This macro should no be redefined from within a sources file.</P>
  151. <A NAME=C_DEFINES><H3>C_DEFINES - <SMALL>optional</SMALL></H3></A>
  152. Use this macro to specify switches you want passed to the compiler.
  153. Typically, they are compiler #defines.
  154. You might specify:
  155. <PRE> C_DEFINES = -DENABLE_FEATURE1</PRE>
  156. to define ENABLE_FEATURE1 to the compiler.
  157. C_DEFINES gets passed to both the C compiler and the MIDL compiler.
  158. Therefore, you cannot put compiler optimization or other machine or
  159. tool specific switches in the C_DEFINES macro.
  160. Use <A HREF=#MSC_OPTIMIZATION>MSC_OPTIMIZATION</A> for C compiler only optimizations
  161. See also <A HREF=#ASM_DEFINES>ASM_DEFINES</A>, <A HREF=#RC_DEFINES>RC_DEFINES</A>
  164. <A NAME=DLLORDER><H3>DLLORDER - <SMALL>optional</SMALL></H3></A>
  165. When you are building a DLL, you can specify an order file that will be passed
  166. to the linker. This order file lists the order in which functions should be
  167. layed out in the image.
  168. This is the same as <A HREF=#NTPROFILEINPUT>NTPROFILEINPUT</A> except that
  169. a full name for the profile can be specified.
  172. <A NAME=EXEPROFILEINPUT><H3>EXEPROFILEINPUT - <SMALL>obsolete</SMALL></H3></A>
  173. Use <A HREF=#NTPROFILEINPUT>NTPROFILEINPUT</A> instead.
  178. <A NAME=INCLUDES><H3>INCLUDES - <SMALL>optional</SMALL></H3></A>
  179. <P>Build.exe use a default list of public include directories from which to search for header files.
  180. The default list of include directories is dependent on the value of <A HREF=#TARGETTYPE>TARGETTYPE</A> in the sources file.</P>
  181. <P>Use the INCLUDES macro to indicate an additional list of private include directories to be searched for include files during compilation.
  182. Separate the entries in this list with a semicolon.
  183. Path names can be absolute or relative.</P>
  184. For example:
  185. <PRE>
  186. INCLUDES=..\inc;..\..\inc
  188. INCLUDES=$(INCLUDES); \
  189. h; \
  190. ..\headers;
  191. </PRE>
  192. The INCLUDES macro is read by build.exe and passed to the MAKE program.
  193. The list of directories in the INCULDES macro will have precedence over the default include directories.
  196. <A NAME=MAJORCOMP><H3>MAJORCOMP - <SMALL>obsolete</SMALL></H3></A>
  197. Please remove from your sources file
  199. <A NAME=MINORCOMP><H3>MINORCOMP - <SMALL>obsolete</SMALL></H3></A>
  200. Please remove from your sources file
  203. <A NAME=NO_NTDLL><H3>NO_NTDLL - <SMALL>optional</SMALL></H3></A>
  204. Set this macro to 0 to force your binary <I>not</I> to link against NTDLL.LIB.
  206. <A NAME=NTPROFILEINPUT><H3>NTPROFILEINPUT - <SMALL>optional</SMALL></H3></A>
  207. When you are building a DLL, you can specify an order file that will be passed
  208. to the linker. This order file lists the order in which functions should be
  209. layed out in the image.
  211. To use the profile, specify the following in your sources file:
  212. <PRE> NTPROFILEINPUT=1</PRE>
  213. If you set this value, build.exe expect to find
  214. <PRE> $(TARGETNAME).prf</PRE>
  215. in the current subdirectory.
  216. <P> See also <A HREF=#DLLORDER>DLLORDER</A></P>
  219. <A NAME=PNP_POWER><H3>PNP_POWER - <SMALL>obsolete</SMALL></H3></A>
  220. Please remove from your sources file
  223. <A NAME=SOURCES><H3>SOURCES - <SMALL>required</SMALL></H3></A>
  224. <P>The SOURCES macro is the most important macro in a sources file.
  225. It specifies the list of files to be compiled.
  226. Build.exe will look at these files and generate a dependency list.
  227. For any source file whose dependencies changed, build.exe will rebuild
  228. this file.</P>
  229. <P>Use this macro to list your source filenames (except for the file containing
  230. main in the case where <A HREF=#UMAPPL>UMAPPL</A> or <A HREF=#UMTEST>UMTEST</A>
  231. is used. Include the filename extension and separate the entries in this list
  232. with spaces or tabs.</P>
  235. <A NAME=TARGETEXT><H3>TARGETEXT - <SMALL>optional</SMALL></H3></A>
  236. Set this macro to specify the extension name (such as .cpl) when you want your binary to have something other than the default extension generated by <A HREF=#TARGETTYPE>TARGETTYPE</A>.
  237. If you specify something unexpected, you will see a message "Unexpected Target Ext." If you want an extension added to the Build Utility, contact Bryan Tuttle (bryant).
  240. <A NAME=TARGETLIBS><H3>TARGETLIBS - <SMALL>required</SMALL></H3></A>
  241. <P>Set this macro to specify the set of libraries with which your final image must be linked.</P>
  242. If your components generates a library (.lib) and this library must link in code from other libraries, use the <A HREF=#LINKLIBS>LINKLIBS</A> macro.
  243. Use LINKLIBS only for the case that meets the following conditions:
  244. You are building a dynamic link.
  245. You are exporting something that's defined in some other component library that you also build.
  246. In your dirs file in the subdirectory above, you have ordered it so that the component libraries are around before you build the dynamic link.
  247. There is a similar macro called UMLIBSUMLIBS that you can use if you are building UMAPPLs.
  250. <A NAME=TARGETNAME><H3>TARGETNAME - <SMALL>required</SMALL></H3></A>
  251. Use this macro to specify the name of the binary being built, excluding the filename extension.
  252. You must have this macro in your sources file.
  255. <A NAME=TARGETPATH><H3>TARGETPATH - <SMALL>required</SMALL></H3></A>
  256. Use this macro to specify the target directory in which the resulting binary will be placed.
  257. Notice that object files always end up in the obj subdirectory. Object file can only be generated in the <A HREF=#$(O)>$(O)</A> directory.
  258. You must have this macro in your sources file. For example:
  261. <PRE> TARGETPATH=obj</PRE>
  262. See Also <A HREF=#TARGETPATHLIB>TARGETPATHLIB</A>
  265. <A NAME=TARGETPATHLIB><H3>TARGETPATHLIB - <SMALL>optional</SMALL></H3></A>
  266. Set this value to specify where to put the import library associated with this binary. <BR>
  267. When you are building a DLL, you create the DLL itself and you create an import library that other images can use to reference functions exported by your DLL. <BR>
  268. <PRE> TARGETPATHLIB=$(SDK_LIB_PATH)mydll.lib</PRE>
  269. <P>Setting <A HREF=#TARGETPATH>TARGETPATH</A> independently from TARGETPATHLIB allows the binary to be kept in the
  270. current directory, while the .lib and .exp files can be shared with other components. </P>
  273. <A NAME=TARGETTYPE><H3>TARGETTYPE - <SMALL>required</SMALL></H3></A>
  274. Use this macro to specify the type of binary being built. This is typically LIBRARY or
  275. DYNLINK (for DLLs), but can take other values. This is a required field in the sources file.
  276. TARGETTYPE allows build.exe to select appropriate defaults for include paths and link options.
  277. You must have this macro in your sources file.
  278. The valid values for TARGETYPE include:
  279. <TABLE CELLPADDING=3 BORDER=3>
  280. <TR VALIGN=TOP><TH> TARGETTYPE values </TH><TH> File Extension </TH><TH> Description </TH>
  281. <TR VALIGN=TOP><TD><A NAME=PROGLIB>PROGLIB</A> </TD><TD> .exe </TD><TD> Executable program which also exports functions for other programs. </TD></TR>
  282. <TR VALIGN=TOP><TD><A NAME=PROGRAM>PROGRAM</A> </TD><TD> .exe </TD><TD> Simple user mode program. </TD></TR>
  283. <TR VALIGN=TOP><TD><A NAME=DYNLINK>DYNLINK</A> </TD><TD> .dll </TD><TD> Dynamic Link Library (dll). </TD></TR>
  284. <TR VALIGN=TOP><TD><A NAME=LIBRARY>LIBRARY</A> </TD><TD> .lib </TD><TD> Component library whose code will be linked into another binary (such as a dll). </TD></TR>
  285. <TR VALIGN=TOP><TD><A NAME=DRIVER_LIBRARY>DRIVER_LIBRARY</A> </TD><TD> .lib </TD><TD> Component library for a driver. The only difference with the LIBRARY type is that the default header file include path is different. </TD></TR>
  286. <TR VALIGN=TOP><TD><A NAME=DRIVER>DRIVER</A> </TD><TD> .sys </TD><TD> Kernel mode driver.
  287. <TR VALIGN=TOP><TD><A NAME=EXPORT_DRIVER>EXPORT_DRIVER</A> </TD><TD> .sys </TD><TD> Kernel mode driver which also exports routines other drivers can link against and call. </TD></TR>
  288. <TR VALIGN=TOP><TD><A NAME=HAL>HAL</A> </TD><TD> .dll </TD><TD> Hardware Abstraction Layer (HAL) </TD></TR>
  289. <TR VALIGN=TOP><TD><A NAME=BOOTPGM>BOOTPGM</A> </TD><TD> .exe </TD><TD> Kernel mode driver. </TD></TR>
  290. <TR VALIGN=TOP><TD><A NAME=MINIPORT>MINIPORT</A> </TD><TD> .sys </TD><TD> Kernel mode driver which does not link against ntoskrnl.lib or hal.lib. </TD></TR>
  291. <TR VALIGN=TOP><TD><A NAME=GDI_DRIVER>GDI_DRIVER</A> </TD><TD> .dll </TD><TD> Kernel mode driver which only links against win32k.sys (Display or print driver). </TD></TR>
  292. </TABLE>
  295. <A NAME=UMAPPL><H3>UMAPPL</H3></A>
  298. <A NAME=UMAPPLEXT><H3>UMAPPLEXT</H3></A>
  299. Use this macro to specify the extension name (for example .COM or .SCR) that
  300. will be appended to the name specified in <A HREF=#UMAPPL>UMAPPL</A>.
  301. Use UMAPPLEXT when you want the extension to be something other than .exe.
  302. Contact Bryan Tuttle if you need to add a new type of extension.
  305. <A NAME=UMLIBS><H3>UMLIBS</H3></A>
  308. <A NAME=UMTEST><H3>UMTEST</H3></A>
  311. <H2>Sample Driver Sources File</H2>
  313. <PRE>
  314. <A HREF=#TARGETNAME>TARGETNAME</A>=sample
  315. <A HREF=#TARGETPATH>TARGETPATH</A>=obj
  316. <A HREF=#TARGETTYPE>TARGETTYPE</A>=<A HREF=#DRIVER>DRIVER</A>
  318. <A HREF=#TARGETLIBS>TARGETLIBS</A>=$(<A HREF=#DDK_LIB_PATH>DDK_LIB_PATH</A>)\videoprt.lib
  320. <A HREF=#SOURCES>SOURCES</A>=file1.c \<BR> file2.c \<BR> file3.c
  322. </PRE>
  324. </BODY></HTML>