add function header

[mirror_edk2.git] / build.xml

diff --git a/build.xml b/build.xml
index 421fa969c2f7f253585f438c33afe96a742e2310..f4724fef825c26596edd30153a7b78b2c1c6c0e6 100644 (file)
--- a/build.xml
+++ b/build.xml
@@ -10,27 +10,40 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 -->\r
 <project name="mdk" default="all" basedir=".">\r
+  <description>\r
+This is the highest-level build file.\r
+It can build all packages or clean up the build products.\r
+  </description>\r
   <property environment="env"/>\r
-  <target name="all">\r
+  <!-- Note: this is an ordered list. The projects have dependencies between them. -->\r
+  <filelist\r
+      id="Pkg.Dirs"\r
+      dir="."\r
+      files="Tools,MdePkg,EdkModulePkg,EdkNt32Pkg"/>\r
+\r
+  <target name="all" description="Issue a warning.">\r
+    <echo>\r
+Top-level builds may not be functional.\r
+Please build each package individually from its own directory.\r
+If you would like to try anyway, type\r
+ant All\r
+    </echo>\r
+  </target>\r
+  <target name="All" description="Build all packages.">\r
     <subant target="" inheritall="false">\r
-      <!-- Note: this is an ordered list. The projects have dependencies between them. -->\r
-      <filelist dir="."\r
-        files="\r
-          Tools/build.xml\r
-          MdePkg/build.xml\r
-          EdkModulePkg/build.xml\r
-          EdkNt32Pkg/build.xml\r
-          "/>\r
+      <filelist refid="Pkg.Dirs"/>\r
     </subant>\r
   </target>\r
-  <target name="clean">\r
+\r
+  <target name="clean" description="Remove compile and assembly artifacts.">\r
     <subant target="clean" inheritall="false">\r
-      <fileset dir="." includes="*/build.xml"/>\r
+      <filelist refid="Pkg.Dirs"/>\r
     </subant>\r
   </target>\r
-  <target name="distclean">\r
-    <subant target="distclean" inheritall="false">\r
-      <fileset dir="." includes="*/build.xml"/>\r
+\r
+  <target name="cleanall" description="Remove everything not in the distribution.">\r
+    <subant target="cleanall" inheritall="false">\r
+      <filelist refid="Pkg.Dirs"/>\r
     </subant>\r
   </target>\r
 </project>\r