Documentation updates for the configuration system #2278
Merged
Conversation
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
The configuration system uses `mbed_config.h` to export configuration data, but when this change was made, the documentation was not properly updated. This commit updates the documentation with the correct behaviour of the configuration system.
|
@geky: if you can find the bandwith to add the missing pieces in this document (regarding features and the overridable target attributes that are not configuration parameters), it would be great. I can help with the targets part at least. |
|
Can do, I will make this my priority. |
|
Opened a pr over here #2279, let me know thoughts on the documentation. |
artokin
pushed a commit
to artokin/mbed-os
that referenced
this pull request
Feb 20, 2020
…..fb7413b fb7413b Merge branch 'release_internal' into release_external a9f6e88 Merge branch 'master' into release_internal c536960 DHCPv6 Server feature update 01e7e82 Merge pull request ARMmbed#2314 from ARMmbed/update_from_mbedos c906c43 Fixed typo: 'lenght' in ns_crc.h 2bd0558 Wi-sun border router DHCPv6 server address alocation update 63e4680 Allow buffer_dyn to handle more data (ARMmbed#2311) 9b82abf Copy IE unicast channel function from WS info instead of FHSS configu… (ARMmbed#2310) 18247d5 Wi-sun RPL memory soft and hard limit update c8560db Updated RPL default memory sof and hard limit to 2/4 from 1/2. 05aa54c Update MPL parameters to follow Specification f728d55 Support for handle CRC error which will automatically change a channel. 6b6f535 Corrected EUI-64 address bit flip on supplicant 015f3fe Corrected bitfield definition 7717ef8 Improved initial EAPOL-key send stop logic on supplicant 4185734 Improved EAPOL key update retry logic 8bda176 Wi-sun boot fix 6283dfd DIO advertisment fix 1acec7c Aro Registation and Dao update 6cde17a Iotthd 3963 2 (ARMmbed#2301) b9187da Randomize fixed channel when making new parent selection 34d0339 Wi-sun address registartion update 5b30559 Allow unicast TX to overlap with MC (ARMmbed#2298) d40b1c7 MAC: Updated calling FHSS TX done (ARMmbed#2295) aeb93a1 Add support for bbr configuration that removes default route from DIO 9b941af Use default UC channel function in discovery, fixed BC schedule (ARMmbed#2284) d65fcc6 Fix Wi-SUN network name comparison (ARMmbed#2294) f085132 Made parent set size configuraple in RPL fd11ffa Added HAVE_WS flag to FHSS api (ARMmbed#2296) 4f27500 Implemented optimal packet size test api (ARMmbed#2292) 87ee16a Call channel change after filtered out packet d196ffc Refactor Wi-SUN BBR stop function 35970d7 Revert "Disabled temporarily tx slot check for testing purposes (ARMmbed#2287)" (ARMmbed#2289) 8cc0ff5 Disabled temporarily tx slot check for testing purposes (ARMmbed#2287) e306dc5 Removed extra ";" 5642a4f Free TX failed list when FHSS deleted (ARMmbed#2285) 9fcf718 Updated FHSS optimal packet length to 300 bytes (ARMmbed#2282) 427743f ETX and Source route validation update 7b6bcca Added TX/RX bytes in PHY statistics (ARMmbed#2281) a043f8d Wi-sun FHSS Management update 2ff90e6 Configure TXRX slot length using given datarate (ARMmbed#2275) a126cb7 ETX sampling rule update d5cf8d5 Clean ARMC6/GCC compiler warnings (ARMmbed#2278) 807632d DHCP server freed next free allocated id fd6ce04 Thread Child ml16 update clear old address queue's and registered address. 99e6efa Neighbour remove operation update 5cd094c Corrected GTK update initial EAPOL-key trickle timer 7606ee8 Wi-sun NS Aro registration blacklisting update e3e5a00 Timed parent selection timer trigger update 7144121 RPL DIO Multicast message update 588f202 Wi-Sun RPL bootstrap update 20289f6 Added periodic RPL version number increase d8dd18d Added ignoring of incoming security messages and improved EAP-TLS startup 7350634 Corrected initial EAPOL-key trickle retries ac33518 Wi-sun ETX and proping update 11c486f Implemented unregistering FHSS from MAC. FHSS deleted in ifdown call. (ARMmbed#2266) eabca17 Wi-Sun Border router DHCPV server SLAAC mode enabled by default. 1d6ce9c DHCPv6 Server feature update 46aa460 Fixed unit test's. c65292e Mac enhanced ACK pending update 11a1e1d Store TX start channel and black list if TX failed (ARMmbed#2261) 0494606 Adapatation layer unicast list entry free update 4481e86 Updated trace level to info. c9e3d8e Interface down update 1f77ad6 Updated trace levels (ARMmbed#2258) 1d82fd5 Wi-sun BBR route update fix 33c48eb Removed NUD messages from registered children ec2ea92 Added RX and TX active times in PHY statistics (ARMmbed#2255) 49686cc Wi-sun certification test setup update 1090430 Trickle API update and Wi-SUN config sol state timeout update 38df576 Wi-sun advertisment consistent update 81740b8 Wi-sun bootstarp update nad balck list trace level update 6919ba1 Wi-sun New key index activate. 0aead93 Wi-sun Probe functionality revert operation 4ff02f9 Stop sending normal ACK if neighbour is Unknown. c387fda NS Probe limiter accept only 2 probe at 16 seconds period. a58c71b Trace level updates (ARMmbed#2247) 6867dd7 Suplicant EAP-TLS timeout is not incremented from retries 1f1c2a2 Test purpose change. 1b99fe1 Added ETX to rpl_possible_better_candidate 3441594 RPL parent candidate list update 96ffe92 Adaptation layer to support multiple simultaneous unicast transmissions (ARMmbed#2243) 45f8519 On stop (ifdown) stores frame counters regardless of threshold 5c2fc55 Corrected frame counter handling on re-discovery 9307416 Added check to prevent installing new GTK to used index using GKH 385ae14 WS bootstrap: print MAC address 2b1dfb9 Slaac address can be recreated after root stop 74ff3cc Merge branch 'release_internal' into release_external 66bfd98 Fixed trace printing warnings. 21d9c24 DHCP server address allocated pointer init fix. e659a01 Fixed compile warning for may uninitialized usage. cee8502 Fixed trace printing warnings. bc9f07b DHCP server address allocated pointer init fix. e3fddad Fixed compile warning for may uninitialized usage. bf909d2 Modified bbr restart mechanism when dodagid was lost git-subtree-dir: features/nanostack/sal-stack-nanostack git-subtree-split: fb7413b
artokin
pushed a commit
to artokin/mbed-os
that referenced
this pull request
Feb 21, 2020
…..fb7413b fb7413b Merge branch 'release_internal' into release_external a9f6e88 Merge branch 'master' into release_internal c536960 DHCPv6 Server feature update 01e7e82 Merge pull request ARMmbed#2314 from ARMmbed/update_from_mbedos c906c43 Fixed typo: 'lenght' in ns_crc.h 2bd0558 Wi-sun border router DHCPv6 server address alocation update 63e4680 Allow buffer_dyn to handle more data (ARMmbed#2311) 9b82abf Copy IE unicast channel function from WS info instead of FHSS configu… (ARMmbed#2310) 18247d5 Wi-sun RPL memory soft and hard limit update c8560db Updated RPL default memory sof and hard limit to 2/4 from 1/2. 05aa54c Update MPL parameters to follow Specification f728d55 Support for handle CRC error which will automatically change a channel. 6b6f535 Corrected EUI-64 address bit flip on supplicant 015f3fe Corrected bitfield definition 7717ef8 Improved initial EAPOL-key send stop logic on supplicant 4185734 Improved EAPOL key update retry logic 8bda176 Wi-sun boot fix 6283dfd DIO advertisment fix 1acec7c Aro Registation and Dao update 6cde17a Iotthd 3963 2 (ARMmbed#2301) b9187da Randomize fixed channel when making new parent selection 34d0339 Wi-sun address registartion update 5b30559 Allow unicast TX to overlap with MC (ARMmbed#2298) d40b1c7 MAC: Updated calling FHSS TX done (ARMmbed#2295) aeb93a1 Add support for bbr configuration that removes default route from DIO 9b941af Use default UC channel function in discovery, fixed BC schedule (ARMmbed#2284) d65fcc6 Fix Wi-SUN network name comparison (ARMmbed#2294) f085132 Made parent set size configuraple in RPL fd11ffa Added HAVE_WS flag to FHSS api (ARMmbed#2296) 4f27500 Implemented optimal packet size test api (ARMmbed#2292) 87ee16a Call channel change after filtered out packet d196ffc Refactor Wi-SUN BBR stop function 35970d7 Revert "Disabled temporarily tx slot check for testing purposes (ARMmbed#2287)" (ARMmbed#2289) 8cc0ff5 Disabled temporarily tx slot check for testing purposes (ARMmbed#2287) e306dc5 Removed extra ";" 5642a4f Free TX failed list when FHSS deleted (ARMmbed#2285) 9fcf718 Updated FHSS optimal packet length to 300 bytes (ARMmbed#2282) 427743f ETX and Source route validation update 7b6bcca Added TX/RX bytes in PHY statistics (ARMmbed#2281) a043f8d Wi-sun FHSS Management update 2ff90e6 Configure TXRX slot length using given datarate (ARMmbed#2275) a126cb7 ETX sampling rule update d5cf8d5 Clean ARMC6/GCC compiler warnings (ARMmbed#2278) 807632d DHCP server freed next free allocated id fd6ce04 Thread Child ml16 update clear old address queue's and registered address. 99e6efa Neighbour remove operation update 5cd094c Corrected GTK update initial EAPOL-key trickle timer 7606ee8 Wi-sun NS Aro registration blacklisting update e3e5a00 Timed parent selection timer trigger update 7144121 RPL DIO Multicast message update 588f202 Wi-Sun RPL bootstrap update 20289f6 Added periodic RPL version number increase d8dd18d Added ignoring of incoming security messages and improved EAP-TLS startup 7350634 Corrected initial EAPOL-key trickle retries ac33518 Wi-sun ETX and proping update 11c486f Implemented unregistering FHSS from MAC. FHSS deleted in ifdown call. (ARMmbed#2266) eabca17 Wi-Sun Border router DHCPV server SLAAC mode enabled by default. 1d6ce9c DHCPv6 Server feature update 46aa460 Fixed unit test's. c65292e Mac enhanced ACK pending update 11a1e1d Store TX start channel and black list if TX failed (ARMmbed#2261) 0494606 Adapatation layer unicast list entry free update 4481e86 Updated trace level to info. c9e3d8e Interface down update 1f77ad6 Updated trace levels (ARMmbed#2258) 1d82fd5 Wi-sun BBR route update fix 33c48eb Removed NUD messages from registered children ec2ea92 Added RX and TX active times in PHY statistics (ARMmbed#2255) 49686cc Wi-sun certification test setup update 1090430 Trickle API update and Wi-SUN config sol state timeout update 38df576 Wi-sun advertisment consistent update 81740b8 Wi-sun bootstarp update nad balck list trace level update 6919ba1 Wi-sun New key index activate. 0aead93 Wi-sun Probe functionality revert operation 4ff02f9 Stop sending normal ACK if neighbour is Unknown. c387fda NS Probe limiter accept only 2 probe at 16 seconds period. a58c71b Trace level updates (ARMmbed#2247) 6867dd7 Suplicant EAP-TLS timeout is not incremented from retries 1f1c2a2 Test purpose change. 1b99fe1 Added ETX to rpl_possible_better_candidate 3441594 RPL parent candidate list update 96ffe92 Adaptation layer to support multiple simultaneous unicast transmissions (ARMmbed#2243) 45f8519 On stop (ifdown) stores frame counters regardless of threshold 5c2fc55 Corrected frame counter handling on re-discovery 9307416 Added check to prevent installing new GTK to used index using GKH 385ae14 WS bootstrap: print MAC address 2b1dfb9 Slaac address can be recreated after root stop 74ff3cc Merge branch 'release_internal' into release_external 66bfd98 Fixed trace printing warnings. 21d9c24 DHCP server address allocated pointer init fix. e659a01 Fixed compile warning for may uninitialized usage. cee8502 Fixed trace printing warnings. bc9f07b DHCP server address allocated pointer init fix. e3fddad Fixed compile warning for may uninitialized usage. bf909d2 Modified bbr restart mechanism when dodagid was lost git-subtree-dir: features/nanostack/sal-stack-nanostack git-subtree-split: fb7413b
artokin
pushed a commit
to artokin/mbed-os
that referenced
this pull request
Feb 26, 2020
…..fb7413b fb7413b Merge branch 'release_internal' into release_external a9f6e88 Merge branch 'master' into release_internal c536960 DHCPv6 Server feature update 01e7e82 Merge pull request ARMmbed#2314 from ARMmbed/update_from_mbedos c906c43 Fixed typo: 'lenght' in ns_crc.h 2bd0558 Wi-sun border router DHCPv6 server address alocation update 63e4680 Allow buffer_dyn to handle more data (ARMmbed#2311) 9b82abf Copy IE unicast channel function from WS info instead of FHSS configu… (ARMmbed#2310) 18247d5 Wi-sun RPL memory soft and hard limit update c8560db Updated RPL default memory sof and hard limit to 2/4 from 1/2. 05aa54c Update MPL parameters to follow Specification f728d55 Support for handle CRC error which will automatically change a channel. 6b6f535 Corrected EUI-64 address bit flip on supplicant 015f3fe Corrected bitfield definition 7717ef8 Improved initial EAPOL-key send stop logic on supplicant 4185734 Improved EAPOL key update retry logic 8bda176 Wi-sun boot fix 6283dfd DIO advertisment fix 1acec7c Aro Registation and Dao update 6cde17a Iotthd 3963 2 (ARMmbed#2301) b9187da Randomize fixed channel when making new parent selection 34d0339 Wi-sun address registartion update 5b30559 Allow unicast TX to overlap with MC (ARMmbed#2298) d40b1c7 MAC: Updated calling FHSS TX done (ARMmbed#2295) aeb93a1 Add support for bbr configuration that removes default route from DIO 9b941af Use default UC channel function in discovery, fixed BC schedule (ARMmbed#2284) d65fcc6 Fix Wi-SUN network name comparison (ARMmbed#2294) f085132 Made parent set size configuraple in RPL fd11ffa Added HAVE_WS flag to FHSS api (ARMmbed#2296) 4f27500 Implemented optimal packet size test api (ARMmbed#2292) 87ee16a Call channel change after filtered out packet d196ffc Refactor Wi-SUN BBR stop function 35970d7 Revert "Disabled temporarily tx slot check for testing purposes (ARMmbed#2287)" (ARMmbed#2289) 8cc0ff5 Disabled temporarily tx slot check for testing purposes (ARMmbed#2287) e306dc5 Removed extra ";" 5642a4f Free TX failed list when FHSS deleted (ARMmbed#2285) 9fcf718 Updated FHSS optimal packet length to 300 bytes (ARMmbed#2282) 427743f ETX and Source route validation update 7b6bcca Added TX/RX bytes in PHY statistics (ARMmbed#2281) a043f8d Wi-sun FHSS Management update 2ff90e6 Configure TXRX slot length using given datarate (ARMmbed#2275) a126cb7 ETX sampling rule update d5cf8d5 Clean ARMC6/GCC compiler warnings (ARMmbed#2278) 807632d DHCP server freed next free allocated id fd6ce04 Thread Child ml16 update clear old address queue's and registered address. 99e6efa Neighbour remove operation update 5cd094c Corrected GTK update initial EAPOL-key trickle timer 7606ee8 Wi-sun NS Aro registration blacklisting update e3e5a00 Timed parent selection timer trigger update 7144121 RPL DIO Multicast message update 588f202 Wi-Sun RPL bootstrap update 20289f6 Added periodic RPL version number increase d8dd18d Added ignoring of incoming security messages and improved EAP-TLS startup 7350634 Corrected initial EAPOL-key trickle retries ac33518 Wi-sun ETX and proping update 11c486f Implemented unregistering FHSS from MAC. FHSS deleted in ifdown call. (ARMmbed#2266) eabca17 Wi-Sun Border router DHCPV server SLAAC mode enabled by default. 1d6ce9c DHCPv6 Server feature update 46aa460 Fixed unit test's. c65292e Mac enhanced ACK pending update 11a1e1d Store TX start channel and black list if TX failed (ARMmbed#2261) 0494606 Adapatation layer unicast list entry free update 4481e86 Updated trace level to info. c9e3d8e Interface down update 1f77ad6 Updated trace levels (ARMmbed#2258) 1d82fd5 Wi-sun BBR route update fix 33c48eb Removed NUD messages from registered children ec2ea92 Added RX and TX active times in PHY statistics (ARMmbed#2255) 49686cc Wi-sun certification test setup update 1090430 Trickle API update and Wi-SUN config sol state timeout update 38df576 Wi-sun advertisment consistent update 81740b8 Wi-sun bootstarp update nad balck list trace level update 6919ba1 Wi-sun New key index activate. 0aead93 Wi-sun Probe functionality revert operation 4ff02f9 Stop sending normal ACK if neighbour is Unknown. c387fda NS Probe limiter accept only 2 probe at 16 seconds period. a58c71b Trace level updates (ARMmbed#2247) 6867dd7 Suplicant EAP-TLS timeout is not incremented from retries 1f1c2a2 Test purpose change. 1b99fe1 Added ETX to rpl_possible_better_candidate 3441594 RPL parent candidate list update 96ffe92 Adaptation layer to support multiple simultaneous unicast transmissions (ARMmbed#2243) 45f8519 On stop (ifdown) stores frame counters regardless of threshold 5c2fc55 Corrected frame counter handling on re-discovery 9307416 Added check to prevent installing new GTK to used index using GKH 385ae14 WS bootstrap: print MAC address 2b1dfb9 Slaac address can be recreated after root stop 74ff3cc Merge branch 'release_internal' into release_external 66bfd98 Fixed trace printing warnings. 21d9c24 DHCP server address allocated pointer init fix. e659a01 Fixed compile warning for may uninitialized usage. cee8502 Fixed trace printing warnings. bc9f07b DHCP server address allocated pointer init fix. e3fddad Fixed compile warning for may uninitialized usage. bf909d2 Modified bbr restart mechanism when dodagid was lost git-subtree-dir: features/nanostack/sal-stack-nanostack git-subtree-split: fb7413b
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The configuration system uses
mbed_config.hto export configurationdata, but when this change was made, the documentation was not properly
updated. This commit updates the documentation with the correct
behaviour of the configuration system.