diff --git a/.bazelci/config.yaml b/.bazelci/config.yaml index 134033625..7de1dc76f 100644 --- a/.bazelci/config.yaml +++ b/.bazelci/config.yaml @@ -165,7 +165,7 @@ tasks: name: Docs platform: ubuntu2004 working_directory: docs - test_targets: + build_targets: - //... min_supported_version: name: "Minimum Supported Version" diff --git a/.github/docs-0.1.0.patch b/.github/docs-0.1.0.patch new file mode 100644 index 000000000..ec291f3c1 --- /dev/null +++ b/.github/docs-0.1.0.patch @@ -0,0 +1,42 @@ +diff --git a/docs/BUILD.bazel b/docs/BUILD.bazel +index a5a37ac..e381ce8 100644 +--- a/docs/BUILD.bazel ++++ b/docs/BUILD.bazel +@@ -35,7 +35,7 @@ genrule( + cmd = """cat << EOF > $@ + #!/bin/bash + set -e +-cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/README.md ++cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/index.md + """, + ) + +diff --git a/docs/book.toml b/docs/book.toml +new file mode 100644 +index 0000000..5096728 +--- /dev/null ++++ b/docs/book.toml +@@ -0,0 +1,5 @@ ++[book] ++title = "Rules ForeignCc" ++ ++[output.html] ++git-repository-url = "https://github.com/bazelbuild/rules_foreign_cc" +diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md +new file mode 100644 +index 0000000..69fbd4d +--- /dev/null ++++ b/docs/src/SUMMARY.md +@@ -0,0 +1,3 @@ ++# SUMMARY ++ ++- [Rules ForeignCc](index.md) +diff --git a/version.bzl b/version.bzl +new file mode 100644 +index 0000000..98bb722 +--- /dev/null ++++ b/version.bzl +@@ -0,0 +1,3 @@ ++"""A module represeting the version of rules_foreign_cc""" ++ ++VERSION = "0.1.0" diff --git a/.github/docs-0.2.0.patch b/.github/docs-0.2.0.patch new file mode 100644 index 000000000..0b84bb3a4 --- /dev/null +++ b/.github/docs-0.2.0.patch @@ -0,0 +1,42 @@ +diff --git a/docs/BUILD.bazel b/docs/BUILD.bazel +index a5a37ac..091e679 100644 +--- a/docs/BUILD.bazel ++++ b/docs/BUILD.bazel +@@ -35,7 +35,7 @@ genrule( + cmd = """cat << EOF > $@ + #!/bin/bash + set -e +-cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/README.md ++cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/index.md + """, + ) + +diff --git a/docs/book.toml b/docs/book.toml +new file mode 100644 +index 0000000..5096728 +--- /dev/null ++++ b/docs/book.toml +@@ -0,0 +1,5 @@ ++[book] ++title = "Rules ForeignCc" ++ ++[output.html] ++git-repository-url = "https://github.com/bazelbuild/rules_foreign_cc" +diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md +new file mode 100644 +index 0000000..69fbd4d +--- /dev/null ++++ b/docs/src/SUMMARY.md +@@ -0,0 +1,3 @@ ++# SUMMARY ++ ++- [Rules ForeignCc](index.md) +diff --git a/version.bzl b/version.bzl +new file mode 100644 +index 0000000..98bb722 +--- /dev/null ++++ b/version.bzl +@@ -0,0 +1,3 @@ ++"""A module represeting the version of rules_foreign_cc""" ++ ++VERSION = "0.2.0" diff --git a/.github/docs-0.3.0.patch b/.github/docs-0.3.0.patch new file mode 100644 index 000000000..5f90b410a --- /dev/null +++ b/.github/docs-0.3.0.patch @@ -0,0 +1,82 @@ +diff --git a/docs/BUILD.bazel b/docs/BUILD.bazel +index 461df15..efa4c26 100644 +--- a/docs/BUILD.bazel ++++ b/docs/BUILD.bazel +@@ -68,16 +68,17 @@ build_test( + + genrule( + name = "generate_docs_src", +- srcs = DOCS_TARGETS, ++ srcs = DOCS_TARGETS + ["index.md"], + outs = ["generate_docs.sh"], + cmd = """cat << EOF > $@ + #!/bin/bash + set -euo pipefail +-cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:flatten_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/flatten.md +-cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:cmake_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/cmake.md +-cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:ninja_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/ninja.md +-cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:make_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/make.md +-cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:configure_make_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/configure_make.md ++cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:flatten_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/flatten.md ++cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:cmake_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/cmake.md ++cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:ninja_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/ninja.md ++cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:make_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/make.md ++cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:configure_make_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/configure_make.md ++cp \\$${BUILD_WORKSPACE_DIRECTORY}/$(rootpath index.md) \\$${BUILD_WORKSPACE_DIRECTORY}/src/index.md + EOF + """, + ) +diff --git a/docs/book.toml b/docs/book.toml +new file mode 100644 +index 0000000..5096728 +--- /dev/null ++++ b/docs/book.toml +@@ -0,0 +1,5 @@ ++[book] ++title = "Rules ForeignCc" ++ ++[output.html] ++git-repository-url = "https://github.com/bazelbuild/rules_foreign_cc" +diff --git a/docs/index.md b/docs/index.md +index 3a91e41..14c8e3b 100644 +--- a/docs/index.md ++++ b/docs/index.md +@@ -21,9 +21,12 @@ load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") + + http_archive( + name = "rules_foreign_cc", +- sha256 = "d54742ffbdc6924f222d2179f0e10e911c5c659c4ae74158e9fe827aad862ac6", +- strip_prefix = "rules_foreign_cc-0.2.0", +- url = "https://github.com/bazelbuild/rules_foreign_cc/archive/0.2.0.tar.gz", ++ # TODO: Get the latest sha256 value from the latest release on the releases page ++ # https://github.com/bazelbuild/rules_foreign_cc/releases ++ # ++ # sha256 = "...", ++ strip_prefix = "rules_foreign_cc-0.3.0", ++ url = "https://github.com/bazelbuild/rules_foreign_cc/archive/0.3.0.tar.gz", + ) + + load("@rules_foreign_cc//foreign_cc:repositories.bzl", "rules_foreign_cc_dependencies") +diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md +new file mode 100644 +index 0000000..9e77270 +--- /dev/null ++++ b/docs/src/SUMMARY.md +@@ -0,0 +1,8 @@ ++# SUMMARY ++ ++- [Rules ForeignCc](index.md) ++ - [cmake](cmake.md) ++ - [configure_make](configure_make.md) ++ - [make](make.md) ++ - [ninja](ninja.md) ++ - [Full API](flatten.md) +diff --git a/version.bzl b/version.bzl +new file mode 100644 +index 0000000..98bb722 +--- /dev/null ++++ b/version.bzl +@@ -0,0 +1,3 @@ ++"""A module represeting the version of rules_foreign_cc""" ++ ++VERSION = "0.3.0" diff --git a/.github/workflows/pages.yaml b/.github/workflows/pages.yaml new file mode 100644 index 000000000..cc4de568f --- /dev/null +++ b/.github/workflows/pages.yaml @@ -0,0 +1,91 @@ +name: Deploy mdBook +on: + push: + branches: + - main +jobs: + pages: + runs-on: ubuntu-latest + strategy: + matrix: + # Create a job for each target triple + include: + - ref: main + - ref: "0.3.0" + - ref: "0.2.0" + - ref: "0.1.0" + steps: + - uses: actions/checkout@v2 + if: ${{ matrix.ref == 'main' }} + - uses: actions/checkout@v2 + with: + ref: ${{ matrix.ref }} + if: ${{ matrix.ref != 'main' }} + - name: Pin the release to main + run: echo "RELEASE=main" >> $GITHUB_ENV + if: ${{ matrix.ref == 'main' }} + - name: Patch older branches + run: | + mkdir -p ${{ github.workspace }}/.github + curl https://raw.githubusercontent.com/bazelbuild/rules_foreign_cc/main/.github/docs-${{ matrix.ref }}.patch > ${{ github.workspace }}/.github/docs-${{ matrix.ref }}.patch + git apply ${{ github.workspace }}/.github/docs-${{ matrix.ref }}.patch + if: ${{ matrix.ref == '0.3.0' || matrix.ref == '0.2.0' || matrix.ref == '0.1.0' }} + - name: Install bazelisk + run: | + curl -LO "https://github.com/bazelbuild/bazelisk/releases/download/v1.9.0/bazelisk-linux-amd64" + mkdir -p "${{ github.workspace }}/bin/" + mv bazelisk-linux-amd64 "${{ github.workspace }}/bin/bazel" + chmod +x "${{ github.workspace }}/bin/bazel" + - name: Generate docs + run: | + "${{ github.workspace }}/bin/bazel" run //:generate_docs + "${{ github.workspace }}/bin/bazel" clean + working-directory: ${{ github.workspace }}/docs + - name: Install mdbook + run: | + curl -LO "https://github.com/rust-lang/mdBook/releases/download/v0.4.10/mdbook-v0.4.10-x86_64-unknown-linux-gnu.tar.gz" + mkdir -p "${{ github.workspace }}/bin/" + tar -xvf mdbook-v0.4.10-x86_64-unknown-linux-gnu.tar.gz + mv mdbook "${{ github.workspace }}/bin/mdbook" + chmod +x "${{ github.workspace }}/bin/mdbook" + - name: mdbook build + run: ${{ github.workspace }}/bin/mdbook build + working-directory: ${{ github.workspace }}/docs + - name: Save the newly built book + uses: actions/upload-artifact@v2 + with: + name: "${{ matrix.ref }}" + path: ${{ github.workspace }}/docs/book + if-no-files-found: error + - name: Build root + run: ${{ github.workspace }}/bin/mdbook build + if: ${{ matrix.ref == 'main' }} + working-directory: ${{ github.workspace }}/docs/root + - name: Save the newly built book + uses: actions/upload-artifact@v2 + with: + name: "${{ matrix.ref }}-root" + path: ${{ github.workspace }}/docs/root/book + if-no-files-found: error + if: ${{ matrix.ref == 'main' }} + publish: + needs: pages + runs-on: ubuntu-latest + steps: + - name: Fetch artifacts (first root then others so the ordering is correct) + uses: actions/download-artifact@v2 + with: + name: main-root + path: ${{ github.workspace }}/docs/book + - name: Fetch artifacts (first root then others so the ordering is correct) + uses: actions/download-artifact@v2 + with: + path: ${{ github.workspace }}/docs/pages + - name: Install pages + run: mv ${{ github.workspace }}/docs/pages/* ${{ github.workspace }}/docs/book/ + - name: publish + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_branch: docs + publish_dir: ./docs/book diff --git a/README.md b/README.md index a61d86edf..457027c68 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ This is **not an officially supported Google product** ## Documentation -Documentation for all rules and providers are available [here](./docs/index.md). +Documentation for all rules and providers are available at: https://bazelbuild.github.io/rules_foreign_cc/ ## Bazel versions compatibility diff --git a/docs/.bazelrc b/docs/.bazelrc new file mode 100644 index 000000000..dc6a3f77c --- /dev/null +++ b/docs/.bazelrc @@ -0,0 +1,3 @@ +# Bazel configuration flags for rules_foregin_cc_docs + +build --workspace_status_command=tools/workspace_status.sh diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..e7335784a --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +src +book diff --git a/docs/BUILD.bazel b/docs/BUILD.bazel index c72cebebc..2bdbf6eee 100644 --- a/docs/BUILD.bazel +++ b/docs/BUILD.bazel @@ -1,5 +1,4 @@ load("@bazel_skylib//rules:build_test.bzl", "build_test") -load("@bazel_skylib//rules:diff_test.bzl", "diff_test") load("@io_bazel_stardoc//stardoc:stardoc.bzl", "stardoc") genrule( @@ -83,40 +82,43 @@ build_test( # Run this target to upate/generate docs genrule( name = "generate_docs_src", - srcs = DOCS_TARGETS, + srcs = DOCS_TARGETS + [ + "index.md", + "rules.md", + ], outs = ["generate_docs.sh"], - cmd = """cat << EOF > $@ + cmd = """\ +export COMMIT="$$(cat bazel-out/stable-status.txt | grep STABLE_SCM_VERSION | cut -d' ' -f2)" +export SHORT_COMMIT="$$(cat bazel-out/stable-status.txt | grep STABLE_SCM_SHORT_VERSION | cut -d' ' -f2)" +export RELEASE="$$(cat bazel-out/stable-status.txt | grep STABLE_RELEASE | cut -d' ' -f2)" +cat << EOF > $@ #!/bin/bash set -euo pipefail -cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:flatten_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/flatten.md -cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:cmake_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/cmake.md -cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:ninja_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/ninja.md -cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:make_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/make.md -cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:configure_make_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/configure_make.md -cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:providers_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/providers.md +short_commit="$${SHORT_COMMIT}" +commit="$${COMMIT}" +release="$${RELEASE}" +if [[ -n "\\$${RELEASE}" ]]; then + release="\\$${RELEASE}" +fi +mkdir -p \\$${BUILD_WORKSPACE_DIRECTORY}/src +cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:flatten_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/flatten.md +cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:cmake_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/cmake.md +cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:ninja_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/ninja.md +cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:make_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/make.md +cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:configure_make_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/configure_make.md +cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(location //:providers_docs) > \\$${BUILD_WORKSPACE_DIRECTORY}/src/providers.md +# Non generated sourrces +cp \\$${BUILD_WORKSPACE_DIRECTORY}/$(rootpath rules.md) \\$${BUILD_WORKSPACE_DIRECTORY}/src/rules.md +cat \\$${BUILD_WORKSPACE_DIRECTORY}/$(rootpath index.md) \ +| sed "s/{short_commit}/\\$${short_commit}/" \ +| sed "s/{commit}/\\$${commit}/" \ +| sed "s/{release}/\\$${release}/" \ +> \\$${BUILD_WORKSPACE_DIRECTORY}/src/index.md EOF """, + stamp = True, ) -# When this test fails, run -# (cd docs; bazel run :generate_docs) -[ - diff_test( - name = "{}_test".format(doc), - failure_message = "Please run 'cd docs && bazel run :generate_docs' to update documentation.", - file1 = ":{}_docs".format(doc), - file2 = "{}.md".format(doc), - ) - for doc in [ - "flatten", - "cmake", - "ninja", - "make", - "configure_make", - "providers", - ] -] - sh_binary( name = "generate_docs", srcs = [":generate_docs_src"], diff --git a/docs/README.md b/docs/README.md index 5a0b1110d..672d44108 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ # Rules ForeignCc Docs -Up to date documentation can be found [here](./index.md) +Up to date documentation can be found at: https://bazelbuild.github.io/rules_foreign_cc/ ## Legacy documentation diff --git a/docs/WORKSPACE.bazel b/docs/WORKSPACE.bazel index f160d5894..4de80bb0c 100644 --- a/docs/WORKSPACE.bazel +++ b/docs/WORKSPACE.bazel @@ -7,23 +7,6 @@ local_repository( load("@rules_foreign_cc//foreign_cc:repositories.bzl", "rules_foreign_cc_dependencies") -# `bazel_skylib` is explicitly loaded so a patch can be applied to allow for unique error -# messages to be added to `diff_test` targets. This can be removed after an upstream PR is -# merged and the rev updated in `rules_foreign_cc`: https://github.com/bazelbuild/bazel-skylib/pull/307 - -load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") - -http_archive( - name = "bazel_skylib", - patch_args = ["-p1"], - patches = ["//:bazel_skylib-diff_test.patch"], - sha256 = "1c531376ac7e5a180e0237938a2536de0c54d93f5c278634818e0efc952dd56c", - urls = [ - "https://mirror.bazel.build/github.com/bazelbuild/bazel-skylib/releases/download/1.0.3/bazel-skylib-1.0.3.tar.gz", - "https://github.com/bazelbuild/bazel-skylib/releases/download/1.0.3/bazel-skylib-1.0.3.tar.gz", - ], -) - rules_foreign_cc_dependencies() load("//:stardoc_repository.bzl", "stardoc_repository") diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 18854876c..000000000 --- a/docs/_config.yml +++ /dev/null @@ -1 +0,0 @@ -theme: jekyll-theme-midnight \ No newline at end of file diff --git a/docs/bazel_skylib-diff_test.patch b/docs/bazel_skylib-diff_test.patch deleted file mode 100644 index 0ada635e3..000000000 --- a/docs/bazel_skylib-diff_test.patch +++ /dev/null @@ -1,42 +0,0 @@ -diff --git a/rules/diff_test.bzl b/rules/diff_test.bzl -index 71faf40..acde2ea 100644 ---- a/rules/diff_test.bzl -+++ b/rules/diff_test.bzl -@@ -58,7 +58,7 @@ if "!RF2!" equ "" ( - fc.exe 2>NUL 1>NUL /B "!RF1!" "!RF2!" - if %ERRORLEVEL% neq 0 ( - if %ERRORLEVEL% equ 1 ( -- echo>&2 FAIL: files "{file1}" and "{file2}" differ -+ echo>&2 FAIL: files "{file1}" and "{file2}" differ. {fail_msg} - exit /b 1 - ) else ( - fc.exe /B "!RF1!" "!RF2!" -@@ -66,6 +66,7 @@ if %ERRORLEVEL% neq 0 ( - ) - ) - """.format( -+ fail_msg = ctx.attr.failure_message, - file1 = _runfiles_path(ctx.file.file1), - file2 = _runfiles_path(ctx.file.file2), - ), -@@ -95,10 +96,11 @@ else - exit 1 - fi - if ! diff "$RF1" "$RF2"; then -- echo >&2 "FAIL: files \"{file1}\" and \"{file2}\" differ" -+ echo >&2 "FAIL: files \"{file1}\" and \"{file2}\" differ. {fail_msg}" - exit 1 - fi - """.format( -+ fail_msg = ctx.attr.failure_message, - file1 = _runfiles_path(ctx.file.file1), - file2 = _runfiles_path(ctx.file.file2), - ), -@@ -112,6 +114,7 @@ fi - - _diff_test = rule( - attrs = { -+ "failure_message": attr.string(), - "file1": attr.label( - allow_single_file = True, - mandatory = True, diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 000000000..50967281f --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,5 @@ +[book] +title = "Rules ForeignCc" + +[output.html] +git-repository-url = "https://github.com/bazelbuild/rules_foreign_cc" diff --git a/docs/cmake.md b/docs/cmake.md deleted file mode 100644 index ba75d3ddb..000000000 --- a/docs/cmake.md +++ /dev/null @@ -1,186 +0,0 @@ - - -# CMake - -## Building CMake projects - -- Build libraries/binaries with CMake from sources using cmake rule -- Use cmake targets in [cc_library][ccl], [cc_binary][ccb] targets as dependency -- Bazel [cc_toolchain][cct] parameters are used inside cmake build -- See full list of cmake arguments below 'example' -- cmake is defined in `./tools/build_defs` -- Works on Ubuntu, Mac OS and Windows(\* see special notes below in Windows section) operating systems - -**Example:** -(Please see full examples in ./examples) - -The example for **Windows** is below, in the section 'Usage on Windows'. - -- In `WORKSPACE.bazel`, we use a `http_archive` to download tarballs with the libraries we use. -- In `BUILD.bazel`, we instantiate a `cmake` rule which behaves similarly to a [cc_library][ccl], which can then be used in a C++ rule ([cc_binary][ccb] in this case). - -In `WORKSPACE.bazel`, put - -```python -workspace(name = "rules_foreign_cc_usage_example") - -load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") - -# Rule repository, note that it's recommended to use a pinned commit to a released version of the rules -http_archive( - name = "rules_foreign_cc", - sha256 = "c2cdcf55ffaf49366725639e45dedd449b8c3fe22b54e31625eb80ce3a240f1e", - strip_prefix = "rules_foreign_cc-0.1.0", - url = "https://github.com/bazelbuild/rules_foreign_cc/archive/0.1.0.zip", -) - -load("@rules_foreign_cc//foreign_cc:repositories.bzl", "rules_foreign_cc_dependencies") - -# This sets up some common toolchains for building targets. For more details, please see -# https://github.com/bazelbuild/rules_foreign_cc/tree/main/docs#rules_foreign_cc_dependencies -rules_foreign_cc_dependencies() - -_ALL_CONTENT = """\ -filegroup( - name = "all_srcs", - srcs = glob(["**"]), - visibility = ["//visibility:public"], -) -""" - -# pcre source code repository -http_archive( - name = "pcre", - build_file_content = _ALL_CONTENT, - strip_prefix = "pcre-8.43", - urls = [ - "https://mirror.bazel.build/ftp.pcre.org/pub/pcre/pcre-8.43.tar.gz", - "https://ftp.pcre.org/pub/pcre/pcre-8.43.tar.gz", - ], - sha256 = "0b8e7465dc5e98c757cc3650a20a7843ee4c3edf50aaf60bb33fd879690d2c73", -) -``` - -And in the `BUILD.bazel` file, put: - -```python -load("@rules_foreign_cc//foreign_cc:defs.bzl", "cmake") - -cmake( - name = "pcre", - cache_entries = { - "CMAKE_C_FLAGS": "-fPIC", - }, - lib_source = "@pcre//:all_srcs", - out_static_libs = ["libpcre.a"], -) -``` - -then build as usual: - -```bash -bazel build //:pcre -``` - -**Usage on Windows** - -When using on Windows, you should start Bazel in MSYS2 shell, as the shell script inside cmake assumes this. -Also, you should explicitly specify **make commands and option to generate CMake crosstool file**. - -The default generator for CMake will be detected automatically, or you can specify it explicitly. - -**The tested generators:** Visual Studio 15, Ninja and NMake. -The extension `.lib` is assumed for the static libraries by default. - -Example usage (see full example in `./examples/cmake_hello_world_lib`): -Example assumes that MS Visual Studio and Ninja are installed on the host machine, and Ninja bin directory is added to PATH. - -```python -cmake( - # expect to find ./lib/hello.lib as the result of the build - name = "hello", - # This option can be omitted - generate_args = [ - "-G \"Visual Studio 15 2017\"", - "-A Win64", - ], - lib_source = ":srcs", -) - -cmake( - name = "hello_ninja", - # expect to find ./lib/hello.lib as the result of the build - lib_name = "hello", - # explicitly specify the generator - generate_args = ["-GNinja"], - lib_source = ":srcs", -) - -cmake( - name = "hello_nmake", - # explicitly specify the generator - generate_args = ["-G \"NMake Makefiles\""], - lib_source = ":srcs", - # expect to find ./lib/hello.lib as the result of the build - out_static_libs = ["hello.lib"], -) -``` - -[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 - - - - -## cmake - -
-cmake(name, additional_inputs, additional_tools, alwayslink, build_args, build_data, cache_entries,
-      data, defines, deps, env, generate_args, generate_crosstool_file, install, install_args,
-      lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs, out_headers_only,
-      out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs, out_static_libs,
-      postfix_script, targets, tool_prefix, tools_deps, working_directory)
-
- -Rule for building external library with CMake. - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| additional_inputs | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| additional_tools | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| alwayslink | Optional. if true, link all the object files from the static library, even if they are not used. | Boolean | optional | False | -| build_args | Arguments for the CMake build command | List of strings | optional | [] | -| build_data | Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| cache_entries | CMake cache entries to initialize (they will be passed with -Dkey=value) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first) | Dictionary: String -> String | optional | {} | -| data | Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| defines | Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. | List of strings | optional | [] | -| deps | Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule) | List of labels | optional | [] | -| env | Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data, deps, or build_data, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. | Dictionary: String -> String | optional | {} | -| generate_args | Arguments for CMake's generate command. Arguments should be passed as key/value pairs. eg: ["-G Ninja", "--debug-output", "-DFOO=bar"]. Note that unless a generator (-G) argument is provided, the default generators are [Unix Makefiles](https://cmake.org/cmake/help/latest/generator/Unix%20Makefiles.html) for Linux and MacOS and [Ninja](https://cmake.org/cmake/help/latest/generator/Ninja.html) for Windows. | List of strings | optional | [] | -| generate_crosstool_file | When True, CMake crosstool file will be generated from the toolchain values, provided cache-entries and env_vars (some values will still be passed as -Dkey=value and environment variables). If CMAKE_TOOLCHAIN_FILE cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify CMAKE_SYSTEM_NAME in the cache_entries | Boolean | optional | True | -| install | If True, the cmake --install comand will be performed after a build | Boolean | optional | True | -| install_args | Arguments for the CMake install command | List of strings | optional | [] | -| lib_name | Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. | String | optional | "" | -| lib_source | Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. | Label | required | | -| linkopts | Optional link options to be passed up to the dependencies of this library | List of strings | optional | [] | -| out_bin_dir | Optional name of the output subdirectory with the binary files, defaults to 'bin'. | String | optional | "bin" | -| out_binaries | Optional names of the resulting binaries. | List of strings | optional | [] | -| out_data_dirs | Optional names of additional directories created by the build that should be declared as bazel action outputs | List of strings | optional | [] | -| out_headers_only | Flag variable to indicate that the library produces only headers | Boolean | optional | False | -| out_include_dir | Optional name of the output subdirectory with the header files, defaults to 'include'. | String | optional | "include" | -| out_interface_libs | Optional names of the resulting interface libraries. | List of strings | optional | [] | -| out_lib_dir | Optional name of the output subdirectory with the library files, defaults to 'lib'. | String | optional | "lib" | -| out_shared_libs | Optional names of the resulting shared libraries. | List of strings | optional | [] | -| out_static_libs | Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed | List of strings | optional | [] | -| postfix_script | Optional part of the shell script to be added after the make commands | String | optional | "" | -| targets | A list of targets with in the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set | List of strings | optional | [] | -| tool_prefix | A prefix for build commands | String | optional | "" | -| tools_deps | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| working_directory | Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.) | String | optional | "" | - - diff --git a/docs/configure_make.md b/docs/configure_make.md deleted file mode 100644 index 1afc3ba99..000000000 --- a/docs/configure_make.md +++ /dev/null @@ -1,67 +0,0 @@ - - -A rule for building projects using the[Configure+Make][cm] build tool -[cm]: https://www.gnu.org/prep/standards/html_node/Configuration.html - - - - -## configure_make - -
-configure_make(name, additional_inputs, additional_tools, alwayslink, args, autoconf,
-               autoconf_options, autogen, autogen_command, autogen_options, autoreconf,
-               autoreconf_options, build_data, configure_command, configure_in_place,
-               configure_options, configure_prefix, data, defines, deps, env, install_prefix,
-               lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs,
-               out_headers_only, out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs,
-               out_static_libs, postfix_script, targets, tool_prefix, tools_deps)
-
- -Rule for building external libraries with configure-make pattern. Some 'configure' script is invoked with --prefix=install (by default), and other parameters for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. After configuration, GNU Make is called. - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| additional_inputs | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| additional_tools | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| alwayslink | Optional. if true, link all the object files from the static library, even if they are not used. | Boolean | optional | False | -| args | A list of arguments to pass to the call to make | List of strings | optional | [] | -| autoconf | Set to True if 'autoconf' should be invoked before 'configure', currently requires configure_in_place to be True. | Boolean | optional | False | -| autoconf_options | Any options to be put in the 'autoconf.sh' command line. | List of strings | optional | [] | -| autogen | Set to True if 'autogen.sh' should be invoked before 'configure', currently requires configure_in_place to be True. | Boolean | optional | False | -| autogen_command | The name of the autogen script file, default: autogen.sh. Many projects use autogen.sh however the Autotools FAQ recommends bootstrap so we provide this option to support that. | String | optional | "autogen.sh" | -| autogen_options | Any options to be put in the 'autogen.sh' command line. | List of strings | optional | [] | -| autoreconf | Set to True if 'autoreconf' should be invoked before 'configure.', currently requires configure_in_place to be True. | Boolean | optional | False | -| autoreconf_options | Any options to be put in the 'autoreconf.sh' command line. | List of strings | optional | [] | -| build_data | Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| configure_command | The name of the configuration script file, default: configure. The file must be in the root of the source directory. | String | optional | "configure" | -| configure_in_place | Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory. | Boolean | optional | False | -| configure_options | Any options to be put on the 'configure' command line. | List of strings | optional | [] | -| configure_prefix | A prefix for the call to the configure_command. | String | optional | "" | -| data | Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| defines | Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. | List of strings | optional | [] | -| deps | Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule) | List of labels | optional | [] | -| env | Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data, deps, or build_data, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. | Dictionary: String -> String | optional | {} | -| install_prefix | Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with --prefix flag. | String | optional | "" | -| lib_name | Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. | String | optional | "" | -| lib_source | Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. | Label | required | | -| linkopts | Optional link options to be passed up to the dependencies of this library | List of strings | optional | [] | -| out_bin_dir | Optional name of the output subdirectory with the binary files, defaults to 'bin'. | String | optional | "bin" | -| out_binaries | Optional names of the resulting binaries. | List of strings | optional | [] | -| out_data_dirs | Optional names of additional directories created by the build that should be declared as bazel action outputs | List of strings | optional | [] | -| out_headers_only | Flag variable to indicate that the library produces only headers | Boolean | optional | False | -| out_include_dir | Optional name of the output subdirectory with the header files, defaults to 'include'. | String | optional | "include" | -| out_interface_libs | Optional names of the resulting interface libraries. | List of strings | optional | [] | -| out_lib_dir | Optional name of the output subdirectory with the library files, defaults to 'lib'. | String | optional | "lib" | -| out_shared_libs | Optional names of the resulting shared libraries. | List of strings | optional | [] | -| out_static_libs | Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed | List of strings | optional | [] | -| postfix_script | Optional part of the shell script to be added after the make commands | String | optional | "" | -| targets | A list of targets within the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set | List of strings | optional | ["", "install"] | -| tool_prefix | A prefix for build commands | String | optional | "" | -| tools_deps | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | - - diff --git a/docs/flatten.md b/docs/flatten.md deleted file mode 100644 index 4cdd70e5f..000000000 --- a/docs/flatten.md +++ /dev/null @@ -1,437 +0,0 @@ - -# Rules Foreign CC - -- [boost_build](#boost_build) -- [cmake](#cmake) -- [cmake_tool](#cmake_tool) -- [configure_make](#configure_make) -- [ForeignCcArtifactInfo](#ForeignCcArtifactInfo) -- [ForeignCcDepsInfo](#ForeignCcDepsInfo) -- [make](#make) -- [make_tool](#make_tool) -- [native_tool_toolchain](#native_tool_toolchain) -- [ninja](#ninja) -- [ninja_tool](#ninja_tool) -- [rules_foreign_cc_dependencies](#rules_foreign_cc_dependencies) -- [ToolInfo](#ToolInfo) - - - -## boost_build - -
-boost_build(name, additional_inputs, additional_tools, alwayslink, bootstrap_options, build_data,
-            data, defines, deps, env, lib_name, lib_source, linkopts, out_bin_dir, out_binaries,
-            out_data_dirs, out_headers_only, out_include_dir, out_interface_libs, out_lib_dir,
-            out_shared_libs, out_static_libs, postfix_script, tool_prefix, tools_deps, user_options)
-
- -Rule for building Boost. Invokes bootstrap.sh and then b2 install. - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| additional_inputs | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| additional_tools | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| alwayslink | Optional. if true, link all the object files from the static library, even if they are not used. | Boolean | optional | False | -| bootstrap_options | any additional flags to pass to bootstrap.sh | List of strings | optional | [] | -| build_data | Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| data | Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| defines | Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. | List of strings | optional | [] | -| deps | Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule) | List of labels | optional | [] | -| env | Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data, deps, or build_data, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. | Dictionary: String -> String | optional | {} | -| lib_name | Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. | String | optional | "" | -| lib_source | Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. | Label | required | | -| linkopts | Optional link options to be passed up to the dependencies of this library | List of strings | optional | [] | -| out_bin_dir | Optional name of the output subdirectory with the binary files, defaults to 'bin'. | String | optional | "bin" | -| out_binaries | Optional names of the resulting binaries. | List of strings | optional | [] | -| out_data_dirs | Optional names of additional directories created by the build that should be declared as bazel action outputs | List of strings | optional | [] | -| out_headers_only | Flag variable to indicate that the library produces only headers | Boolean | optional | False | -| out_include_dir | Optional name of the output subdirectory with the header files, defaults to 'include'. | String | optional | "include" | -| out_interface_libs | Optional names of the resulting interface libraries. | List of strings | optional | [] | -| out_lib_dir | Optional name of the output subdirectory with the library files, defaults to 'lib'. | String | optional | "lib" | -| out_shared_libs | Optional names of the resulting shared libraries. | List of strings | optional | [] | -| out_static_libs | Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed | List of strings | optional | [] | -| postfix_script | Optional part of the shell script to be added after the make commands | String | optional | "" | -| tool_prefix | A prefix for build commands | String | optional | "" | -| tools_deps | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| user_options | any additional flags to pass to b2 | List of strings | optional | [] | - - - - -## cmake - -
-cmake(name, additional_inputs, additional_tools, alwayslink, build_args, build_data, cache_entries,
-      data, defines, deps, env, generate_args, generate_crosstool_file, install, install_args,
-      lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs, out_headers_only,
-      out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs, out_static_libs,
-      postfix_script, targets, tool_prefix, tools_deps, working_directory)
-
- -Rule for building external library with CMake. - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| additional_inputs | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| additional_tools | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| alwayslink | Optional. if true, link all the object files from the static library, even if they are not used. | Boolean | optional | False | -| build_args | Arguments for the CMake build command | List of strings | optional | [] | -| build_data | Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| cache_entries | CMake cache entries to initialize (they will be passed with -Dkey=value) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first) | Dictionary: String -> String | optional | {} | -| data | Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| defines | Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. | List of strings | optional | [] | -| deps | Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule) | List of labels | optional | [] | -| env | Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data, deps, or build_data, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. | Dictionary: String -> String | optional | {} | -| generate_args | Arguments for CMake's generate command. Arguments should be passed as key/value pairs. eg: ["-G Ninja", "--debug-output", "-DFOO=bar"]. Note that unless a generator (-G) argument is provided, the default generators are [Unix Makefiles](https://cmake.org/cmake/help/latest/generator/Unix%20Makefiles.html) for Linux and MacOS and [Ninja](https://cmake.org/cmake/help/latest/generator/Ninja.html) for Windows. | List of strings | optional | [] | -| generate_crosstool_file | When True, CMake crosstool file will be generated from the toolchain values, provided cache-entries and env_vars (some values will still be passed as -Dkey=value and environment variables). If CMAKE_TOOLCHAIN_FILE cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify CMAKE_SYSTEM_NAME in the cache_entries | Boolean | optional | True | -| install | If True, the cmake --install comand will be performed after a build | Boolean | optional | True | -| install_args | Arguments for the CMake install command | List of strings | optional | [] | -| lib_name | Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. | String | optional | "" | -| lib_source | Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. | Label | required | | -| linkopts | Optional link options to be passed up to the dependencies of this library | List of strings | optional | [] | -| out_bin_dir | Optional name of the output subdirectory with the binary files, defaults to 'bin'. | String | optional | "bin" | -| out_binaries | Optional names of the resulting binaries. | List of strings | optional | [] | -| out_data_dirs | Optional names of additional directories created by the build that should be declared as bazel action outputs | List of strings | optional | [] | -| out_headers_only | Flag variable to indicate that the library produces only headers | Boolean | optional | False | -| out_include_dir | Optional name of the output subdirectory with the header files, defaults to 'include'. | String | optional | "include" | -| out_interface_libs | Optional names of the resulting interface libraries. | List of strings | optional | [] | -| out_lib_dir | Optional name of the output subdirectory with the library files, defaults to 'lib'. | String | optional | "lib" | -| out_shared_libs | Optional names of the resulting shared libraries. | List of strings | optional | [] | -| out_static_libs | Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed | List of strings | optional | [] | -| postfix_script | Optional part of the shell script to be added after the make commands | String | optional | "" | -| targets | A list of targets with in the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set | List of strings | optional | [] | -| tool_prefix | A prefix for build commands | String | optional | "" | -| tools_deps | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| working_directory | Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.) | String | optional | "" | - - - - -## cmake_tool - -
-cmake_tool(name, srcs)
-
- -Rule for building CMake. Invokes bootstrap script and make install. - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| srcs | The target containing the build tool's sources | Label | required | | - - - - -## configure_make - -
-configure_make(name, additional_inputs, additional_tools, alwayslink, args, autoconf,
-               autoconf_options, autogen, autogen_command, autogen_options, autoreconf,
-               autoreconf_options, build_data, configure_command, configure_in_place,
-               configure_options, configure_prefix, data, defines, deps, env, install_prefix,
-               lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs,
-               out_headers_only, out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs,
-               out_static_libs, postfix_script, targets, tool_prefix, tools_deps)
-
- -Rule for building external libraries with configure-make pattern. Some 'configure' script is invoked with --prefix=install (by default), and other parameters for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. After configuration, GNU Make is called. - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| additional_inputs | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| additional_tools | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| alwayslink | Optional. if true, link all the object files from the static library, even if they are not used. | Boolean | optional | False | -| args | A list of arguments to pass to the call to make | List of strings | optional | [] | -| autoconf | Set to True if 'autoconf' should be invoked before 'configure', currently requires configure_in_place to be True. | Boolean | optional | False | -| autoconf_options | Any options to be put in the 'autoconf.sh' command line. | List of strings | optional | [] | -| autogen | Set to True if 'autogen.sh' should be invoked before 'configure', currently requires configure_in_place to be True. | Boolean | optional | False | -| autogen_command | The name of the autogen script file, default: autogen.sh. Many projects use autogen.sh however the Autotools FAQ recommends bootstrap so we provide this option to support that. | String | optional | "autogen.sh" | -| autogen_options | Any options to be put in the 'autogen.sh' command line. | List of strings | optional | [] | -| autoreconf | Set to True if 'autoreconf' should be invoked before 'configure.', currently requires configure_in_place to be True. | Boolean | optional | False | -| autoreconf_options | Any options to be put in the 'autoreconf.sh' command line. | List of strings | optional | [] | -| build_data | Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| configure_command | The name of the configuration script file, default: configure. The file must be in the root of the source directory. | String | optional | "configure" | -| configure_in_place | Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory. | Boolean | optional | False | -| configure_options | Any options to be put on the 'configure' command line. | List of strings | optional | [] | -| configure_prefix | A prefix for the call to the configure_command. | String | optional | "" | -| data | Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| defines | Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. | List of strings | optional | [] | -| deps | Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule) | List of labels | optional | [] | -| env | Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data, deps, or build_data, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. | Dictionary: String -> String | optional | {} | -| install_prefix | Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with --prefix flag. | String | optional | "" | -| lib_name | Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. | String | optional | "" | -| lib_source | Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. | Label | required | | -| linkopts | Optional link options to be passed up to the dependencies of this library | List of strings | optional | [] | -| out_bin_dir | Optional name of the output subdirectory with the binary files, defaults to 'bin'. | String | optional | "bin" | -| out_binaries | Optional names of the resulting binaries. | List of strings | optional | [] | -| out_data_dirs | Optional names of additional directories created by the build that should be declared as bazel action outputs | List of strings | optional | [] | -| out_headers_only | Flag variable to indicate that the library produces only headers | Boolean | optional | False | -| out_include_dir | Optional name of the output subdirectory with the header files, defaults to 'include'. | String | optional | "include" | -| out_interface_libs | Optional names of the resulting interface libraries. | List of strings | optional | [] | -| out_lib_dir | Optional name of the output subdirectory with the library files, defaults to 'lib'. | String | optional | "lib" | -| out_shared_libs | Optional names of the resulting shared libraries. | List of strings | optional | [] | -| out_static_libs | Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed | List of strings | optional | [] | -| postfix_script | Optional part of the shell script to be added after the make commands | String | optional | "" | -| targets | A list of targets within the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set | List of strings | optional | ["", "install"] | -| tool_prefix | A prefix for build commands | String | optional | "" | -| tools_deps | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | - - - - -## make - -
-make(name, additional_inputs, additional_tools, alwayslink, args, build_data, data, defines, deps,
-     env, lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs, out_headers_only,
-     out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs, out_static_libs,
-     postfix_script, targets, tool_prefix, tools_deps)
-
- -Rule for building external libraries with GNU Make. GNU Make commands (make and make install by default) are invoked with prefix="install" (by default), and other environment variables for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| additional_inputs | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| additional_tools | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| alwayslink | Optional. if true, link all the object files from the static library, even if they are not used. | Boolean | optional | False | -| args | A list of arguments to pass to the call to make | List of strings | optional | [] | -| build_data | Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| data | Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| defines | Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. | List of strings | optional | [] | -| deps | Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule) | List of labels | optional | [] | -| env | Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data, deps, or build_data, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. | Dictionary: String -> String | optional | {} | -| lib_name | Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. | String | optional | "" | -| lib_source | Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. | Label | required | | -| linkopts | Optional link options to be passed up to the dependencies of this library | List of strings | optional | [] | -| out_bin_dir | Optional name of the output subdirectory with the binary files, defaults to 'bin'. | String | optional | "bin" | -| out_binaries | Optional names of the resulting binaries. | List of strings | optional | [] | -| out_data_dirs | Optional names of additional directories created by the build that should be declared as bazel action outputs | List of strings | optional | [] | -| out_headers_only | Flag variable to indicate that the library produces only headers | Boolean | optional | False | -| out_include_dir | Optional name of the output subdirectory with the header files, defaults to 'include'. | String | optional | "include" | -| out_interface_libs | Optional names of the resulting interface libraries. | List of strings | optional | [] | -| out_lib_dir | Optional name of the output subdirectory with the library files, defaults to 'lib'. | String | optional | "lib" | -| out_shared_libs | Optional names of the resulting shared libraries. | List of strings | optional | [] | -| out_static_libs | Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed | List of strings | optional | [] | -| postfix_script | Optional part of the shell script to be added after the make commands | String | optional | "" | -| targets | A list of targets within the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set | List of strings | optional | ["", "install"] | -| tool_prefix | A prefix for build commands | String | optional | "" | -| tools_deps | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | - - - - -## make_tool - -
-make_tool(name, srcs)
-
- -Rule for building Make. Invokes configure script and make install. - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| srcs | The target containing the build tool's sources | Label | required | | - - - - -## native_tool_toolchain - -
-native_tool_toolchain(name, path, target)
-
- -Rule for defining the toolchain data of the native tools (cmake, ninja), to be used by rules_foreign_cc with toolchain types `@rules_foreign_cc//toolchains:cmake_toolchain` and `@rules_foreign_cc//toolchains:ninja_toolchain`. - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| path | Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example //examples:built_cmake_toolchain) | String | optional | "" | -| target | If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call. | Label | optional | None | - - - - -## ninja - -
-ninja(name, additional_inputs, additional_tools, alwayslink, args, build_data, data, defines, deps,
-      directory, env, lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs,
-      out_headers_only, out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs,
-      out_static_libs, postfix_script, targets, tool_prefix, tools_deps)
-
- -Rule for building external libraries with [Ninja](https://ninja-build.org/). - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| additional_inputs | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| additional_tools | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| alwayslink | Optional. if true, link all the object files from the static library, even if they are not used. | Boolean | optional | False | -| args | A list of arguments to pass to the call to ninja | List of strings | optional | [] | -| build_data | Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| data | Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| defines | Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. | List of strings | optional | [] | -| deps | Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule) | List of labels | optional | [] | -| directory | A directory to pass as the -C argument. The rule will always use the root directory of the lib_sources attribute if this attribute is not set | String | optional | "" | -| env | Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data, deps, or build_data, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. | Dictionary: String -> String | optional | {} | -| lib_name | Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. | String | optional | "" | -| lib_source | Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. | Label | required | | -| linkopts | Optional link options to be passed up to the dependencies of this library | List of strings | optional | [] | -| out_bin_dir | Optional name of the output subdirectory with the binary files, defaults to 'bin'. | String | optional | "bin" | -| out_binaries | Optional names of the resulting binaries. | List of strings | optional | [] | -| out_data_dirs | Optional names of additional directories created by the build that should be declared as bazel action outputs | List of strings | optional | [] | -| out_headers_only | Flag variable to indicate that the library produces only headers | Boolean | optional | False | -| out_include_dir | Optional name of the output subdirectory with the header files, defaults to 'include'. | String | optional | "include" | -| out_interface_libs | Optional names of the resulting interface libraries. | List of strings | optional | [] | -| out_lib_dir | Optional name of the output subdirectory with the library files, defaults to 'lib'. | String | optional | "lib" | -| out_shared_libs | Optional names of the resulting shared libraries. | List of strings | optional | [] | -| out_static_libs | Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed | List of strings | optional | [] | -| postfix_script | Optional part of the shell script to be added after the make commands | String | optional | "" | -| targets | A list of targets with in the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set | List of strings | optional | [] | -| tool_prefix | A prefix for build commands | String | optional | "" | -| tools_deps | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | - - - - -## ninja_tool - -
-ninja_tool(name, srcs)
-
- -Rule for building Ninja. Invokes configure script. - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| srcs | The target containing the build tool's sources | Label | required | | - - - - -## ForeignCcArtifactInfo - -
-ForeignCcArtifactInfo(bin_dir_name, gen_dir, include_dir_name, lib_dir_name)
-
- -Groups information about the external library install directory, -and relative bin, include and lib directories. - -Serves to pass transitive information about externally built artifacts up the dependency chain. - -Can not be used as a top-level provider. -Instances of ForeignCcArtifactInfo are encapsulated in a depset [ForeignCcDepsInfo::artifacts](#ForeignCcDepsInfo-artifacts). - -**FIELDS** - - -| Name | Description | -| :------------- | :------------- | -| bin_dir_name | Bin directory, relative to install directory | -| gen_dir | Install directory | -| include_dir_name | Include directory, relative to install directory | -| lib_dir_name | Lib directory, relative to install directory | - - - - -## ForeignCcDepsInfo - -
-ForeignCcDepsInfo(artifacts)
-
- -Provider to pass transitive information about external libraries. - -**FIELDS** - - -| Name | Description | -| :------------- | :------------- | -| artifacts | Depset of ForeignCcArtifactInfo | - - - - -## ToolInfo - -
-ToolInfo(path, target)
-
- -Information about the native tool - -**FIELDS** - - -| Name | Description | -| :------------- | :------------- | -| path | Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example //examples:built_cmake_toolchain) | -| target | If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call. | - - - - -## rules_foreign_cc_dependencies - -
-rules_foreign_cc_dependencies(native_tools_toolchains, register_default_tools, cmake_version,
-                              make_version, ninja_version, register_preinstalled_tools,
-                              register_built_tools)
-
- -Call this function from the WORKSPACE file to initialize rules_foreign_cc dependencies and let neccesary code generation happen (Code generation is needed to support different variants of the C++ Starlark API.). - -**PARAMETERS** - - -| Name | Description | Default Value | -| :------------- | :------------- | :------------- | -| native_tools_toolchains | pass the toolchains for toolchain types '@rules_foreign_cc//toolchains:cmake_toolchain' and '@rules_foreign_cc//toolchains:ninja_toolchain' with the needed platform constraints. If you do not pass anything, registered default toolchains will be selected (see below). | [] | -| register_default_tools | If True, the cmake and ninja toolchains, calling corresponding preinstalled binaries by name (cmake, ninja) will be registered after 'native_tools_toolchains' without any platform constraints. The default is True. | True | -| cmake_version | The target version of the cmake toolchain if register_default_tools or register_built_tools is set to True. | "3.20.4" | -| make_version | The target version of the default make toolchain if register_built_tools is set to True. | "4.3" | -| ninja_version | The target version of the ninja toolchain if register_default_tools or register_built_tools is set to True. | "1.10.2" | -| register_preinstalled_tools | If true, toolchains will be registered for the native built tools installed on the exec host | True | -| register_built_tools | If true, toolchains that build the tools from source are registered | True | - - diff --git a/docs/gen_header.sh b/docs/gen_header.sh index 18b72d51c..d0137fd0b 100755 --- a/docs/gen_header.sh +++ b/docs/gen_header.sh @@ -20,7 +20,7 @@ TABLE_OF_CONTENTS=$(grep "=" "$1" \ | sed '/^$/d' \ | sed '/^#/d' \ | sed 's/ = .*//' \ -| sed 's/\(.*\)/- [\1](#\1)/' \ +| python -c 'import sys; print("\n".join(["- [{}](#{})".format(symbol.strip(), symbol.strip().lower()) for symbol in sys.stdin.readlines()]))' \ | sort -f ) diff --git a/docs/index.md b/docs/index.md index 0a5b59fc1..96762a367 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,6 +2,10 @@ Rules for building C/C++ projects using foreign build systems (non Bazel) inside Bazel projects. +| Release | Commit | Status | +| --- | --------- | --- | +| {release} | [{short_commit}](https://github.com/bazelbuild/rules_foreign_cc/commit/{commit}) | [![Build status](https://badge.buildkite.com/c28afbf846e2077715c753dda1f4b820cdcc46cc6cde16503c.svg?commit=main)](https://buildkite.com/bazel/rules-foreign-cc?branch=main) | + ## Overview Rules ForeignCc is designed to help users build projects that are not built by Bazel and also @@ -25,8 +29,8 @@ http_archive( # https://github.com/bazelbuild/rules_foreign_cc/releases # # sha256 = "...", - strip_prefix = "rules_foreign_cc-0.4.0", - url = "https://github.com/bazelbuild/rules_foreign_cc/archive/0.4.0.tar.gz", + strip_prefix = "rules_foreign_cc-{release}", + url = "https://github.com/bazelbuild/rules_foreign_cc/archive/{release}.tar.gz", ) load("@rules_foreign_cc//foreign_cc:repositories.bzl", "rules_foreign_cc_dependencies") @@ -38,12 +42,3 @@ Please note that there are many different configuration options for [rules_foreign_cc_dependencies](./flatten.md#rules_foreign_cc_dependencies) which offer more control over the toolchains used during the build phase. Please see that macro's documentation for more details. - -## Rules - -- [cmake](./cmake.md) -- [configure_make](./configure_make.md) -- [make](./make.md) -- [ninja](./ninja.md) - -For additional rules/macros/providers, see the [full API in one page](./flatten.md). diff --git a/docs/make.md b/docs/make.md deleted file mode 100644 index b0d19b651..000000000 --- a/docs/make.md +++ /dev/null @@ -1,50 +0,0 @@ - - -A rule for building projects using the [GNU Make](https://www.gnu.org/software/make/) build tool - - - -## make - -
-make(name, additional_inputs, additional_tools, alwayslink, args, build_data, data, defines, deps,
-     env, lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs, out_headers_only,
-     out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs, out_static_libs,
-     postfix_script, targets, tool_prefix, tools_deps)
-
- -Rule for building external libraries with GNU Make. GNU Make commands (make and make install by default) are invoked with prefix="install" (by default), and other environment variables for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| additional_inputs | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| additional_tools | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| alwayslink | Optional. if true, link all the object files from the static library, even if they are not used. | Boolean | optional | False | -| args | A list of arguments to pass to the call to make | List of strings | optional | [] | -| build_data | Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| data | Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| defines | Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. | List of strings | optional | [] | -| deps | Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule) | List of labels | optional | [] | -| env | Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data, deps, or build_data, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. | Dictionary: String -> String | optional | {} | -| lib_name | Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. | String | optional | "" | -| lib_source | Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. | Label | required | | -| linkopts | Optional link options to be passed up to the dependencies of this library | List of strings | optional | [] | -| out_bin_dir | Optional name of the output subdirectory with the binary files, defaults to 'bin'. | String | optional | "bin" | -| out_binaries | Optional names of the resulting binaries. | List of strings | optional | [] | -| out_data_dirs | Optional names of additional directories created by the build that should be declared as bazel action outputs | List of strings | optional | [] | -| out_headers_only | Flag variable to indicate that the library produces only headers | Boolean | optional | False | -| out_include_dir | Optional name of the output subdirectory with the header files, defaults to 'include'. | String | optional | "include" | -| out_interface_libs | Optional names of the resulting interface libraries. | List of strings | optional | [] | -| out_lib_dir | Optional name of the output subdirectory with the library files, defaults to 'lib'. | String | optional | "lib" | -| out_shared_libs | Optional names of the resulting shared libraries. | List of strings | optional | [] | -| out_static_libs | Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed | List of strings | optional | [] | -| postfix_script | Optional part of the shell script to be added after the make commands | String | optional | "" | -| targets | A list of targets within the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set | List of strings | optional | ["", "install"] | -| tool_prefix | A prefix for build commands | String | optional | "" | -| tools_deps | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | - - diff --git a/docs/ninja.md b/docs/ninja.md deleted file mode 100644 index b16ef38b2..000000000 --- a/docs/ninja.md +++ /dev/null @@ -1,51 +0,0 @@ - - -A rule for building projects using the [Ninja](https://ninja-build.org/) build tool - - - -## ninja - -
-ninja(name, additional_inputs, additional_tools, alwayslink, args, build_data, data, defines, deps,
-      directory, env, lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs,
-      out_headers_only, out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs,
-      out_static_libs, postfix_script, targets, tool_prefix, tools_deps)
-
- -Rule for building external libraries with [Ninja](https://ninja-build.org/). - -**ATTRIBUTES** - - -| Name | Description | Type | Mandatory | Default | -| :------------- | :------------- | :------------- | :------------- | :------------- | -| name | A unique name for this target. | Name | required | | -| additional_inputs | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| additional_tools | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | -| alwayslink | Optional. if true, link all the object files from the static library, even if they are not used. | Boolean | optional | False | -| args | A list of arguments to pass to the call to ninja | List of strings | optional | [] | -| build_data | Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| data | Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. | List of labels | optional | [] | -| defines | Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. | List of strings | optional | [] | -| deps | Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external buidl system will be looking for and paths to which are provided by the calling rule) | List of labels | optional | [] | -| directory | A directory to pass as the -C argument. The rule will always use the root directory of the lib_sources attribute if this attribute is not set | String | optional | "" | -| env | Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data, deps, or build_data, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. | Dictionary: String -> String | optional | {} | -| lib_name | Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. | String | optional | "" | -| lib_source | Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. | Label | required | | -| linkopts | Optional link options to be passed up to the dependencies of this library | List of strings | optional | [] | -| out_bin_dir | Optional name of the output subdirectory with the binary files, defaults to 'bin'. | String | optional | "bin" | -| out_binaries | Optional names of the resulting binaries. | List of strings | optional | [] | -| out_data_dirs | Optional names of additional directories created by the build that should be declared as bazel action outputs | List of strings | optional | [] | -| out_headers_only | Flag variable to indicate that the library produces only headers | Boolean | optional | False | -| out_include_dir | Optional name of the output subdirectory with the header files, defaults to 'include'. | String | optional | "include" | -| out_interface_libs | Optional names of the resulting interface libraries. | List of strings | optional | [] | -| out_lib_dir | Optional name of the output subdirectory with the library files, defaults to 'lib'. | String | optional | "lib" | -| out_shared_libs | Optional names of the resulting shared libraries. | List of strings | optional | [] | -| out_static_libs | Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed | List of strings | optional | [] | -| postfix_script | Optional part of the shell script to be added after the make commands | String | optional | "" | -| targets | A list of targets with in the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set | List of strings | optional | [] | -| tool_prefix | A prefix for build commands | String | optional | "" | -| tools_deps | __deprecated__: Please use the build_data attribute. | List of labels | optional | [] | - - diff --git a/docs/providers.md b/docs/providers.md deleted file mode 100644 index 68ec713cc..000000000 --- a/docs/providers.md +++ /dev/null @@ -1,49 +0,0 @@ - - - A module containing all public facing providers - - - -## ForeignCcArtifactInfo - -
-ForeignCcArtifactInfo(bin_dir_name, gen_dir, include_dir_name, lib_dir_name)
-
- -Groups information about the external library install directory, -and relative bin, include and lib directories. - -Serves to pass transitive information about externally built artifacts up the dependency chain. - -Can not be used as a top-level provider. -Instances of ForeignCcArtifactInfo are encapsulated in a depset [ForeignCcDepsInfo::artifacts](#ForeignCcDepsInfo-artifacts). - -**FIELDS** - - -| Name | Description | -| :------------- | :------------- | -| bin_dir_name | Bin directory, relative to install directory | -| gen_dir | Install directory | -| include_dir_name | Include directory, relative to install directory | -| lib_dir_name | Lib directory, relative to install directory | - - - - -## ForeignCcDepsInfo - -
-ForeignCcDepsInfo(artifacts)
-
- -Provider to pass transitive information about external libraries. - -**FIELDS** - - -| Name | Description | -| :------------- | :------------- | -| artifacts | Depset of ForeignCcArtifactInfo | - - diff --git a/docs/root/book.toml b/docs/root/book.toml new file mode 100644 index 000000000..50967281f --- /dev/null +++ b/docs/root/book.toml @@ -0,0 +1,5 @@ +[book] +title = "Rules ForeignCc" + +[output.html] +git-repository-url = "https://github.com/bazelbuild/rules_foreign_cc" diff --git a/docs/root/src/SUMMARY.md b/docs/root/src/SUMMARY.md new file mode 100644 index 000000000..80d54fe82 --- /dev/null +++ b/docs/root/src/SUMMARY.md @@ -0,0 +1,9 @@ +# Summary + +- [Rules ForeignCc](index.md) + - [Rules](rules.md) + - [cmake](cmake.md) + - [configure_make](configure_make.md) + - [make](make.md) + - [ninja](ninja.md) +- [Full API](flatten.md) diff --git a/docs/root/src/index.md b/docs/root/src/index.md new file mode 100644 index 000000000..206f1f1d9 --- /dev/null +++ b/docs/root/src/index.md @@ -0,0 +1,10 @@ +# Rules ForeignCc + +Rules for building C/C++ projects using foreign build systems (non Bazel) inside Bazel projects. + +## Versions + +- [main](main/index.md) +- [0.3.0](0.3.0/index.md) +- [0.2.0](0.2.0/index.md) +- [0.1.0](0.1.0/index.md) diff --git a/docs/rules.md b/docs/rules.md new file mode 100644 index 000000000..37c5ef870 --- /dev/null +++ b/docs/rules.md @@ -0,0 +1,8 @@ +# Rules + +- [cmake](./cmake.md) +- [configure_make](./configure_make.md) +- [make](./make.md) +- [ninja](./ninja.md) + +For additional rules/macros/providers, see the [full API in one page](./flatten.md). diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md new file mode 100644 index 000000000..80d54fe82 --- /dev/null +++ b/docs/src/SUMMARY.md @@ -0,0 +1,9 @@ +# Summary + +- [Rules ForeignCc](index.md) + - [Rules](rules.md) + - [cmake](cmake.md) + - [configure_make](configure_make.md) + - [make](make.md) + - [ninja](ninja.md) +- [Full API](flatten.md) diff --git a/docs/tools/workspace_status.sh b/docs/tools/workspace_status.sh new file mode 100755 index 000000000..eaec25a89 --- /dev/null +++ b/docs/tools/workspace_status.sh @@ -0,0 +1,7 @@ +#!/bin/bash + +set -euo pipefail + +echo STABLE_SCM_SHORT_VERSION "$(git rev-parse --short HEAD)" +echo STABLE_SCM_VERSION "$(git rev-parse HEAD)" +echo STABLE_RELEASE "$(cat ../version.bzl | grep VERSION | sed 's/VERSION = "//' | sed 's/"//')" diff --git a/foreign_cc/cmake.bzl b/foreign_cc/cmake.bzl index 714d1556d..a34b71b73 100644 --- a/foreign_cc/cmake.bzl +++ b/foreign_cc/cmake.bzl @@ -1,4 +1,4 @@ -"""# CMake +"""# [CMake](#cmake) ## Building CMake projects @@ -6,8 +6,7 @@ - Use cmake targets in [cc_library][ccl], [cc_binary][ccb] targets as dependency - Bazel [cc_toolchain][cct] parameters are used inside cmake build - See full list of cmake arguments below 'example' -- cmake is defined in `./tools/build_defs` -- Works on Ubuntu, Mac OS and Windows(\\* see special notes below in Windows section) operating systems +- Works on Ubuntu, Mac OS and Windows (*see special notes below in Windows section*) operating systems **Example:** (Please see full examples in ./examples) diff --git a/foreign_cc/configure.bzl b/foreign_cc/configure.bzl index 718c1fb52..607e33e7e 100644 --- a/foreign_cc/configure.bzl +++ b/foreign_cc/configure.bzl @@ -1,5 +1,5 @@ -"""A rule for building projects using the[Configure+Make][cm] build tool -[cm]: https://www.gnu.org/prep/standards/html_node/Configuration.html +"""A rule for building projects using the [Configure+Make](https://www.gnu.org/prep/standards/html_node/Configuration.html) +build tool """ load( diff --git a/version.bzl b/version.bzl new file mode 100644 index 000000000..204e2e433 --- /dev/null +++ b/version.bzl @@ -0,0 +1,3 @@ +"""A module represeting the version of rules_foreign_cc""" + +VERSION = "0.4.0"