OVMS3-idf/docs/en/get-started-cmake/macos-setup-scratch.rst

***********************************************
Setup Toolchain for Mac OS from Scratch (CMake)
***********************************************

:link_to_translation:`zh_CN:[中文]`

.. include:: ../cmake-warning.rst

Package Manager
===============

To set up the toolchain from scratch, rather than :doc:`downloading a pre-compiled toolchain<macos-setup>`, you will need to install either the MacPorts_ or homebrew_ package manager.

MacPorts needs a full XCode installation, while homebrew only needs XCode command line tools.

    .. _homebrew: https://brew.sh/
    .. _MacPorts: https://www.macports.org/install.php

See :ref:`Customized Setup of Toolchain <get-started-customized-setup>` section for some of the reasons why installing the toolchain from scratch may be necessary.

Install Prerequisites
=====================

- install pip::

    sudo easy_install pip

- install pyserial::

    pip install --user pyserial

- install CMake & Ninja build:

  - If you have HomeBrew, you can run::

      brew install cmake ninja

  - If you have MacPorts, you can run::

      sudo port install cmake ninja

Compile the Toolchain from Source
=================================

- Install dependencies:

  - with MacPorts::

        sudo port install gsed gawk binutils gperf grep gettext wget libtool autoconf automake make

  - with homebrew::

        brew install gnu-sed gawk binutils gperftools gettext wget help2man libtool autoconf automake make

Create a case-sensitive filesystem image::

    hdiutil create ~/esp/crosstool.dmg -volname "ctng" -size 10g -fs "Case-sensitive HFS+"

Mount it::

    hdiutil mount ~/esp/crosstool.dmg

Create a symlink to your work directory::

    mkdir -p ~/esp
    ln -s /Volumes/ctng ~/esp/ctng-volume

Go into the newly created directory::

    cd ~/esp/ctng-volume

Download ``crosstool-NG`` and build it:

.. include:: /_build/inc/scratch-build-code.inc

Build the toolchain::

    ./ct-ng xtensa-esp32-elf
    ./ct-ng build
    chmod -R u+w builds/xtensa-esp32-elf

Toolchain will be built in ``~/esp/ctng-volume/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup <setup-macos-toolchain-add-it-to-path-cmake>` to add the toolchain to your ``PATH``.


Next Steps
==========

To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf-cmake`.
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00			`***********************************************`
			`Setup Toolchain for Mac OS from Scratch (CMake)`
			`***********************************************`

1.Update 8 English cmake files 2.Provide Chinese translation to these 8 cmake files 2018-11-06 04:02:21 +00:00			:link_to_translation:`zh_CN:[中文]`

docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00			`.. include:: ../cmake-warning.rst`

			`Package Manager`
			`===============`

			To set up the toolchain from scratch, rather than :doc:`downloading a pre-compiled toolchain<macos-setup>`, you will need to install either the MacPorts_ or homebrew_ package manager.

			`MacPorts needs a full XCode installation, while homebrew only needs XCode command line tools.`

			`.. _homebrew: https://brew.sh/`
			`.. _MacPorts: https://www.macports.org/install.php`

docs: fix instructions for building toolchain on macOS Closes https://github.com/espressif/esp-idf/issues/503 Closes https://github.com/espressif/esp-idf/issues/2607 2018-10-22 05:45:09 +00:00			See :ref:`Customized Setup of Toolchain <get-started-customized-setup>` section for some of the reasons why installing the toolchain from scratch may be necessary.

docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00			`Install Prerequisites`
			`=====================`

			`- install pip::`

			`sudo easy_install pip`

			`- install pyserial::`

Encourage to install python packages without administrative rights Using 'sudo pip install' can cause a lot of problems because usually there are a couple of Python interpreters installed. This fix encourages developers to use `pip install --user` instead which is safer. 2018-09-07 07:14:05 +00:00			`pip install --user pyserial`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
			`- install CMake & Ninja build:`

			`- If you have HomeBrew, you can run::`

			`brew install cmake ninja`

			`- If you have MacPorts, you can run::`

			`sudo port install cmake ninja`

			`Compile the Toolchain from Source`
			`=================================`

			`- Install dependencies:`

			`- with MacPorts::`

			`sudo port install gsed gawk binutils gperf grep gettext wget libtool autoconf automake make`

			`- with homebrew::`

			`brew install gnu-sed gawk binutils gperftools gettext wget help2man libtool autoconf automake make`

			`Create a case-sensitive filesystem image::`

			`hdiutil create ~/esp/crosstool.dmg -volname "ctng" -size 10g -fs "Case-sensitive HFS+"`

			`Mount it::`

			`hdiutil mount ~/esp/crosstool.dmg`

			`Create a symlink to your work directory::`

docs: fix instructions for building toolchain on macOS Closes https://github.com/espressif/esp-idf/issues/503 Closes https://github.com/espressif/esp-idf/issues/2607 2018-10-22 05:45:09 +00:00			`mkdir -p ~/esp`
			`ln -s /Volumes/ctng ~/esp/ctng-volume`

			`Go into the newly created directory::`

			`cd ~/esp/ctng-volume`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
docs: fix instructions for building toolchain on macOS Closes https://github.com/espressif/esp-idf/issues/503 Closes https://github.com/espressif/esp-idf/issues/2607 2018-10-22 05:45:09 +00:00			Download ``crosstool-NG`` and build it:
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
docs: fix instructions for building toolchain on macOS Closes https://github.com/espressif/esp-idf/issues/503 Closes https://github.com/espressif/esp-idf/issues/2607 2018-10-22 05:45:09 +00:00			`.. include:: /_build/inc/scratch-build-code.inc`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
			`Build the toolchain::`

			`./ct-ng xtensa-esp32-elf`
			`./ct-ng build`
			`chmod -R u+w builds/xtensa-esp32-elf`

docs: fix instructions for building toolchain on macOS Closes https://github.com/espressif/esp-idf/issues/503 Closes https://github.com/espressif/esp-idf/issues/2607 2018-10-22 05:45:09 +00:00			Toolchain will be built in ``~/esp/ctng-volume/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup <setup-macos-toolchain-add-it-to-path-cmake>` to add the toolchain to your ``PATH``.
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00

			`Next Steps`
			`==========`

Introduced installation steps to improve navigation through the installation process. Included some updates from GNU make section. 2019-02-04 20:51:50 +00:00			To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf-cmake`.