[xbuild] Update man page with info about FrameworkList.xml
authorAnkit Jain <radical@corewars.org>
Thu, 3 Mar 2011 17:39:17 +0000 (23:09 +0530)
committerAnkit Jain <radical@corewars.org>
Thu, 3 Mar 2011 19:20:31 +0000 (00:50 +0530)
man/xbuild.1

index 7e69a2d0484423ab0fc1950b9d23474dea5690b9..f1f0858521af26c48bb911b52a5b78a6b7b914c4 100644 (file)
@@ -99,6 +99,8 @@ This moniker maps to a framework description file on disk:
 
   <framework_root>/Identifier/Version/[Profile]/RedistList/FrameworkList.xml
 
+This file is used to determine the path where to find the framework assemblies for this particular framework.
+
 Framework root here is configurable and is resolved in the following order:
 
 .nf
@@ -110,6 +112,19 @@ Framework root here is configurable and is resolved in the following order:
 
 XBuild tries the paths given above, in order, till it finds a FrameworkList.xml for the moniker.
 Running with /v:detailed or higher verbosity will show the various paths that it tries.
+
+The FrameworkList.xml itself just has a root element like:
+
+  <FileList  Name=".NET Framework 3.5" TargetFrameworkDirectory="..\\..\\..\\..\\3.5" IncludeFramework="v3.0">
+  </FileList>
+
+Here the TargetFrameworkDirectory attribute specifies the directory where the assemblies for
+this particular framework can be found. If this is not set, then the parent of the folder
+containing the xml file is taken as the framework directory.
+
+IncludeFramework attribute specifies the version of a framework (under the *same* $(TargetFrameworkIdentifier))
+which should be included in the final list of Target framework directories.
+
 .TP
 .I "XBUILD_COLORS"
 If this variable is set, it contains a string of the form