Skip to content

Commit

Permalink
doc: add warning to crosstool.rst and fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
Jay Conrod committed Apr 29, 2020
1 parent f1fabaf commit 2845382
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions go/crosstool.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,33 @@ Configuring a custom C toolchain
================================

.. External links are here
.. _Configuring CROSSTOOL: https://docs.bazel.build/versions/master/tutorial/crosstool.html
.. _Understanding CROSSTOOL: https://docs.bazel.build/versions/master/crosstool-reference.html
.. _Yet Another CROSSTOOL Writing Tutorial: https://github.com/bazelbuild/bazel/wiki/Yet-Another-CROSSTOOL-Writing-Tutorial
.. _Configuring CROSSTOOL: https://docs.bazel.build/versions/0.23.0/tutorial/crosstool.html
.. _Understanding CROSSTOOL: https://docs.bazel.build/versions/0.23.0/crosstool-reference.html
.. _Configuring C++ toolchains: https://docs.bazel.build/versions/master/tutorial/cc-toolchain-config.html
.. _cc_library: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library
.. _crosstool_config.proto: https://github.com/bazelbuild/bazel/blob/master/src/main/protobuf/crosstool_config.proto
.. _go_binary: go/core.rst#go_binary
.. _go_library: go/core.rst#go_library
.. _toolchain: https://docs.bazel.build/versions/master/be/platform.html#toolchain
.. _#1642: https://github.com/bazelbuild/rules_go/issues/1642

References
----------

* `Configuring CROSSTOOL`_
* `Understanding CROSSTOOL`_
* `Yet Another CROSSTOOL Writing Tutorial`_
* `Configuring C++ toolchains`_

Introduction
------------

.. warning:
This documentation is out of date. Some of the linked Bazel documentation
has been deleted in later versions, and there are a number of TODOs.
In particular, building and configuring a cross-compiling C++ toolchain
and testing it with cgo should be covered. `#1642`_ tracks progress
on this.
The Go toolchain sometimes needs access to a working C/C++ toolchain in order to
produce binaries that contain cgo code or require external linking. rules_go
uses whatever C/C++ toolchain Bazel is configured to use. This means
Expand Down

0 comments on commit 2845382

Please sign in to comment.