Skip to content

Commit a09bae2

Browse files
authored
Merge pull request #892 from dsyme/docs4
Docs update
2 parents 693a866 + 98ad016 commit a09bae2

File tree

999 files changed

+111072
-114783
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

999 files changed

+111072
-114783
lines changed

docs/compiler.html

Lines changed: 65 additions & 47 deletions
Large diffs are not rendered by default.

docs/corelib.html

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,9 @@ <h2><a name="Shipping-an-FSharp-Core-with-your-application" class="anchor" href=
4040
include a copy of FSharp.Core.dll as part of your application.</p>
4141
<p>For example, if you build a <code>HostedCompiler.exe</code>, you will normally place an FSharp.Core.dll (say 4.3.1.0) alongside
4242
your <code>HostedCompiler.exe</code>.</p>
43-
<p>If doing dynamic compilation and execution you may also need to include
44-
an FSharp.Core.optdata and FSharp.Core.sigdata, see below for guidance.</p>
4543
<h2><a name="Binding-redirects-for-your-application" class="anchor" href="#Binding-redirects-for-your-application">Binding redirects for your application</a></h2>
4644
<p>The FSharp.Compiler.Service.dll component depends on FSharp.Core 4.4.0.0. Normally your application will target
47-
a later version of FSharp.Core, and you will need a <a href="http://msdn.microsoft.com/en-us/library/7wd6ex19(v=vs.110).aspx">binding redirect</a> to ensure
45+
a later version of FSharp.Core, and you may need a <a href="http://msdn.microsoft.com/en-us/library/7wd6ex19(v=vs.110).aspx">binding redirect</a> to ensure
4846
that other versions of FSharp.Core forward to the final version of FSharp.Core.dll your application uses.
4947
Binding redirect files are normally generated automatically by build tools. If not, you can use one like this
5048
(if your tool is called <code>HostedCompiler.exe</code>, the binding redirect file is called <code>HostedCompiler.exe.config</code>)</p>
@@ -125,23 +123,12 @@ <h2><a name="What-about-if-I-am-processing-a-script-or-using" class="anchor" hre
125123
<li>
126124
<p>If there is no static reference to FSharp.Core in the host assembly, then</p>
127125
<ul>
128-
<li>For FSharp.Compiler.Service 0.x series, a reference to FSharp.Core version 4.3.0.0 is added</li>
129-
<li>For FSharp.Compiler.Service 1.3.1.x (F# 3.1 series), a reference to FSharp.Core version 4.3.1.0 is added</li>
130-
<li>For FSharp.Compiler.Service 1.4.0.x (F# 4.0 series), a reference to FSharp.Core version 4.4.0.0 is added</li>
126+
<li>For FSharp.Compiler.Service 1.4.0.x above (F# 4.0 series), a reference to FSharp.Core version 4.4.0.0 is added</li>
131127
</ul>
132128
</li>
133129
</ol>
134130
<h2><a name="Do-I-need-to-include-FSharp-Core-optdata-and-FSharp-Core-sigdata" class="anchor" href="#Do-I-need-to-include-FSharp-Core-optdata-and-FSharp-Core-sigdata">Do I need to include FSharp.Core.optdata and FSharp.Core.sigdata?</a></h2>
135-
<p>If your compilation arguments explicitly reference an FSharp.Core.dll from an SDK location, then FSharp.Core.sigdata and FSharp.Core.optdata should be alongside the DLL
136-
(if these files are not installed, then that's a bug in the F# SDK installation). If your compilation
137-
arguments are always making an explicit reference, then you should <em>not</em> include FSharp.Core.optdata and FSharp.Core.sigdata as part of your application.</p>
138-
<p>If you are relying on an implicit reference (e.g. for script processing, see above), this means your tool may reference the FSharp.Core.dll
139-
that is part of your application. In this case, you may either get an error that FSharp.Core.optdata and FSharp.Core.sigdata are not
140-
found alongside FSharp.Core.dll. <strong>If you want to implicitly reference the FSharp.Core.dll you are including in your application,
141-
then also add FSharp.Core.sigdata and FSharp.Core.optdata as two additional files to your application</strong>. When using <code>CompileToDynamicAssembly</code>, this problem
142-
can also manifest itself as <a href="https://github.com/fsharp/FSharp.Compiler.Service/issues/258">a stack overflow during assembly resolution</a>.</p>
143-
<p>Tools that dynamically compile and execute code (e.g. a <code>HostedExecution.exe</code>) often make an implicit
144-
reference to FSharp.Core.dll, which means they normally also include FSharp.Core.optdata and FSharp.Core.sigdata.</p>
131+
<p>No, unless you are doing something with very old FSharp.Core.dll.</p>
145132
<h2><a name="Summary" class="anchor" href="#Summary">Summary</a></h2>
146133
<p>In this design note we have discussed three things:</p>
147134
<ul>

docs/devnotes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ <h2><a name="Building-and-NuGet" class="anchor" href="#Building-and-NuGet">Build
7676
<td class="snippet"><pre class="fssnip"><code lang="text">git clone https://github.com/fsharp/FSharp.Compiler.Service
7777
cd FSharp.Compiler.Service
7878
</code></pre></td></tr></table>
79-
<p>Now follow build everything by running <code>.\fcs\build.cmd</code> (Windows) or <code>./fcs/build.sh</code> (Linux + Mac OS).
79+
<p>Now follow build everything by running <code>build.cmd</code> (Windows) or <code>build.sh</code> (Linux + Mac OS).
8080
The output will be located in the <code>bin</code> directory. If you also wish to build the documentation
8181
and NuGet package, run <code>build Release</code> (this also attempts to publish the documentation to
8282
GitHub, which only works if you have access to the GitHub repository).</p>

0 commit comments

Comments
 (0)