Skip to content

Commit

Permalink
- document skip_x64_x86 flag (tools.cross_building) (conan-io#1445)
Browse files Browse the repository at this point in the history
Signed-off-by: SSE4 <[email protected]>
  • Loading branch information
SSE4 authored and danimtb committed Oct 21, 2019
1 parent 31e503e commit d773138
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion reference/tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -766,7 +766,7 @@ tools.cross_building()

.. code-block:: python
def cross_building(settings, self_os=None, self_arch=None)
def cross_building(settings, self_os=None, self_arch=None, skip_x64_x86=False)
Reading the settings and the current host machine it returns ``True`` if we are cross building a Conan package:

Expand All @@ -781,6 +781,9 @@ Parameters:
- **settings** (Required): Conanfile settings. Use ``self.settings``.
- **self_os** (Optional, Defaulted to ``None``): Current operating system where the build is being done.
- **self_arch** (Optional, Defaulted to ``None``): Current architecture where the build is being done.
- **skip_x64_x86** (Optional, Defaulted to ``False``): Do not consider building for ``x86`` host from ``x86_64`` build machine
as cross building, in case of host and build machine use the same operation system. Normally, in such case build machine may
execute binaries produced for the target machine, and special cross-building handling may not be needed.

.. _tools_get_gnu_triplet:

Expand Down

0 comments on commit d773138

Please sign in to comment.