Merge branch 'fsharp4' into VS2015Support

Author: KevinRansom

DEVGUIDE.md

@@ -27,19 +27,15 @@ See the script for what this does.  After you do this, you can do further testin
 The compiler is compiled as a set of .NET 4.0 components using a bootstrap process. This uses the Last Known Good (LKG) compiler to build.  
 Note that you need the .NET framework 3.5 installed on your machine in order to complete this step.
 
-```
-gacutil /i lkg\FSharp-2.0.50726.900\bin\FSharp.Core.dll
-msbuild src\fsharp-proto-build.proj
-```
+    gacutil /i lkg\FSharp-2.0.50726.900\bin\FSharp.Core.dll
+    msbuild src\fsharp-proto-build.proj
 
 ## 2.  Building an F# (Debug) library and compiler
 
 This uses the proto compiler to build `FSharp.Core.dll`, `FSharp.Compiler.dll`, `fsc.exe`, and `fsi.exe`.
 
-```
-msbuild src/fsharp-library-build.proj 
-msbuild src/fsharp-compiler-build.proj 
-```
+    msbuild src/fsharp-library-build.proj 
+    msbuild src/fsharp-compiler-build.proj 
 
 You can now use the updated F# compiler in `debug\net40\bin\fsc.exe` and F# Interactive in `debug\net40\bin\fsi.exe` to develop and test basic language and tool features.
 
@@ -51,75 +47,81 @@ See [TESTGUIDE.md](TESTGUIDE.md) for full details on how to run tests.
 
 Prior to a **Debug** test run, you need to complete **all** of these steps:
 
-```
-msbuild src/fsharp-library-build.proj
-msbuild src/fsharp-compiler-build.proj
-msbuild src/fsharp-typeproviders-build.proj
-msbuild src/fsharp-compiler-unittests-build.proj
-msbuild src/fsharp-library-build.proj /p:TargetFramework=net20
-msbuild src/fsharp-library-build.proj /p:TargetFramework=portable47
-msbuild src/fsharp-library-build.proj /p:TargetFramework=portable7
-msbuild src/fsharp-library-build.proj /p:TargetFramework=portable78
-msbuild src/fsharp-library-build.proj /p:TargetFramework=portable259
-msbuild src/fsharp-library-unittests-build.proj
-msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable47
-msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable7
-msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable78
-msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable259
-src\update.cmd debug -ngen
-tests\BuildTestTools.cmd debug 
-```
+    msbuild src/fsharp-library-build.proj
+    msbuild src/fsharp-compiler-build.proj
+    msbuild src/fsharp-typeproviders-build.proj
+    msbuild src/fsharp-compiler-unittests-build.proj
+    msbuild src/fsharp-library-build.proj /p:TargetFramework=net20
+    msbuild src/fsharp-library-build.proj /p:TargetFramework=portable47
+    msbuild src/fsharp-library-build.proj /p:TargetFramework=portable7
+    msbuild src/fsharp-library-build.proj /p:TargetFramework=portable78
+    msbuild src/fsharp-library-build.proj /p:TargetFramework=portable259
+    msbuild src/fsharp-library-unittests-build.proj
+    msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable47
+    msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable7
+    msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable78
+    msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable259
+    src\update.cmd debug -ngen
+    tests\BuildTestTools.cmd debug 
+
 
 [Optional] If testing the Visual Studio bits (see below) you will also need:
 
-```
-msbuild vsintegration\fsharp-vsintegration-build.proj
-msbuild vsintegration\fsharp-vsintegration-unittests-build.proj
-```    
+    msbuild vsintegration\fsharp-vsintegration-build.proj
+    msbuild vsintegration\fsharp-vsintegration-unittests-build.proj
 
 Prior to a **Release** test run, you need to do **all** of these:
 
