Skip to content

Getting Started

Jump to bottom
Kevin P. Fleming edited this page Nov 12, 2012 · 19 revisions

Getting Started with BSL

Obtaining the BSL source code

There are two mechanisms available to obtain the BSL source code from GitHub: cloning the repository, and downloading a GitHub-produced snapshot (in a TAR or ZIP file).

  • Cloning the repository requires a local Git installation on your computer, but is otherwise a straightforward process.

  • Downloading a snapshot can be done from the GitHub web interface. The file will have a very long name as GitHub includes the full SHA-1 digest of the most recent commit included in the snapshot. When you unpack the file, the unpacking tool will probably create a subdirectory with this long name; while this is useful for keeping track of the specific code version in that directory, it can cause the BSL build process to fail (because the build system uses absolute paths and most operating systems have length limits on pathnames). If you choose this option, after unpacking the file you should rename the directory to a shorter name to avoid this problem.

Build System

BSL uses a meta build system called Generate Your Projects, also known as gyp. This tool is used to generate a native build system for the platform you choose to build on. It can generate GNU-style Makefiles, Visual Studio project files, Xcode project files and more.

Build Configurations and Options

BSL can be built in two configurations, Debug and Release. Debug configuration builds are unoptimized and include debugging symbols in the resulting binaries. Release configuration builds are optimized and do not include debugging symbols.

In addition, BSL has a build option called "Safe mode". Safe mode builds (which can be combined with either Debug or Release configurations) enable additional debugging code in the libraries themselves. See [this] page for more details on Safe mode.

Building BSL

  • To build BSL on a supported GNU/Linux distribution, follow these instructions.

  • To build BSL on Microsoft Windows, follow these instructions.

  • To build BSL on Apple Mac OS X, follow these instructions.

  • To build BSL on Oracle Solaris, follow these instructions.

  • To build BSL on IBM AIX, follow these instructions.

  • To build BSL on FreeBSD, follow these instructions.

Known Issues

See the issue tracker and the Known Issues page for documentation of any known issues building, testing or using BSL on its supported platforms.

Creative Commons License  BSL Wiki by Bloomberg Finance L.P. is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.

Content

Release Notes

Documentation

Clone this wiki locally