rules_foreign_cc/README.md

# rules_foreign_cc

[![Build status](https://badge.buildkite.com/c28afbf846e2077715c753dda1f4b820cdcc46cc6cde16503c.svg?branch=main)](https://buildkite.com/bazel/rules-foreign-cc?branch=main)

**Rules for building C/C++ projects using foreign build systems inside Bazel projects.**

This is **not an officially supported Google product**
(meaning, support and/or new releases may be limited.)

## Documentation

Documentation for all rules and providers are available at: https://bazelbuild.github.io/rules_foreign_cc/

## Bazel versions compatibility

Works with Bazel after 5.4.0.

Note that the rules may be compatible with older versions of Bazel but support may break
in future changes as these older versions are not tested.

Note also that the `runnable_binary` macro requires bazel 5.4.0, for the `rlocationpath` [path
variable](https://bazel.build/reference/be/make-variables)

## News

For more generalized updates, please see [NEWS.md](./NEWS.md) or checkout the
[release notes](https://github.com/bazelbuild/rules_foreign_cc/releases) of current or previous releases

## Design document

[External C/C++ libraries rules](https://docs.google.com/document/d/1Gv452Vtki8edo_Dj9VTNJt5DA_lKTcSMwrwjJOkLaoU/edit?usp=sharing)

[ccb]: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_binary
[ccl]: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library
[cct]: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_toolchain

## Caveats

* FreeBSD support is currently experimental and on a best-effort basis.
  Google currently doesn't have a CI test environment for FreeBSD,
  but please make your voice heard by upvoting this
  [issue](https://github.com/bazelbuild/continuous-integration/issues/258).
first commit 2018-04-25 02:17:47 +00:00			`# rules_foreign_cc`
Created a `./docs` directory to house documentation (#466) * Added links to docs to top level README * Updated more docs * Added generated header 2021-01-24 23:23:19 +00:00
Updated `master` -> `main` (#504) 2021-02-12 23:05:18 +00:00			`[![Build status](https://badge.buildkite.com/c28afbf846e2077715c753dda1f4b820cdcc46cc6cde16503c.svg?branch=main)](https://buildkite.com/bazel/rules-foreign-cc?branch=main)`
Add code and examples (#1) 2018-04-26 17:52:06 +00:00
Remove experimental disclaimer. Fixes #307. (#316) 2019-10-23 14:06:34 +00:00			`Rules for building C/C++ projects using foreign build systems inside Bazel projects.`
Add code and examples (#1) 2018-04-26 17:52:06 +00:00
Remove experimental disclaimer. Fixes #307. (#316) 2019-10-23 14:06:34 +00:00			`This is not an officially supported Google product`
Add code and examples (#1) 2018-04-26 17:52:06 +00:00			`(meaning, support and/or new releases may be limited.)`

Created a `./docs` directory to house documentation (#466) * Added links to docs to top level README * Updated more docs * Added generated header 2021-01-24 23:23:19 +00:00			`## Documentation`

Docs are now auto-generated using mdbook (#692) 2021-06-22 20:10:31 +00:00			`Documentation for all rules and providers are available at: https://bazelbuild.github.io/rules_foreign_cc/`
Created a `./docs` directory to house documentation (#466) * Added links to docs to top level README * Updated more docs * Added generated header 2021-01-24 23:23:19 +00:00
Update README.md because of Bazel 0.22.0 release (#208) - with Bazel 0.22.0, no flags are required to use rules_foreign_cc - improve Bazel versions related information - add link to "rules_foreign_cc take-aways" 2019-01-29 13:52:47 +00:00			`## Bazel versions compatibility`

Remove explicit mention of bazel 4.x support (#1146) 2023-12-21 11:26:27 +00:00			`Works with Bazel after 5.4.0.`
Add tests for checking the minimum supported version to CI (#469) 2021-01-25 19:07:05 +00:00
			`Note that the rules may be compatible with older versions of Bazel but support may break`
			`in future changes as these older versions are not tested.`
Correct headers (#209) * Update README.md because of Bazel 0.22.0 release - with Bazel 0.22.0, no flags are required to use rules_foreign_cc - improve Bazel versions related information - add link to "rules_foreign_cc take-aways" * Correct headers in README 2019-01-29 13:55:29 +00:00
Allow runnable_binary to work on non-external targets (#1100) 2023-10-14 13:24:09 +00:00			Note also that the `runnable_binary` macro requires bazel 5.4.0, for the `rlocationpath` [path
			`variable](https://bazel.build/reference/be/make-variables)`

Remove support for the versions of Bazel before 0.22 (#234) - as 0.23 is already released - to have only one variant of framework code 2019-03-11 15:34:56 +00:00			`## News`
Created a `./docs` directory to house documentation (#466) * Added links to docs to top level README * Updated more docs * Added generated header 2021-01-24 23:23:19 +00:00
Moved "news" into it's own file (#570) 2021-03-17 15:45:28 +00:00			`For more generalized updates, please see [NEWS.md](./NEWS.md) or checkout the`
			`[release notes](https://github.com/bazelbuild/rules_foreign_cc/releases) of current or previous releases`
Extract shell fragments into a toolchain (#196) * Extract shell fragments into a toolchain Construct script in framework.bzl using special notation for calling shell fragments, defining and referencing environment variables; have the script converted from this special notation into a real script (see README.md notes.) The special notation is used to keep script construction in code still readable. Tools scripts (cmake, ninja) were also converted. * Fix reference to environment variables in examples .. and reference it correctly $$var_name$$ so it is replaced further * Review comments: documentation, explicitly mark functions from toolchain - mark functions from shell toolchain as ##funname##, so that they can not be mixed with usual shell functions * Fix operating system name for windows in toolchain file * Additional env vars for windows * Correct cmake tool build * Do not build ninja on Windows * When run on Windows under msys, find utility from Window could "leak"... into the script. Use heuristics to use /usr/bin/find if it exists. Also, use pwd -W to get Windows-styled paths (for cmake) 2019-01-18 17:06:10 +00:00
Created a `./docs` directory to house documentation (#466) * Added links to docs to top level README * Updated more docs * Added generated header 2021-01-24 23:23:19 +00:00			`## Design document`
update readme file and framework rule comments (#78) 2018-08-31 12:23:16 +00:00
Created a `./docs` directory to house documentation (#466) * Added links to docs to top level README * Updated more docs * Added generated header 2021-01-24 23:23:19 +00:00			`[External C/C++ libraries rules](https://docs.google.com/document/d/1Gv452Vtki8edo_Dj9VTNJt5DA_lKTcSMwrwjJOkLaoU/edit?usp=sharing)`
Restructed examples and enabled more testing (#515) * Reorganized examples * Documentation * Third party 2021-02-26 20:21:13 +00:00
			`[ccb]: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_binary`
			`[ccl]: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library`
			`[cct]: https://docs.bazel.build/versions/master/be/c-cpp.html#cc_toolchain`
Adds toolchain for freebsd. (#794) * Adds toolchain for freebsd. * Address buildifier lint warnings. * Use /usr/bin/env bash * Leave the Linux-specific shebang alone. * Adds note about Bazel CI issue requesting for FreeBSD support and experimental status. * Fix typo. * Clean up trailing whitespace. * Updates bazel-skylib version for tests to pass on FreeBSD. * Update foreign_cc/repositories.bzl Co-authored-by: UebelAndre <github@uebelandre.com> 2021-11-29 10:54:06 +00:00
			`## Caveats`

			`* FreeBSD support is currently experimental and on a best-effort basis.`
			`Google currently doesn't have a CI test environment for FreeBSD,`
			`but please make your voice heard by upvoting this`
			`[issue](https://github.com/bazelbuild/continuous-integration/issues/258).`