Permalink
Fetching contributors…
Cannot retrieve contributors at this time
258 lines (153 sloc) 13.9 KB

The F# Compiler, Core Library & Tools

This repository is the F# Software Foundation repository for F#, as described in the mission statement of the Foundation:

The F# Software Foundation... maintains a core open-source F# code repository and distributions made available to the public free of charge for use across multiple platforms. This includes the F# compiler, F# language specification, the F# core library and assorted tools and applications.

The process for contributing to the F# Compiler, Core Library and Tools is described here.

The main day-to-day purpose of this repository is to deliver extra packagings of the F# compiler, core library and core tools for use in different settings. This repo accepts direct contributions related to the cross-platform packaging of F#. Most other contributions to the F# compiler/library/tools go first via the upstream repository which is also used to package the Visual F# Tools and .NET SDK tooling for F#. This repo mirrors the core implementation of the F# language from the upstream repository. This arrangement ensures that versions do not diverge, and that very extensive QA is done on all core contributions.

The F# community use this repo and others to publish these components:

  • FSharp.Compiler.Tools NuGet package (published from this repo)

  • FSharp.Compiler.Service NuGet package (published from derivative repo)

  • Fable, the F# compiler for JavaScript, published from its own repo but using FSharp.Compiler.Service NuGet package

  • “fsharp” Debian Linux packages for F# + Mono (published from derivative repo)

  • “fsharp” as bundled in macOS tooling for F# + Mono by Xamarin and installed either from the Mono Project Download page or via homebrew cask as part of the mono-mdk cask (brew cask install mono-mdk)

  • “fsharp” docker image (published from related repo)

  • “fsharp” homebrew formula (published as part of the mono homebrew formula)

  • other packagings such as: the F# support in Jupyter Notebooks - iFSharp; the F# support in Azure Functions; and WebSharper all using the FSharp.Compiler.Service NuGet package

See notes below for most of these. Because the core logic of F# is made available as a library component, an unlimited number of other packagings of F# are possible. Please contribute additional notes to this README.md if you are packaging F# for other settings.

Contributing to the F# Compiler, Core Library and Tools

If you are using Windows, you should normally fork the upstream repository repo and contribute directly there. Your contributions will then be merged into this repo.

If you are using Linux or macOS, you can contribute directly to upstream repository if you like. Some CI for that repo runs on Linux. Your contributions will then be merged into this repo. Alternatively, you can prepare your contributions by forking this repository (the code is essentially the same). This will give you access to some additional testing available from this repo.

Status

The master branch is for F# 4.x. To bootstrap the compiler, binaries built from an earlier version of this project are used. This codebase uses the Apache 2.0 license.

F# Branch macOS/Linux Windows
4.1+ master Build Status Build status
4.0 fsharp4 Build Status

Details on the various Alternative Packagings

The FSharp.Core NuGet package

The FSharp.Core NuGet package was previously published from this repo. With the informal consent of the F# Software Foundation this package is now published by Microsoft.

  • FSharp.Core.dll for .NET Framework/Mono
  • FSharp.Core.dll for .NET Core
  • FSharp.Core.dll for portable profiles

The FSharp.Core NuGet package includes all of the FSharp.Core redistributables from Visual F#.

The FSharp.Compiler.Tools NuGet package

This repo is currently used to make the FSharp.Compiler.Tools NuGet package. This package includes the following for both .NET Core and .NET Framework/Mono:

  • the F# compiler fsc.exe
  • F# Interactive fsi.exe
  • build support,
  • a copy of FSharp.Core used to run the tools
  • related DLLs.

The NuGet packages are exactly the ones produced by AppVeyor CI, e.g. for version 4.1.2. They are pushed to https://nuget.org by someone with appropriate permissions.

The FSharp.Compiler.Tools NuGet package can be used if you wish to use the latest F# compiler on a computer without relying on the installed version of Visual Studio. Adding it via NuGet to a project will override the in-box compiler with the compiler from the NuGet package. Note: you will need to manually modify your project file once (see https://github.com/fsharp/fsharp/issues/676).

The fsharp Debian Linux Package

Usage: See http://fsharp.org/use/linux

apt-get install fsharp

See the mono packaging repo, which is a downstream variant of this repo, where this package is actually made.

  • There is a tag for each upstream source tag
  • There is a tag for each "debianized" package
  • Packaging metadata lives in debian/
  • install files are files installed to disk
  • cligacinstall are GAC-installed libraries
  • control is the manifest of packages
  • rules is the Makefile which handles build/install.

Jo Shields (@directhex) has done much of this work and says:

I tend to only update the published packages when a) the same update has already been pulled in on Mac by Jason, and either b) something breaks horribly in the existing version on a new Mono, or c) someone explicitly asks me to.

