some more documentation fixes.

fsprojects · Apr 20, 2018 · 44d0b6d · 44d0b6d
1 parent 4f8e42d
commit 44d0b6d
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 7 deletions.
diff --git a/help/markdown/dotnet-assemblyinfo.md b/help/markdown/dotnet-assemblyinfo.md
@@ -11,27 +11,28 @@ If you succeeded with the [Getting Started tutorial](gettingstarted.html), then
 nuget Fake.DotNet.AssemblyInfo
 nuget Fake.DotNet.MSBuild
 nuget Fake.Core.Target //"
+open Fake.Core
 open Fake.DotNet
 
-Target.Create "BuildApp" (fun _ ->
-    AssemblyInfoFile.CreateCSharp "./src/app/Calculator/Properties/AssemblyInfo.cs"
+Target.create "BuildApp" (fun _ ->
+    AssemblyInfoFile.createCSharp "./src/app/Calculator/Properties/AssemblyInfo.cs"
         [AssemblyInfo.Title "Calculator Command line tool"
             AssemblyInfo.Description "Sample project for FAKE - F# MAKE"
             AssemblyInfo.Guid "A539B42C-CB9F-4a23-8E57-AF4E7CEE5BAA"
             AssemblyInfo.Product "Calculator"
             AssemblyInfo.Version version
             AssemblyInfo.FileVersion version]
 
-    AssemblyInfoFile.CreateFSharp "./src/app/CalculatorLib/Properties/AssemblyInfo.fs"
+    AssemblyInfoFile.createFSharp "./src/app/CalculatorLib/Properties/AssemblyInfo.fs"
         [AssemblyInfo.Title "Calculator library"
             AssemblyInfo.Description "Sample project for FAKE - F# MAKE"
             AssemblyInfo.Guid "EE5621DB-B86B-44eb-987F-9C94BCC98441"
             AssemblyInfo.Product "Calculator"
             AssemblyInfo.Version version
             AssemblyInfo.FileVersion version]
 
-    MSBuild.RunRelease buildDir "Build" appReferences
-        |> Log "AppBuild-Output: "
+    MSBuild.runRelease id buildDir "Build" appReferences
+        |> Trace.logItems "AppBuild-Output: "
 )
 ```
 
@@ -43,7 +44,7 @@ The version parameter can be declared as a property or fetched from a build serv
 
 ```fsharp
 let version =
-  match buildServer with
+  match BuildServer.buildServer with
   | TeamCity -> buildVersion
   | _ -> "0.2"
 ```

diff --git a/help/templates/template.cshtml b/help/templates/template.cshtml
@@ -81,7 +81,6 @@
 															<a href="@(prefix)core.html">Core</a>
 															<ul>
 																<li><a href="@(prefix)core-targets.html">Targets</a></li>
-																<li><a href="@(prefix)apidocs/fake-core-globbing-operators.html">Globbing</a></li>
 																<li><a href="@(prefix)apidocs/fake-core-environment.html.html">Environment</a></li>
 																<li><a href="@(prefix)core-process.html">Process</a></li>
 																<li><a href="@(prefix)apidocs/fake-core-string.html">String</a></li>
@@ -97,6 +96,7 @@
 															<a href="@(prefix)apidocs/index.html#Fake.IO">IO</a>
 															<ul>
 																<li><a href="@(prefix)apidocs/index.html#Fake.IO">FileSystem</a></li>
+																<li><a href="@(prefix)apidocs/fake-io-globbing-operators.html">Globbing</a></li>
 																<li><a href="@(prefix)apidocs/fake-io-zip.html#Functions and values">Zip</a></li>
 															</ul>
 														</li>

diff --git a/src/app/Fake.IO.FileSystem/GlobbingFileSystem.fs b/src/app/Fake.IO.FileSystem/GlobbingFileSystem.fs
@@ -162,6 +162,42 @@ module FileIncludes =
     [<System.Obsolete("Please use GlobbingPattern instead")>]
     let SetBaseDir (dir : string) (fileIncludes : IGlobbingPattern) = GlobbingPattern.setBaseDir dir fileIncludes
 
+/// Contains operators to find and process files.
+/// 
+/// ### Simple glob using as list
+///
+///     #r "paket: nuget Fake.IO.FileSystem //"
+///     open Fake.IO.Globbing.Operators
+///     let csProjectFiles = !! "src/*.csproj"
+///     
+///     for projectFile in csProjectFiles do
+///         printf "F# ProjectFile: %s" projectFile
+///
+/// ### Combine globs
+///
+///     #r "paket: nuget Fake.IO.FileSystem //"
+///     open Fake.IO.Globbing.Operators
+///     let projectFiles =
+///         !! "src/*/*.*proj"
+///         ++ "src/*/*.target"
+///         -- "src/*/*.vbproj"
+///     
+///     for projectFile in projectFiles do
+///         printf "ProjectFile: %s" projectFile
+///
+/// ### Forward globs to tasks
+///
+///     #r "paket:
+///     nuget Fake.Core.Target
+///     nuget Fake.IO.FileSystem //"
+///     open Fake.Core
+///     open Fake.IO
+///     open Fake.IO.Globbing.Operators
+///     Target.create "Clean" (fun _ ->
+///        !! "src/*/*/obj/**/*.nuspec"
+///        |> File.deleteAll
+///     )
+///
 module Operators =
     /// Add Include operator
     let inline (++) (x : IGlobbingPattern) pattern = x.And pattern