-```
-msbuild src/fsharp-library-build.proj  /p:Configuration=Release
-msbuild src/fsharp-compiler-build.proj  /p:Configuration=Release
-msbuild src/fsharp-typeproviders-build.proj  /p:Configuration=Release
-msbuild src/fsharp-compiler-unittests-build.proj  /p:Configuration=Release
-msbuild src/fsharp-library-build.proj /p:TargetFramework=net20 /p:Configuration=Release
-msbuild src/fsharp-library-build.proj /p:TargetFramework=portable47 /p:Configuration=Release
-msbuild src/fsharp-library-build.proj /p:TargetFramework=portable7 /p:Configuration=Release
-msbuild src/fsharp-library-build.proj /p:TargetFramework=portable78 /p:Configuration=Release
-msbuild src/fsharp-library-build.proj /p:TargetFramework=portable259 /p:Configuration=Release
-msbuild src/fsharp-library-unittests-build.proj  /p:Configuration=Release
-msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable47 /p:Configuration=Release
-msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable7 /p:Configuration=Release
-msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable78 /p:Configuration=Release
-msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable259 /p:Configuration=Release
-src\update.cmd release -ngen
-tests\BuildTestTools.cmd release 
-```
+    msbuild src/fsharp-library-build.proj  /p:Configuration=Release
+    msbuild src/fsharp-compiler-build.proj  /p:Configuration=Release
+    msbuild src/fsharp-typeproviders-build.proj  /p:Configuration=Release
+    msbuild src/fsharp-compiler-unittests-build.proj  /p:Configuration=Release
+    msbuild src/fsharp-library-build.proj /p:TargetFramework=net20 /p:Configuration=Release
+    msbuild src/fsharp-library-build.proj /p:TargetFramework=portable47 /p:Configuration=Release
+    msbuild src/fsharp-library-build.proj /p:TargetFramework=portable7 /p:Configuration=Release
+    msbuild src/fsharp-library-build.proj /p:TargetFramework=portable78 /p:Configuration=Release
+    msbuild src/fsharp-library-build.proj /p:TargetFramework=portable259 /p:Configuration=Release
+    msbuild src/fsharp-library-unittests-build.proj  /p:Configuration=Release
+    msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable47 /p:Configuration=Release
+    msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable7 /p:Configuration=Release
+    msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable78 /p:Configuration=Release
+    msbuild src/fsharp-library-unittests-build.proj /p:TargetFramework=portable259 /p:Configuration=Release
+    src\update.cmd release -ngen
+    tests\BuildTestTools.cmd release 
+
 
 [Optional] If testing the Visual F# IDE Tools (see below) you will also need:
 
-```
-msbuild vsintegration\fsharp-vsintegration-build.proj /p:Configuration=Release
-msbuild vsintegration\fsharp-vsintegration-unittests-build.proj /p:Configuration=Release
-```
+    msbuild vsintegration\fsharp-vsintegration-build.proj /p:Configuration=Release
+    msbuild vsintegration\fsharp-vsintegration-unittests-build.proj /p:Configuration=Release
+
+## 4. [Optional] Install the Visual F# IDE Tools and Clobber the F# 4.0 SDK on the machine
+
+NOTE: Step #2 will install a VSIX extension into Visual Studio 2015 that changes the Visual F# IDE Tools 
+components installed into Visual Studio 2015.  You can revert this step by disabling or uninstalling the addin.
+
+NOTE: Step #3 will clobber the machine-wide installed F# 4.0 SDK on your machine. This replaces the ``fsi.exe``/``fsiAnyCpu.exe`` used 
+by Visual F# Interactive and the fsc.exe used by Microsoft.FSharp.targets.  Repairing Visual Studio 2015 is currently the 
+only way to revert this step.  
+
+NOTE: After you complete the install, the FSharp.Core referenced by your projects will not be updated. If you want to make
+a project that references your updated FSharp.Core, you must explicitly change the ``TargetFSharpCoreVersion`` in the .fsproj
+file to ``4.4.0.5099`` (or a corresponding portable version number with suffix ``5099``).
+
+For debug:
 
