Update cmake-tools-cmake-variants.md
- Replace TRUE/FALSE with ON/OFF options - Update description and details on several options
This commit is contained in:
Родитель
4bbb4cb09d
Коммит
7f8a269b9f
|
@ -57,13 +57,13 @@ The following explains each line of the *linkage* section. Text highlighted in *
|
|||
- "TARGET_SERIES" : "**STM32F7xx**"
|
||||
- For STM32 MCUs represents the target series (STM32F4XX, STM32L4XX, and so on)
|
||||
- For ESP32 matches the series name: "ESP32"
|
||||
- "USE_FPU" : "**TRUE**"
|
||||
- TRUE or FALSE : Enables or disables the use of the FPU unit, if present.
|
||||
- "USE_RNG" : "**TRUE**"
|
||||
- TRUE or FALSE : Enables or disables the use of the hardware true random generator unit, if present.
|
||||
- "DP_FLOATINGPOINT" : "**<OFF-default-ON-for-adding-support-for-double-precision-floating-point>**"
|
||||
- Enables support for double-precision floating point. The default is single-precision.
|
||||
- "SUPPORT_ANY_BASE_CONVERSION" : "**<OFF-default-ON-for-adding-support-for-conversion-strings-to-values-on-any-base>**"
|
||||
- "USE_FPU" : "**ON**"
|
||||
- Option to use the FPU unit, if present. Default is ON.
|
||||
- "USE_RNG" : "**OFF**"
|
||||
- Option to enables the use of the hardware true random generator unit, if present. Default is OFF.
|
||||
- "DP_FLOATINGPOINT" : "**OFF**"
|
||||
- Enables support for double-precision floating point. The default is single-precision. Set to ON to enable double precision floating point.
|
||||
- "SUPPORT_ANY_BASE_CONVERSION" : "**OFF**"
|
||||
- Defines which bases are supported when performing string to value conversions. When ON support for any base is enabled. When OFF (the default) the image will be compiled with support for base 10 and base 16 only.
|
||||
- "RTOS" : "**<one-of-valid-rtos-options>**"
|
||||
- Defines the RTOS that will be used to build nanoFramework. It can be CHIBIOS or FREERTOS. Currently ChibiOS is supported for all STM32 targets and FreeRTOS is supported for ESP32 targets.
|
||||
|
@ -71,9 +71,9 @@ The following explains each line of the *linkage* section. Text highlighted in *
|
|||
- Path to an optional local installation of ChibiOS source files. If no path is given, then CMake will download the sources from the projects ChibiOS repository when needed
|
||||
- "CHIBIOS_BOARD" : "**<valid-chibios-board-name-from-boards-collection>**"
|
||||
- Name of your board, chosen from the available boards collection that can be found in the \os\hal\boards folder of the ChibiOS installation (or distant repository)
|
||||
- "SWO_OUTPUT" : "**<OFF-default-ON-to-enable-ARM-CortexM-Single-Wire-Output**"
|
||||
- Allows specifying whether to include, or not, support for Cortex-M Single Wire Output (SWO). Check the documentation [here](arm-swo.md) for more details on how to use SWO.
|
||||
- "NF_BUILD_RTM" : "**OFF-default-ON-to-enable-RTM-build**"
|
||||
- "SWO_OUTPUT" : "**OFF**"
|
||||
- Allows specifying whether to include, or not, support for Cortex-M Single Wire Output (SWO). Default is OFF. Check the documentation [here](arm-swo.md) for more details on how to use SWO.
|
||||
- "NF_BUILD_RTM" : "**OFF**"
|
||||
- Sets if the build is of **R**eady **T**o **M**arket type. Meaning that all debug helpers and code blocks will be removed from compilation and the build will be compiled and linked with all possible code reducing options enabled.
|
||||
- "NF_WP_TRACE_ERRORS" : "**OFF**"
|
||||
- Enable error tracing in Wire Protocol.
|
||||
|
@ -87,30 +87,32 @@ The following explains each line of the *linkage* section. Text highlighted in *
|
|||
- Enable all tracing options for Wire Protocol.
|
||||
- "NF_WP_IMPLEMENTS_CRC32" : "**OFF**"
|
||||
- Enable CRC32 calculations for Wire Protocol. See details [here](../architecture/wire-protocol.md#crc32-validatons).
|
||||
- "NF_FEATURE_DEBUGGER" : "**<TRUE-to-include-nF-debugger>**"
|
||||
- A boolean switch to specify whether the debugger feature is to be included.
|
||||
- "NF_FEATURE_RTC" : "**<OFF-default-ON-to-enable-hardware-RTC>**"
|
||||
- Allows you to specify whether the board contains a real time clock that can be used for date & time functions.
|
||||
- "NF_FEATURE_USE_APPDOMAINS" : "**<OFF-default-ON-to-enable-support-for-Application-Domains>**"
|
||||
- Allows you to specify whether to include, or not, support for Application Domains. More information about this is available in the documentation [here](https://msdn.microsoft.com/en-us/library/cxk374d9(v=vs.90).aspx). ***Note that the complete removal of support for this feature is being considered (see issue [here](https://github.com/nanoframework/nf-interpreter/issues/303)).***
|
||||
- "NF_FEATURE_DEBUGGER" : "**OFF**"
|
||||
- Defines is support for debuggin managed applications is enabled. Default is OFF.
|
||||
- "NF_FEATURE_RTC" : "**OFF**"
|
||||
- Allows you to specify whether to use the real time clock unit of the hardware for date & time functions. Depends on target availability. Default is OFF.
|
||||
- "NF_FEATURE_USE_APPDOMAINS" : "**OFF**"
|
||||
- Allows you to specify whether to include, or not, support for Application Domains. Default is OFF. More information about this is available in the documentation [here](https://msdn.microsoft.com/en-us/library/cxk374d9(v=vs.90).aspx). ***Note that the complete removal of support for this feature is being considered (see issue [here](https://github.com/nanoframework/nf-interpreter/issues/303)).***
|
||||
- "NF_INTEROP_ASSEMBLIES" : [ "Assembly1-Namespace", "Assembly2-Namespace" ],
|
||||
- Lists the name of the Interop assembly(ies) to be added to the build. Leave empty or don't add it if no Interop assembly is to be added.
|
||||
- "API_System.Net" : "**<OFF-default-ON-to-add-this-API>**"
|
||||
- Allows you to specify whether System.Net support is available to your application.
|
||||
- "API_Windows.Devices.Adc" : "**<OFF-default-ON-to-add-this-API>**"
|
||||
- Allows you to specify whether ADC functions are available to your application.
|
||||
- "API_Windows.Devices.Gpio" : "**<OFF-default-ON-to-add-this-API>**"
|
||||
- Allows you to specify whether GPIO functions are available to your application.
|
||||
- "API_Windows.Devices.I2c" : "**<OFF-default-ON-to-add-this-API>**"
|
||||
- Allows you to specify whether I2C functions are available to your application.
|
||||
- "API_Windows.Devices.Pwm" : "**<OFF-default-ON-to-add-this-API>**"
|
||||
- Allows you to specify whether PWM functions are available to your application.
|
||||
- "API_Windows.Devices.SerialCommunication" : "**<OFF-default-ON-to-add-this-API>**"
|
||||
- Allows you to specify whether Serial Communication functions are available to your application.
|
||||
- "API_Windows.Devices.Spi" : "**<OFF-default-ON-to-add-this-API>**"
|
||||
- Allows you to specify whether SPI functions are available to your application.
|
||||
- "API_Windows.Networking.Sockets" : "**<OFF-default-ON-to-add-this-API>**"
|
||||
- Allows you to specify whether Networking Sockets functions are available to your application.
|
||||
- "API_System.Net" : "**OFF**"
|
||||
- Allows you to specify whether System.Net support is available to your application. Default is OFF.
|
||||
- "API_Windows.Devices.Adc" : "**OFF**"
|
||||
- Allows you to specify whether ADC functions are available to your application. Default is OFF.
|
||||
- "API_Windows.Devices.Gpio" : "**OFF**"
|
||||
- Allows you to specify whether GPIO functions are available to your application. Default is OFF.
|
||||
- "API_Windows.Devices.I2c" : "**OFF**"
|
||||
- Allows you to specify whether I2C functions are available to your application. Default is OFF.
|
||||
- "API_Windows.Devices.Pwm" : "**OFF**"
|
||||
- Allows you to specify whether PWM functions are available to your application. Default is OFF.
|
||||
- "API_Windows.Devices.SerialCommunication" : "**OFF**"
|
||||
- Allows you to specify whether Serial Communication functions are available to your application. Default is OFF.
|
||||
- "API_Windows.Devices.Spi" : "**OFF**"
|
||||
- Allows you to specify whether SPI functions are available to your application. Default is OFF.
|
||||
- "API_Windows.Networking.Sockets" : "**OFF**"
|
||||
- Allows you to specify whether Networking Sockets functions are available to your application. Default is OFF.
|
||||
- "API_Hardware.Esp32" : "**OFF**"
|
||||
- Allows you to specify whether Hardware.ESP32 functions are available to your application. Default is OFF.
|
||||
|
||||
|
||||
## Working example
|
||||
|
|
Загрузка…
Ссылка в новой задаче