espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2025-05-17 07:16:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

[docs] update description syntax for proper rendering (#11502)

Browse Source
This commit is contained in:
jrhodie
2025-05-15 11:08:46 -07:00
committed by GitHub
parent afd44695f5
commit fb0446f53b
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/openthread/border_agent.h
View File

@ -269,7 +269,7 @@ otError otBorderAgentGetMeshCoPServiceTxtData(otInstance *aInstance, otBorderAge
* to be set after device initialization and at run-time.
*
* Per the Thread specification, the service instance should be a user-friendly name identifying the device model or
* product. A recommended format is "<VendorName> <ProductName>".
* product. A recommended format is "VendorName ProductName".
*
* To construct the full name and ensure name uniqueness, the OpenThread Border Agent module will append the Extended
* Address of the device (as 16-character hex digits) to the given base name.

2
src/cli/README.md
View File

@ -418,7 +418,7 @@ Requires the `OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_ENABLE` feature.
The name can also be configured using the `OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME` configuration option (which is the recommended way to specify this name). This CLI command (and its corresponding API) is provided for projects where the name needs to be set after device initialization and at run-time.
Per the Thread specification, the service instance should be a user-friendly name identifying the device model or product. A recommended format is "<VendorName> <ProductName>". To construct the full name and ensure name uniqueness, the OpenThread Border Agent module will append the Extended Address of the device (as 16-character hex digits) to the given base name. Note that the same name will be used for the ephemeral key service `_meshcop-e._udp` when the ephemeral key feature is enabled and used.
Per the Thread specification, the service instance should be a user-friendly name identifying the device model or product. A recommended format is "VendorName ProductName". To construct the full name and ensure name uniqueness, the OpenThread Border Agent module will append the Extended Address of the device (as 16-character hex digits) to the given base name. Note that the same name will be used for the ephemeral key service `_meshcop-e._udp` when the ephemeral key feature is enabled and used.
```bash
ba servicebasename OpenThreadBorderAgent

2
src/core/config/border_agent.h
View File

@ -113,7 +113,7 @@
* The name can also be configured using the `otBorderAgentSetMeshCoPServiceBaseName()` API at run-time.
*
* Per the Thread specification, the service instance should be a user-friendly name identifying the device model or
* product. A recommended format is "<VendorName> <ProductName>".
* product. A recommended format is "VendorName ProductName".
*
* The name MUST have a length less than or equal to `OT_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME_MAX_LENGTH` (47 chars).
*/