-## 4. [Optional] Build and Install the Visual F# IDE Tools
+1. Ensure that the VSIX package is uninstalled. In VS, select Tools/Extensions and Updates and if the package `VisualStudio.FSharp.EnableOpenSource` is installed, select Uninstall
+1. Run ``debug\net40\bin\EnableOpenSource.vsix``
+1. Run ``vsintegration\update-vsintegration.cmd debug`` (clobbers the installed F# 4.0 SDK)
 
-To build the VS components:
+For release:
 
-```
-msbuild vsintegration\fsharp-vsintegration-build.proj
-```
+1. Ensure that the VSIX package is uninstalled. In VS, select Tools/Extensions and Updates and if the package `VisualStudio.FSharp.EnableOpenSource` is installed, select Uninstall
+1. Run ``release\net40\bin\EnableOpenSource.vsix``
+1. Run ``vsintegration\update-vsintegration.cmd release`` (clobbers the installed F# 4.0 SDK)
 
-To install the VS components:
+Restart Visual Studio, it should now be running your freshly-built Visual F# IDE Tools with updated F# Interactive. 
 
-1. Ensure that the VSIX package is uninstalled.
- - In VS, select Tools/Extensions and Updates
- - If the package `VisualStudio.FSharp.EnableOpenSource` is installed, select Uninstall
-1. Run ```debug\net40\bin\EnableOpenSource.vsix```
-1. Restart Visual Studio, it should now be running your freshly-built Visual F# IDE Tools.
 
 ### Notes on the build
 

src/fsharp/FSharp.Core.Unittests/LibraryTestFx.fs

@@ -123,7 +123,13 @@ module SurfaceArea =
 
     // verify public surface area matches expected
     let verify expected platform fileName =  
-        let logFile = sprintf "%s\\CoreUnit_%s_Xml.xml" TestContext.CurrentContext.WorkDirectory platform
+        let workDir =
+            #if OPEN_BUILD
+            TestContext.CurrentContext.WorkDirectory
+            #else
+            ""
+            #endif
+        let logFile = sprintf "%s\\CoreUnit_%s_Xml.xml" workDir platform
         let normalize (s:string) =
             Regex.Replace(s, "(\\r\\n|\\n)+", "\r\n").Trim([|'\r';'\n'|])
 

src/fsharp/fsc.fs

@@ -648,8 +648,9 @@ module XmlDocWriter =
         (* the xmlDocSigOf* functions encode type into string to be used in "id" *)
         let members = ref []
         let addMember id xmlDoc = 
-            let doc = getDoc xmlDoc
-            members := (id,doc) :: !members
+            if hasDoc xmlDoc then
+                let doc = getDoc xmlDoc
+                members := (id,doc) :: !members
         let doVal (v:Val) = addMember v.XmlDocSig v.XmlDoc
         let doUnionCase (uc:UnionCase) = addMember uc.XmlDocSig uc.XmlDoc
         let doField (rf:RecdField) = addMember rf.XmlDocSig rf.XmlDoc

tests/fsharpqa/Source/XmlDoc/Basic/env.lst

@@ -2,5 +2,6 @@
 	SOURCE=xmlDoc002.fs SCFLAGS="-r:System.Xml.dll --doc:xmlDoc002.xml --define:WITHXMLVERIFICATION"	# xmlDoc002.fs
 	SOURCE=xmlDoc003.fs SCFLAGS="-r:System.Xml.dll --doc:xmlDoc003.xml --define:WITHXMLVERIFICATION"	# xmlDoc003.fs
 	SOURCE=xmlDoc004.fs SCFLAGS="-r:System.Xml.dll --doc:xmlDoc004.xml --define:WITHXMLVERIFICATION"	# xmlDoc004.fs
+	SOURCE=xmlDoc005.fs SCFLAGS="-r:System.Xml.dll --doc:xmlDoc005.xml --define:WITHXMLVERIFICATION"	# xmlDoc005.fs
 	SOURCE=XMLDocOnEnum01.fs SCFLAGS="-r:System.Xml.dll --doc:XMLDocOnEnum01.xml --define:WITHXMLVERIFICATION"	# XMLDocOnEnum01.fs
 

tests/fsharpqa/Source/XmlDoc/Basic/xmlDoc005.fs

@@ -0,0 +1,49 @@
+// #Regression #XMLDoc
+// Verify that XmlDoc names are generated, but no empty members are generated re: issue #148
+//<Expects status=success></Expects>
+
+#light 
+
+namespace MyRather.MyDeep.MyNamespace 
+open System.Xml
+
+/// class1
+type Class1() = 
+    /// x
+    member this.X = "X"
+
+type Class2() =
+    member this.Y = "Y"
+    
+///testModule
+module MyModule =
+
+    let check (xml:XmlDocument) name xmlDoc =
+        let foundDoc = ((xml.SelectSingleNode ("/doc/members/member[@name='" + name + "']")).SelectSingleNode "summary").InnerText.Trim()
+        if xmlDoc <> foundDoc then
+            printfn "%s: generated xmlDoc <%s> differs from excpected <%s>" name foundDoc xmlDoc
+        xmlDoc = foundDoc
+    
+    let hasEmptyMembers (xml:XmlDocument) =
+        let node = xml.SelectSingleNode ("/doc/members/member[@name='']")
+        if node <> null then
+            printfn "Empty member name entries found." 
+        node <> null
+        
+    let test =
+        let myname = System.Reflection.Assembly.GetExecutingAssembly().Location
+        let xmlname = System.IO.Path.ChangeExtension(myname, "xml")
+
+
+#if WITHXMLVERIFICATION
+        let xml = new XmlDocument()
+        xml.Load xmlname
+        if    check xml "P:MyRather.MyDeep.MyNamespace.Class1.X" "x"
+           && check xml "T:MyRather.MyDeep.MyNamespace.Class1" "class1"
+           && not(hasEmptyMembers xml)
+        then 0 else 1
+#else
+        0
+#endif
+
+    test |> exit

tests/fsharpqa/Source/XmlDoc/UnitOfMeasure/UnitOfMeasure01.fs

@@ -21,16 +21,24 @@ let test =
     xml.Load(xmlname)
 
     let a1 = xml.GetElementsByTagName("summary").Item(0).FirstChild.Value = "This is B"
-    if not a1 then printfn "a1: expected: This is B"; exit 1
+    if not a1 then 
+        printfn "a1: expected: This is B" 
+        exit 1
 
     let a2 = xml.GetElementsByTagName("summary").Item(1).FirstChild.Value = "This is A"
-    if not a2 then printfn "a2: expected: This is A"; exit 1
-
-    let a3 = xml.GetElementsByTagName("member").Item(1).Attributes.Item(0).Value = "M:UnitOfMeasure01.B(System.Single)"
-    if not a3 then printfn "a3: expected: M:UnitOfMeasure01.B(System.Single)"; exit 1
-
-    let a4 = xml.GetElementsByTagName("member").Item(2).Attributes.Item(0).Value = "M:UnitOfMeasure01.A(System.Double)"
-    if not a4 then printfn "a4: expected: M:UnitOfMeasure01.A(System.Double)"; exit 1
+    if not a2 then 
+        printfn "a2: expected: This is A"
+        exit 1
+
+    let a3 = xml.GetElementsByTagName("member").Item(0).Attributes.Item(0).Value = "M:UnitOfMeasure01.B(System.Single)"
+    if not a3 then 
+        printfn "a3: expected: M:UnitOfMeasure01.B(System.Single)"
+        exit 1
+
+    let a4 = xml.GetElementsByTagName("member").Item(1).Attributes.Item(0).Value = "M:UnitOfMeasure01.A(System.Double)"
+    if not a4 then 
+        printfn "a4: expected: M:UnitOfMeasure01.A(System.Double)" 
+        exit 1
 #endif
     0
 

tests/fsharpqa/Source/XmlDoc/UnitOfMeasure/UnitOfMeasure02.fs

@@ -24,16 +24,24 @@ let test =
     xml.Load(xmlname)
 
     let a1 = xml.GetElementsByTagName("summary").Item(0).FirstChild.Value = "This is B"
-    if not a1 then printfn "a1: expected: This is B"; exit 1
+    if not a1 then 
+        printfn "a1: expected: This is B" 
+        exit 1
 
     let a2 = xml.GetElementsByTagName("summary").Item(1).FirstChild.Value = "This is A"
-    if not a2 then printfn "a2: expected: This is A"; exit 1
+    if not a2 then 
+        printfn "a2: expected: This is A" 
+        exit 1
 
-    let a3 = xml.GetElementsByTagName("member").Item(1).Attributes.Item(0).Value = "M:UnitOfMeasure02.B(System.Int32,System.Int32)"
-    if not a3 then printfn "a3: expected: M:UnitOfMeasure02.B(System.Int32,System.Int32)"; exit 1
-
-    let a4 = xml.GetElementsByTagName("member").Item(2).Attributes.Item(0).Value = "M:UnitOfMeasure02.A(System.Double)"
-    if not a4 then printfn "a4: expected: M:UnitOfMeasure02.A(System.Double)"; exit 1
+    let a3 = xml.GetElementsByTagName("member").Item(0).Attributes.Item(0).Value = "M:UnitOfMeasure02.B(System.Int32,System.Int32)"
+    if not a3 then 
+        printfn "a3: expected: M:UnitOfMeasure02.B(System.Int32,System.Int32)" 
+        exit 1
+
+    let a4 = xml.GetElementsByTagName("member").Item(1).Attributes.Item(0).Value = "M:UnitOfMeasure02.A(System.Double)"
+    if not a4 then 
+        printfn "a4: expected: M:UnitOfMeasure02.A(System.Double)" 
+        exit 1
 #endif
     0