Skip to content

[libc][docs] adds highlighting languages to docs/dev/config_options.rst #89136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 18, 2024
Merged

[libc][docs] adds highlighting languages to docs/dev/config_options.rst #89136

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0579f34
adds highlighting language to docs/dev/config_options.rst
Flandini Apr 17, 2024
8fcaf80
switch none to cmake
Flandini Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions libc/docs/dev/config_options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,14 @@ hierarchical JSON files. At the top of the hierarchy is a JSON file by name
options which affect all platforms. The default value for the option and a short
description about it listed against each option. For example:

.. code-block::
.. code-block:: json

{
"printf": {
"LIBC_CONF_PRINTF_DISABLE_FLOAT": {
"value": false,
"doc": "Disable printing floating point values in printf and friends."
},
...
}
}
}

Expand All @@ -28,7 +27,7 @@ has a value of ``false``. A platform, say the baremetal platform, can choose
to override this value in its ``config.json`` file in the ``config/baremetal``
directory with the following contents:

.. code-block::
.. code-block:: json

{
"printf": {
Expand Down Expand Up @@ -61,14 +60,13 @@ The value corresponding to each grouping tag is also a dictionary called the
options belonging to that grouping tag. For the ``printf`` tag in the above
example, the option-dictionary is:

.. code-block::
.. code-block:: json

{
"LIBC_CONF_PRINTF_DISABLE_FLOAT": {
"value": false,
"doc":
},
...
}
}

The value corresponding to an option key in the option-dictionary is another
Expand All @@ -86,7 +84,7 @@ Option name format

The option names, or the keys of a option-dictionary, have the following format:

.. code-block::
.. code-block:: none

LIBC_CONF_<UPPER_CASE_TAG_NAME>_<ACTION_INDICATING_THE_INTENDED_SEMANTICS>

Expand Down Expand Up @@ -123,7 +121,7 @@ should convert the CMake config options to appropriate compiler and/or linker
flags. Those compile/link flags can be used in listing the affected targets as
follows:

.. code-block::
.. code-block:: cmake

add_object_library(
...
Expand Down