-
Notifications
You must be signed in to change notification settings - Fork 363
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add bazel 7.1 documentation (#3707)
* feat: Add bazel 7.1 documentation * Typos * Updating bazel 7.x docs * Useless rules * Added example * Updated ref * Update examples/tools/google/bazeltoolchain/build_simple_bazel_7x_project.rst * Fixed --------- Co-authored-by: Francisco Ramirez de Anton <franchuti688@gmail.com> Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>
- Loading branch information
1 parent
d8bbe7f
commit ed73430
Showing
8 changed files
with
272 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,3 +8,4 @@ Bazel | |
:maxdepth: 2 | ||
|
||
bazeltoolchain/build_simple_bazel_project | ||
bazeltoolchain/build_simple_bazel_7x_project |
142 changes: 142 additions & 0 deletions
142
examples/tools/google/bazeltoolchain/build_simple_bazel_7x_project.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
.. _examples_tools_bazel_7x_toolchain_build_simple_bazel_project: | ||
|
||
Build a simple Bazel 7.x project using Conan | ||
============================================ | ||
|
||
.. warning:: | ||
|
||
This example is Bazel >= 7.1 compatible. | ||
|
||
In this example, we are going to create a Hello World program | ||
that uses one of the most popular C++ libraries: `fmt <https://fmt.dev/latest/index.html/>`_. | ||
|
||
.. note:: | ||
|
||
This example is based on the :ref:`Build a simple CMake project using Conan<consuming_packages_build_simple_cmake_project>` | ||
tutorial. So we highly recommend reading it before trying out this one. | ||
|
||
|
||
We'll use Bazel as the build system and helper tool in this case, so you should get it installed | ||
before going forward with this example. See `how to install Bazel <https://bazel.build/install>`_. | ||
|
||
Please, first clone the sources to recreate this project. You can find them in the | ||
`examples2 repository <https://github.com/conan-io/examples2>`_ in GitHub: | ||
|
||
.. code-block:: bash | ||
$ git clone https://github.com/conan-io/examples2.git | ||
$ cd examples2/examples/tools/google/bazeltoolchain/7_x/string_formatter | ||
We start from a very simple C++ language project with this structure: | ||
|
||
.. code-block:: text | ||
. | ||
├── MODULE.bazel | ||
├── conanfile.txt | ||
└── main | ||
├── BUILD | ||
└── demo.cpp | ||
This project contains a *MODULE.bazel* file loading the Conan dependencies (in this case only ``fmt``) | ||
and a *main/BUILD* file which defines the *demo* bazel target and it's in charge of using ``fmt`` to build a | ||
simple Hello World program. | ||
|
||
Let's have a look at each file's content: | ||
|
||
.. code-block:: cpp | ||
:caption: **main/demo.cpp** | ||
#include <cstdlib> | ||
#include <fmt/core.h> | ||
int main() { | ||
fmt::print("{} - The C++ Package Manager!\n", "Conan"); | ||
return EXIT_SUCCESS; | ||
} | ||
.. code-block:: python | ||
:caption: **MODULE.bazel** | ||
load_conan_dependencies = use_extension("//conan:conan_deps_module_extension.bzl", "conan_extension") | ||
use_repo(load_conan_dependencies, "fmt") | ||
.. code-block:: python | ||
:caption: **main/BUILD** | ||
cc_binary( | ||
name = "demo", | ||
srcs = ["demo.cpp"], | ||
deps = [ | ||
"@fmt//:fmt" | ||
], | ||
) | ||
.. code-block:: ini | ||
:caption: **conanfile.txt** | ||
[requires] | ||
fmt/10.1.1 | ||
[generators] | ||
BazelDeps | ||
BazelToolchain | ||
[layout] | ||
bazel_layout | ||
Conan uses the :ref:`conan_tools_google_bazeltoolchain` to generate a ``conan_bzl.rc`` file which defines the | ||
``conan-config`` bazel-build configuration. This file and the configuration are passed as parameters to the | ||
``bazel build`` command. Apart from that, Conan uses the :ref:`conan_tools_google_bazeldeps` generator | ||
to create all the bazel files (*[DEP]/BUILD.bazel*, *conan_deps_module_extension.bzl* and | ||
*conan_deps_repo_rules.bzl*) which define the rule and all the dependencies to create/load them as Bazel repositories. | ||
The *MODULE.bazel* above is ready to load the *conan_deps_module_extension.bzl* file which will tell the | ||
*main/BUILD* all the information about the ``@fmt//:fmt`` bazel target. | ||
|
||
As the first step, we should install all the dependencies listed in the ``conanfile.txt``. | ||
The command :ref:`conan install<reference_commands_install>` does not only install the ``fmt`` package, | ||
it also builds it from sources in case your profile does not match with a pre-built binary in your remotes. | ||
Furthermore, it will save all the files created by the generators listed in the ``conanfile.txt`` | ||
in a folder named *conan/* (default folder defined by the ``bazel_layout``). | ||
|
||
.. code-block:: bash | ||
$ conan install . --build=missing | ||
# ... | ||
======== Finalizing install (deploy, generators) ======== | ||
conanfile.txt: Writing generators to /Users/user/develop/examples2/examples/tools/google/bazeltoolchain/7_x/string_formatter/conan | ||
conanfile.txt: Generator 'BazelDeps' calling 'generate()' | ||
conanfile.txt: Generator 'BazelToolchain' calling 'generate()' | ||
conanfile.txt: Generating aggregated env files | ||
conanfile.txt: Generated aggregated env files: ['conanbuild.sh', 'conanrun.sh'] | ||
Install finished successfully | ||
Now we are ready to build and run our application: | ||
|
||
.. code-block:: bash | ||
$ bazel --bazelrc=./conan/conan_bzl.rc build --config=conan-config //main:demo | ||
Computing main repo mapping: | ||
Loading: | ||
Loading: 0 packages loaded | ||
Analyzing: target //main:demo (1 packages loaded, 0 targets configured) | ||
Analyzing: target //main:demo (1 packages loaded, 0 targets configured) | ||
[0 / 1] [Prepa] BazelWorkspaceStatusAction stable-status.txt | ||
INFO: Analyzed target //main:demo (69 packages loaded, 369 targets configured). | ||
[5 / 7] Compiling main/demo.cpp; 0s darwin-sandbox | ||
INFO: Found 1 target... | ||
Target //main:demo up-to-date: | ||
bazel-bin/main/demo | ||
INFO: Elapsed time: 2.955s, Critical Path: 1.70s | ||
INFO: 7 processes: 5 internal, 2 darwin-sandbox. | ||
INFO: Build completed successfully, 7 total actions | ||
.. code-block:: bash | ||
$ ./bazel-bin/main/demo | ||
Conan - The C++ Package Manager! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.