Browse Source

Update toolchain docs with some changes and features

default_compile_flags
vector-of-bool 5 years ago
parent
commit
ef71ec47e1
1 changed files with 13 additions and 9 deletions
  1. +13
    -9
      docs/guide/toolchains.rst

+ 13
- 9
docs/guide/toolchains.rst View File

This page provides an introduction on how one can make use of toolchains most This page provides an introduction on how one can make use of toolchains most
effectively in your project. effectively in your project.


.. note::
**IMPORTANT**: ``dds`` will *not* automatically load the Visual C++
environment. To use Visual C++, ``dds`` must be executed from the
appropriate environment in order for the Visual C++ toolchain executables
and files to be available.



Passing a Toolchain Passing a Toolchain
******************* *******************
convention. When running a build for a project, the ``dds`` executable will convention. When running a build for a project, the ``dds`` executable will
look for a file named ``toolchain.tc.dds`` by default, and will error out if look for a file named ``toolchain.tc.dds`` by default, and will error out if
this file does not exist. A different toolchain can be provided by passing the this file does not exist. A different toolchain can be provided by passing the
toolchain file for the ``--toolchain`` (or ``-T``) option on the command line::
toolchain file for the ``--toolchain`` (or ``-t``) option on the command line::


$ dds build -T my-toolchain.tc.dds
$ dds build -t my-toolchain.tc.dds


Alternatively, you can pass the name of a built-in toolchain. See below. Alternatively, you can pass the name of a built-in toolchain. See below.




The following pseudo-toolchains are also available: The following pseudo-toolchains are also available:


``:debug:XYZ``
Uses built-in toolchain ``:XYZ``, but generates debugging information.

``:ccache:XYZ`` ``:ccache:XYZ``
Uses built-in toolchain ``:XYZ``, but prefixes all compile commands with Uses built-in toolchain ``:XYZ``, but prefixes all compile commands with
``ccache``. ``ccache``.


.. note::
**IMPORTANT**: ``dds`` will *not* automatically load the Visual C++
environment. To use Visual C++, ``dds`` must be executed from the
appropriate environment in order for the Visual C++ toolchain executables
and files to be available.


``:c++UV:XYZ`` (for two integers ``UV``)
Sets the C++ version to ``C++UV`` and uses the ``:XYZ`` toolchain.

Loading…
Cancel
Save