Linux package delivery is (now) based on packages built on our public Jenkins instance, and published automatically as a post-build step, based on two inputs - a Git repository in standard Debian git packaging format (which https://github.com/mono/linux-packaging-fsharp already is), and a tarball to consider as the canonical source of the next release (giving the same tarball in subsequent builds is how you indicate packaging-only changes such as alterations to metadata in debian/)

Alexander Köplinger has admin access to Jenkins, SSH access to the Jenkins and repository servers, and has taken care of things for me in my absence in the past (but isn't a Debian packaging expert, so would be trusting that metadata changes are solid)

F# packaging in Mono + macOS

F# is packaged as part of Mono on macOS. Jason Imison says:

We use a system called BockBuild that pushes versions of F# (sometimes with patches) out with Mono for macOS (F# is bundled with mono here, not a separate package).

You can see an example build script here (if you have access, ping me if not) https://github.com/xamarin/bockbuild/blob/2017-02/packages/fsharp.py. Unfortunately, you need to know the branch name here – 2017-02 is what is going to be released with VS for Mac aka Mono 4.9.x

We build fsharp/fsharp internally so that we’re not dependent on you pushing out fixes / bumping packages. Miguel de Icaza likes to ‘own’ the code that we ship precisely to stop these kind of emergency issues.

@cartermp says:

For future reference, dependencies and code for the F# editing and F# Interactive support in Visual Studio for Mac/Xamarin Studio is here

Package feeds

A feed of NuGet packages from builds is available from AppVeyor using the NuGet feed: https://ci.appveyor.com/nuget/fsgit-fsharp

If using Paket, add the source at the top of paket.dependencies.

source https://www.nuget.org/api/v2
source https://ci.appveyor.com/nuget/fsgit-fsharp

Add the dependency on FSharp.Core and run paket update. See the AppVeyor build history for a list of available versions. Here are some options for specifying the dependency:

nuget FSharp.Core
nuget FSharp.Core prerelease
nuget FSharp.Core 3.1.2.3
nuget FSharp.Core 3.1.2.3-b208

If using NuGet Package Manager, add the source to the list of available package sources.

Available Package Sources

Development Guide

Building on Linux and other Unix systems:

Building F# on Unix-type platforms requires Mono 5.0 or higher.

./autogen.sh --prefix=/usr
make
sudo make install

That build and installs optimized binaries. To make debug, use make CONFIG=debug

Building on macOS

Building on macOS requires an install of the latest Xamarin tools or Mono package. Use a prefix to your version of Mono:

./autogen.sh --prefix=/Library/Frameworks/Mono.framework/Versions/Current/
make
sudo make install

That build and installs optimized binaries. To make debug, use make CONFIG=debug

Building on Windows

Install .NET 4.5.1 and MSBuild 12.0

Build using:

mono\build.bat

This builds the proto compiler, then the library, then the final compiler.

Build Note: Strong Names

The FSharp.Core.dll produced is only delay-signed (Mono does not require strong names). If a strong-name signed FSharp.Core.dll is needed then use the one in

lib\bootstrap\signed\.NETFramework\v4.0\4.3.0.0\FSharp.Core.dll
lib\bootstrap\signed\.NETFramework\v4.0\4.3.1.0\FSharp.Core.dll

Building on Linux (Wheezy build)

vagrant up
vagrant ssh
cd /vagrant
sudo apt-get install dos2unix autoconf
./autogen.sh --prefix=/usr
make
sudo make install

Integrating changes from 'visualfsharp'

To integrate latest changes from https://github.com/Microsoft/visualfsharp, use

git checkout -b integrate
git remote add visualfsharp https://github.com/Microsoft/visualfsharp
git pull visualfsharp master
git rm -fr vsintegration
git rm -fr setup
git rm -fr tests/fsharpqa

There are certain guidelines that need to be followed when integrating changes from upstream:

  • this repository does not undergo the QA test process that upstream does, so the tests/fsharpqa folder and all files within should be removed when merging
  • this repository does not contain any of the Visual Studio tooling or integrations, so the vsintegration directory and all files within should be removed when merging
  • anything referencing FSharp.LaunguageService.Compiler is a Microsoft-internal version of the open FSharp.Compiler.Service repository, and should be removed when merging
  • Windows-specific scripts like update.cmd and runtests.cmd aren't used in this repository, and so should be removed when merging

Continuous Integration Build

A continuous integration build is set up with Travis and AppVeyor. See above.

Editing the Compiler with Visual Studio, Xamarin Studio or MonoDevelop

Historically it is difficult to edit the compiler with Xamarin Studio or MonoDevelop because of bugs in loading the hand-edited project files and targets used in the F# compiler build. These are generally in the process of being fixed, your mileage will vary.

How to Test and Validate

Linux and macOS

Only a subset of the tests are currently enabled.

After building and installing, run

cd tests/fsharp/core
./run-all.sh

Windows

See the TESTGUIDE.md for instructions for how to test on Windows. Use that repository to develop and test on Windows.

History

F# compiler sources as initially dropped are available from fsharppowerpack.codeplex.com.

On 4 April 2014, Microsoft Open Tech published the F# compiler sources at http://visualfsharp.codeplex.com and began accepting contributions to the F# compiler/library and tools.

In 2016 the Microsoft http://visualfsharp.codeplex.com repo moved to GitHub at https://github.com/Microsoft/visualfsharp.

This repository uses bootstrapping libraries, tools and F# compiler. The lib/bootstrap/X.0 directories contain mono-built libraries, compiler and tools that can be used to bootstrap a build. You can also supply your own via the --with-bootstrap option.

Maintainers

The maintainers of this repository appointed by the F# Core Engineering Group are: