sassc 1.8.0.pre2 → 1.8.0

data/ext/libsass/docs/build-shared-library.md

@@ -0,0 +1,35 @@
+This page is mostly intended for people that want to build a system library that gets distributed via RPMs or other means. This is currently in a experimental phase, as we currently do not really guarantee any ABI forward compatibility. The C API was rewritten to make this possible in the future, but we want to wait some more time till we can call this final and stable.
+
+Building via autotools
+--
+
+You want to build a system library only via autotools, since it will create the proper `libtool` files to make it loadable on multiple systems. We hope this works correctly, but nobody of the `libsass` core team has much knowledge in this area. Therefore we are open for comments or improvements by people that have more experience in that matter (like package maintainers from various linux distributions).
+
+```bash
+apt-get install autoconf libtool
+git clone https://github.com/sass/libsass.git
+cd libsass
+autoreconf --force --install
+./configure \
+  --disable-tests \
+  --disable-static \
+  --enable-shared \
+  --prefix=/usr
+make -j5 install
+cd ..
+```
+
+This should install these files
+```bash
+# $ ls -la /usr/lib/libsass.*
+/usr/lib/libsass.la
+/usr/lib/libsass.so -> libsass.so.0.0.9
+/usr/lib/libsass.so.0 -> libsass.so.0.0.9
+/usr/lib/libsass.so.0.0.9
+# $ ls -la /usr/include/sass*
+/usr/include/sass.h
+/usr/include/sass2scss.h
+/usr/include/sass_context.h
+/usr/include/sass_functions.h
+/usr/include/sass_values.h
+```

data/ext/libsass/docs/build-with-autotools.md

@@ -0,0 +1,68 @@
+### Get the sources
+```bash
+# using git is preferred
+git clone https://github.com/sass/libsass.git
+# only needed for sassc and/or testsuite
+git clone https://github.com/sass/sassc.git libsass/sassc
+git clone https://github.com/sass/sass-spec.git libsass/sass-spec
+```
+
+### Create configure script
+```bash
+cd libsass
+autoreconf --force --install
+cd ..
+```
+
+### Create custom makefiles
+```bash
+cd libsass
+./configure \
+  --disable-tests \
+  --disable-shared \
+  --prefix=/usr
+cd ..
+```
+
+### Build the library
+```bash
+make -C libsass -j5
+```
+
+### Install the library
+The library will be installed to the location given as `prefix` to `configure`. This is standard behavior for autotools and not `libsass` specific.
+```bash
+make -C libsass -j5 install
+```
+
+### Configure options
+The `configure` script is created by autotools. To get an overview of available options you can call `./configure --help`. When you execute this script, it will create specific makefiles, which you then use via the regular make command.
+
+There are some `libsass` specific options:
+
+```
+Optional Features:
+  --enable-tests              enable testing the build
+  --enable-coverage           enable coverage report for test suite
+  --enable-shared             build shared libraries [default=yes]
+  --enable-static             build static libraries [default=yes]
+
+Optional Packages:
+  --with-sassc-dir=<dir>      specify directory of sassc sources for
+                              testing (default: sassc)
+  --with-sass-spec-dir=<dir>  specify directory of sass-spec for testing
+                              (default: sass-spec)
+```
+
+### Build sassc and run spec test-suite
+
+```bash
+cd libsass
+autoreconf --force --install
+./configure \
+  --enable-tests \
+  --enable-shared \
+  --prefix=/usr
+make -j5 test_build
+cd ..
+```

data/ext/libsass/docs/build-with-makefiles.md

@@ -0,0 +1,50 @@
+### Get the sources
+```bash
+# using git is preferred
+git clone https://github.com/sass/libsass.git
+# only needed for sassc and/or testsuite
+git clone https://github.com/sass/sassc.git libsass/sassc
+git clone https://github.com/sass/sass-spec.git libsass/sass-spec
+```
+
+### Decide for static or shared library
+
+`libsass` can be built and linked as a `static` or as a `shared` library. The default is `static`. To change it you can set the `BUILD` environment variable:
+
+```bash
+export BUILD="shared"
+```
+
+Alternatively you can also define it directly when calling make:
+
+```bash
+BUILD="shared" make ...
+```
+
+### Compile the library
+```bash
+make -C libsass -j5
+```
+
+### Results can be found in
+```bash
+$ ls libsass/lib
+libsass.a libsass.so
+```
+
+### Compling sassc
+
+```bash
+# Let build know library location
+export SASS_LIBSASS_PATH="`pwd`/libsass"
+# Invokes the sassc makefile
+make -C libsass -j5 sassc
+```
+
+### Run the spec test-suite
+
+```bash
+# needs ruby available
+# also gem install minitest
+make -C libsass -j5 test_build
+```

data/ext/libsass/docs/build-with-mingw.md

@@ -0,0 +1,107 @@
+## Building LibSass with MingGW (makefiles)
+
+First grab the latest [MinGW for windows] [1] installer. Once it is installed, you can click on continue or open the Installation Manager via `bin\mingw-get.exe`.
+
+You need to have the following components installed:
+![](https://cloud.githubusercontent.com/assets/282293/5525466/947bf396-89e6-11e4-841d-4aa916f14de1.png)
+
+Next we need to install [git for windows] [2]. You probably want to check the option to add it to the global path, but you do not need to install the unix tools.
+
+If you want to run the spec test-suite you also need [ruby] [3] and a few gems available. Grab the [latest installer] [3] and make sure to add it the global path. Then install the missing gems:
+
+```bash
+gem install minitest
+```
+
+### Mount the mingw root directory
+
+As mentioned in the [MinGW Getting Started](http://www.mingw.org/wiki/Getting_Started#toc5) guide, you should edit `C:\MinGW\msys\1.0\etc\fstab` to contain the following line:
+
+```
+C:\MinGW   /mingw
+```
+
+### Starting a "MingGW" console
+
+Create a batch file with this content:
+```bat
+@echo off
+set PATH=C:\MinGW\bin;%PATH%
+REM only needed if not already available
+set PATH=%PROGRAMFILES%\git\bin;%PATH%
+REM C:\MinGW\msys\1.0\msys.bat
+cmd
+```
+
+Execute it and make sure these commands can be called: `git`, `mingw32-make`, `rm` and `gcc`! Once this is all set, you should be ready to compile `libsass`!
+
+### Get the sources
+
+```bash
+# using git is preferred
+git clone https://github.com/sass/libsass.git
+# only needed for sassc and/or testsuite
+git clone https://github.com/sass/sassc.git libsass/sassc
+git clone https://github.com/sass/sass-spec.git libsass/sass-spec
+```
+
+### Decide for static or shared library
+
+`libsass` can be built and linked as a `static` or as a `shared` library. The default is `static`. To change it you can set the `BUILD` environment variable:
+
+```bat
+set BUILD="shared"
+```
+
+### Compile the library
+```bash
+mingw32-make -C libsass
+```
+
+### Results can be found in
+```bash
+$ ls libsass/lib
+libsass.a  libsass.dll  libsass.so
+```
+
+### Run the spec test-suite
+```bash
+mingw32-make -C libsass test_build
+```
+
+## Building via MingGW 64bit (makefiles)
+Building libass to dll on window 64bit.
+
+Download [MinGW64 for windows7 64bit](http://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win64/Personal%20Builds/mingw-builds/4.9.2/threads-win32/seh/x86_64-4.9.2-release-win32-seh-rt_v3-rev0.7z/download) and unzip to "C:\mingw64".
+
+Create a batch file with this content:
+
+```bat
+@echo off
+set PATH=C:\mingw64\bin;%PATH%
+set CC=gcc
+REM only needed if not already available
+set PATH=%PROGRAMFILES%\Git\bin;%PATH%
+REM C:\MinGW\msys\1.0\msys.bat
+cmd
+```
+
+By default, mingw64 dll will depends on "​m​i​n​g​w​m​1​0​.​d​l​l​、​ ​l​i​b​g​c​c​_​s​_​d​w​2​-​1​.​d​l​l​", we can modify Makefile to fix this:(add "-static")
+
+``` bash
+lib/libsass.dll: $(COBJECTS) $(OBJECTS) $(RCOBJECTS)
+	$(MKDIR) lib
+	$(CXX) -shared $(LDFLAGS) -o $@ $(COBJECTS) $(OBJECTS) $(RCOBJECTS) $(LDLIBS) -s -static -Wl,--subsystem,windows,--out-implib,lib/libsass.a
+```
+
+Compile the library
+
+```bash
+mingw32-make -C libsass
+```
+
+By the way, if you are using java jna, [JNAerator](http://jnaerator.googlecode.com/) is a good tool.
+
+[1]: http://sourceforge.net/projects/mingw/files/latest/download?source=files
+[2]: https://msysgit.github.io/
+[3]: http://rubyinstaller.org/

data/ext/libsass/docs/build-with-visual-studio.md

@@ -0,0 +1,90 @@
+## Building LibSass with Visual Studio
+
+### Requirements:
+
+The minimum requirement to build LibSass with Visual Studio is "Visual Studio 2013 Express for Desktop".
+
+Additionally, it is recommended to have `git` installed and available in `PATH`, so to deduce the `libsass` version information. For instance, if GitHub for Windows (https://windows.github.com/) is installed, the `PATH` will have an entry resembling: `X:\Users\<YOUR_NAME>\AppData\Local\GitHub\PortableGit_<SOME_GUID>\cmd\` (where `X` is the drive letter of system drive). If `git` is not available, inquiring the LibSass version will result in `[NA]`.
+
+### Build Steps:
+
+#### From Visual Studio:
+
+On opening the `win\libsass.sln` solution and build (Ctrl+Shift+B) to build `libsass.dll`.
+
+To Build LibSass as a static Library, it is recommended to set an environment variable `LIBSASS_STATIC_LIB` before launching the project:
+
+```cmd
+cd path\to\libsass
+SET LIBSASS_STATIC_LIB=1
+::
+:: or in PowerShell:
+:: $env:LIBSASS_STATIC_LIB=1
+::
+win\libsass.sln
+```
+
+Visual Studio will form the filtered source tree as shown below:
+
+![image](https://cloud.githubusercontent.com/assets/3840695/9298985/aae9e072-44bf-11e5-89eb-e7995c098085.png)
+
+`Header Files` contains the .h and .hpp files, while `Source Files` covers `.c` and `.cpp`. The other used headers/sources will appear under `External Dependencies`.
+
+If there is a LibSass code file appearing under External Dependencies, it can be changed by altering the `win\libsass.vcxproj.filters` file or dragging in Solution Explorer.
+
+#### From Command Prompt:
+
+Notice that in the following commands:
+
+* If the platform is 32-bit Windows, replace `ProgramFiles(x86)` with `ProgramFiles`.
+* To build with Visual Studio 2015, replace `12.0` with `14.0` in the aforementioned command.
+
+Open a command prompt:
+
+To build dynamic/shared library (`libsass.dll`):
+
+```cmd
+:: debug build:
+"%ProgramFiles(x86)%\MSBuild\12.0\Bin\MSBuild" win\libsass.sln
+
+:: release build:
+"%ProgramFiles(x86)%\MSBuild\12.0\Bin\MSBuild" win\libsass.sln ^
+/p:Configuration=Release
+```
+
+To build static library (`libsass.lib`):
+
+```cmd
+:: debug build:
+"%ProgramFiles(x86)%\MSBuild\12.0\Bin\MSBuild" win\libsass.sln ^
+/p:LIBSASS_STATIC_LIB=1
+
+:: release build:
+"%ProgramFiles(x86)%\MSBuild\12.0\Bin\MSBuild" win\libsass.sln ^
+/p:LIBSASS_STATIC_LIB=1 /p:Configuration=Release
+```
+
+#### From PowerShell:
+
+To build dynamic/shared library (`libsass.dll`):
+
+```powershell
+# debug build:
+&"${env:ProgramFiles(x86)}\MSBuild\12.0\Bin\MSBuild" win\libsass.sln
+
+# release build:
+&"${env:ProgramFiles(x86)}\MSBuild\12.0\Bin\MSBuild" win\libsass.sln `
+/p:Configuration=Release
+```
+
+To build static library (`libsass.lib`):
+
+```powershell
+# build:
+&"${env:ProgramFiles(x86)}\MSBuild\12.0\Bin\MSBuild" win\libsass.sln `
+/p:LIBSASS_STATIC_LIB=1
+
+# release build:
+&"${env:ProgramFiles(x86)}\MSBuild\12.0\Bin\MSBuild" win\libsass.sln `
+/p:LIBSASS_STATIC_LIB=1 /p:Configuration=Release
+```

data/ext/libsass/docs/build.md

@@ -0,0 +1,97 @@
+`libsass` is only a library and does not do much on its own. You need an implementation that you can use from the [command line] [6]. Or some [[bindings|Implementations]] to use it within your favorite programming language. You should be able to get [`sassc`] [6] running by following the instructions in this guide.
+
+Before starting, see [setup dev environment](setup-environment.md).
+
+Building on different Operating Systems
+--
+
+We try to keep the code as OS independent and standard compliant as possible. Reading files from the file-system has some OS depending code, but will ultimately fall back to a posix compatible implementation. We do use some `C++11` features, but are so far only committed to use `unordered_map`. This means you will need a pretty recent compiler on most systems (gcc 4.5 seems to be the minimum).
+
+### Building on Linux (and other *nix flavors)
+
+Linux is the main target for `libsass` and we support two ways to build `libsass` here. The old plain makefiles should still work on most systems (including MinGW), while the autotools build is preferred if you want to create a [system library] (experimental).
+
+- [Building with makefiles] [1]
+- [Building with autotools] [2]
+
+### Building on Windows (experimental)
+
+Windows build support was added very recently and should be considered experimental. Credits go to @darrenkopp and @am11 for their work on getting `libsass` and `sassc` to compile with visual studio!
+
+- [Building with MinGW] [3]
+- [Building with Visual Studio] [11]
+
+### Building on Max OS X (untested)
+
+Works the same as on linux, but you can also install LibSass via `homebrew`.
+
+- [Building on Mac OS X] [10]
+
+### Building a system library (experimental)
+
+Since `libsass` is a library, it makes sense to install it as a shared library on your system. On linux this means creating a `.so` library via autotools. This should work pretty well already, but we are not yet committed to keep the ABI 100% stable. This should be the case once we increase the version number for the library to 1.0.0 or higher. On Windows you should be able get a `dll` by creating a shared build with MinGW. There is currently no target in the MSVC project files to do this.
+
+- [Building shared system library] [4]
+
+Compiling with clang instead of gcc
+--
+
+To use clang you just need to set the appropriate environment variables:
+
+```bash
+export CC=/usr/bin/clang
+export CXX=/usr/bin/clang++
+```
+
+Running the spec test-suite
+--
+
+We constantly and automatically test `libsass` against the official [spec test-suite] [5]. To do this we need to have a test-runner (which is written in ruby) and a command-line tool ([`sassc`] [6]) to run the tests. Therefore we need to additionally compile `sassc`. To do this, the build files of all three projects need to work together. This may not have the same quality for all build flavors. You definitely need to have ruby (2.1?) installed (version 1.9 seems to cause problems at least on windows). You also need some gems installed:
+
+```bash
+ruby -v
+gem install minitest
+# should be optional
+gem install minitap
+```
+
+Including the LibSass version
+--
+
+There is a function in `libsass` to query the current version. This has to be defined at compile time. We use a C macro for this, which can be defined by calling `g++ -DLIBSASS_VERSION="\"x.y.z.\""`. The two quotes are necessary, since it needs to end up as a valid C string. Normally you do not need to do anything if you use the makefiles or autotools. They will try to fetch the version via git directly. If you only have the sources without the git repo, you can pass the version as an environment variable to `make` or `configure`:
+
+```
+export LIBSASS_VERSION="x.y.z."
+```
+
+Continuous Integration
+--
+
+We use two CI services to automatically test all commits against the latest [spec test-suite] [5].
+
+- [LibSass on Travis-CI (linux)][7]
+[![Build Status](https://travis-ci.org/sass/libsass.png?branch=master)](https://travis-ci.org/sass/libsass)
+- [LibSass on AppVeyor (windows)][8]
+[![Build status](https://ci.appveyor.com/api/projects/status/github/sass/libsass?svg=true)](https://ci.appveyor.com/project/mgreter/libsass-513/branch/master)
+
+Why not using CMake?
+--
+
+There were some efforts to get `libsass` to compile with CMake, which should make it easier to create build files for linux and windows. Unfortunately this was not completed. But we are certainly open for PRs!
+
+Miscellaneous
+--
+
+- [Ebuilds for Gentoo Linux](build-on-gentoo.md)
+
+[1]: build-with-makefiles.md
+[2]: build-with-autotools.md
+[3]: build-with-mingw.md
+[4]: build-shared-library.md
+[5]: https://github.com/sass/sass-spec
+[6]: https://github.com/sass/sassc
+[7]: https://github.com/sass/libsass/blob/master/.travis.yml
+[8]: https://github.com/sass/libsass/blob/master/appveyor.yml
+[9]: implementations.md
+[10]: build-on-darwin.md
+[11]: build-with-visual-studio.md