Skip to content

Commit 35d72b7

Browse files
authored
add docs (#3338)
1 parent 9b9956e commit 35d72b7

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

reference/conanfile/attributes/binary_model.inc

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,10 @@ For example, in the ``configure()`` method a typical pattern for a C library wou
121121
options
122122
-------
123123

124-
Dictionary with traits that affects only the current recipe, where the key is the
125-
option name and the value is a list of different values that the option can take.
126-
By default any value change in an option, changes the ``package_id``. Check the
127-
``default_options`` field to define default values for the options.
124+
Dictionary with traits that affects only the current recipe, where the key is the option
125+
name and the value is a list of different values that the option can take. By default any
126+
value change in an option, changes the ``package_id``. Check the ``default_options`` and
127+
``default_build_options`` fields to define default values for the options.
128128

129129
Values for each option can be typed or plain strings (``"value"``, ``True``, ``42``,...).
130130

@@ -235,6 +235,24 @@ Take into account that if a value is assigned in the ``configure()`` method it c
235235
236236
Read more about the <MISSING PAGE>method_configure_config_options method.
237237
238+
default_build_options
239+
---------------------
240+
241+
The attribute ``default_build_options`` defines the default values for the options in the
242+
build context and is tipically used for defining options for ``tool_requires``.
243+
244+
245+
.. code-block:: python
246+
247+
from conan import ConanFile
248+
class Consumer(ConanFile):
249+
default_options = {"protobuf/*:shared": True}
250+
default_build_options = {"protobuf/*:shared": False}
251+
def requirements(self):
252+
self.requires("protobuf/1.0")
253+
def build_requirements(self):
254+
self.build_requires("protobuf/1.0")
255+
238256
239257
options_description
240258
-------------------

0 commit comments

Comments
 (0)