From 159cd7c073fe6e3e8c8b9c87fca84aabb3d118b4 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Fri, 5 Oct 2018 01:25:33 +0300 Subject: [PATCH] Better explanation about overriding settings for board --- docs | 2 +- scripts/docspregen.py | 11 ++++++----- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/docs b/docs index 9c6fe4f1..c44ec58c 160000 --- a/docs +++ b/docs @@ -1 +1 @@ -Subproject commit 9c6fe4f18fe7f5d3c4fbff594aa98b8a7dc7bfe7 +Subproject commit c44ec58c6d749a2041b87e786d8450719c0544be diff --git a/scripts/docspregen.py b/scripts/docspregen.py index 866a13b3..d2072ed2 100644 --- a/scripts/docspregen.py +++ b/scripts/docspregen.py @@ -608,6 +608,7 @@ def update_embedded_board(rst_path, board): id=board['id'], name=board['name'], platform=board['platform'], + platform_description=platform.description, url=campaign_url(board['url']), mcu=board_config.get("build", {}).get("mcu", ""), mcu_upper=board['mcu'].upper(), @@ -627,18 +628,17 @@ def update_embedded_board(rst_path, board): lines.append(""" .. contents:: -Platform :ref:`platform_%s`: %s""" % (platform.name, platform.description)) - - lines.append(""" System ------ +Platform :ref:`platform_{platform}`: {platform_description} + .. list-table:: * - **Microcontroller** - {mcu_upper} * - **Frequency** - - {f_cpu_mhz}Mhz + - {f_cpu_mhz}MHz * - **Flash** - {rom} * - **RAM** @@ -663,8 +663,9 @@ Please use ``{id}`` ID for :ref:`projectconf_env_board` option in :ref:`projectc board = {id} You can override default {name} settings per build environment using -``board_{{JSON.PATH}}`` option, where ``{{JSON.PATH}}`` is a path from +``board_***`` option, where ``***`` is a JSON object path from board manifest `{id}.json <{board_manifest_url}>`_. For example, +``board_build.mcu``, ``board_build.f_cpu``, etc. .. code-block:: ini