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

***********************************************
Setup Toolchain for Mac OS from Scratch
***********************************************

:link_to_translation:`zh_CN:[中文]`

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 dfu-util

  - If you have MacPorts, you can run::

      sudo port install cmake ninja dfu-util

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-file:: inc/scratch-build-code.inc

Build the toolchain::

    ./ct-ng {IDF_TARGET_TOOLCHAIN_PREFIX}
    ./ct-ng build
    chmod -R u+w builds/{IDF_TARGET_TOOLCHAIN_PREFIX}

Toolchain will be built in ``~/esp/ctng-volume/crosstool-NG/builds/{IDF_TARGET_TOOLCHAIN_PREFIX}``. To use it, you need to add ``~/esp/ctng-volume/crosstool-NG/builds/{IDF_TARGET_TOOLCHAIN_PREFIX}/bin`` to ``PATH`` environment variable.

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

To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00			`***********************************************`
docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used 2019-06-25 01:26:53 +00:00			`Setup Toolchain for Mac OS from Scratch`
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00			`***********************************************`

Included missing links between English and Chinese documentation, where translation into Chinese is available 2019-01-27 18:01:34 +00:00			:link_to_translation:`zh_CN:[中文]`
Getting started guides 2017-03-26 22:01:52 +00:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00			`Package Manager`
			`===============`

Doc/update CN translation for files on setting up toolchain from scratch in get started 2020-11-30 09:58:27 +00:00			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.
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00
Doc/update CN translation for files on setting up toolchain from scratch in get started 2020-11-30 09:58:27 +00:00			`MacPorts needs a full XCode installation, while Homebrew only needs XCode command line tools.`
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00
Doc/update CN translation for files on setting up toolchain from scratch in get started 2020-11-30 09:58:27 +00:00			`.. _Homebrew: https://brew.sh/`
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00			`.. _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.
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
Getting started guides 2017-03-26 22:01:52 +00:00			`Install Prerequisites`
			`=====================`

			`- install pip::`

			`sudo easy_install pip`

docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00			`- install pyserial::`
Getting started guides 2017-03-26 22:01:52 +00:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00			`pip install --user pyserial`

			`- install CMake & Ninja build:`

Doc/update CN translation for files on setting up toolchain from scratch in get started 2020-11-30 09:58:27 +00:00			`- If you have Homebrew, you can run::`
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00
Add build system support for programming ESP32-S2 using DFU utils 2020-04-06 14:41:44 +00:00			`brew install cmake ninja dfu-util`
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00
			`- If you have MacPorts, you can run::`

Add build system support for programming ESP32-S2 using DFU utils 2020-04-06 14:41:44 +00:00			`sudo port install cmake ninja dfu-util`
Getting started guides 2017-03-26 22:01:52 +00:00
			`Compile the Toolchain from Source`
			`=================================`

docs: update all documents in get started section and keep line number consistent 2021-07-22 07:54:47 +00:00			`Install dependencies:`
Getting started guides 2017-03-26 22:01:52 +00:00
			`- with MacPorts::`

docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00			`sudo port install gsed gawk binutils gperf grep gettext wget libtool autoconf automake make`
Getting started guides 2017-03-26 22:01:52 +00:00
Doc/update CN translation for files on setting up toolchain from scratch in get started 2020-11-30 09:58:27 +00:00			`- with Homebrew::`
Getting started guides 2017-03-26 22:01:52 +00:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-25 01:29:49 +00:00			`brew install gnu-sed gawk binutils gperftools gettext wget help2man libtool autoconf automake make`
Getting started guides 2017-03-26 22:01:52 +00:00
			`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`
Getting started guides 2017-03-26 22:01:52 +00:00
docs: generate toolchain download links 2018-08-29 13:30:03 +00:00			Download ``crosstool-NG`` and build it:
Getting started guides 2017-03-26 22:01:52 +00:00
docs: add new top-level docs builder that builds docs for a single chip 2019-11-13 03:46:16 +00:00			`.. include-build-file:: inc/scratch-build-code.inc`
Getting started guides 2017-03-26 22:01:52 +00:00
			`Build the toolchain::`

docs: initial update of programming guide for C3 Updates "front page" content, get-started, and api-guides with C3 content Enable building and publishing of C3 docs in CI 2021-01-27 02:12:58 +00:00			`./ct-ng {IDF_TARGET_TOOLCHAIN_PREFIX}`
Getting started guides 2017-03-26 22:01:52 +00:00			`./ct-ng build`
docs: initial update of programming guide for C3 Updates "front page" content, get-started, and api-guides with C3 content Enable building and publishing of C3 docs in CI 2021-01-27 02:12:58 +00:00			`chmod -R u+w builds/{IDF_TARGET_TOOLCHAIN_PREFIX}`
Getting started guides 2017-03-26 22:01:52 +00:00
docs: initial update of programming guide for C3 Updates "front page" content, get-started, and api-guides with C3 content Enable building and publishing of C3 docs in CI 2021-01-27 02:12:58 +00:00			Toolchain will be built in ``~/esp/ctng-volume/crosstool-NG/builds/{IDF_TARGET_TOOLCHAIN_PREFIX}``. To use it, you need to add ``~/esp/ctng-volume/crosstool-NG/builds/{IDF_TARGET_TOOLCHAIN_PREFIX}/bin`` to ``PATH`` environment variable.
Getting started guides 2017-03-26 22:01:52 +00:00
			`Next Steps`
			`==========`

docs: update all documents in get started section and keep line number consistent 2021-07-22 07:54:47 +00:00			To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.