This is an automated email from the ASF dual-hosted git repository.
sjanc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-nimble.git
The following commit(s) were added to refs/heads/master by this push:
new 21df8689a host: document GATT error status encoding
21df8689a is described below
commit 21df8689a3fd8c454fe92444c44dcc863d1b8374
Author: Old-Ding <[email protected]>
AuthorDate: Wed Jul 1 11:34:44 2026 +0800
host: document GATT error status encoding
Clarify that ble_gatt_error.status follows the NimBLE host return-code
convention. Point readers to the return-code documentation instead of
describing implementation-specific ATT encoding details.
Signed-off-by: Old-Ding <[email protected]>
---
nimble/host/include/host/ble_gatt.h | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/nimble/host/include/host/ble_gatt.h
b/nimble/host/include/host/ble_gatt.h
index df9c36bbe..9fa418a11 100644
--- a/nimble/host/include/host/ble_gatt.h
+++ b/nimble/host/include/host/ble_gatt.h
@@ -204,7 +204,12 @@ struct ble_hs_cfg;
/*** @client. */
/** Represents a GATT error. */
struct ble_gatt_error {
- /** The GATT status code indicating the type of error. */
+ /**
+ * The NimBLE host status code indicating the type of error.
+ *
+ * Values follow the NimBLE host return-code convention; see:
+ * https://mynewt.apache.org/latest/network/ble_hs/ble_hs_return_codes.html
+ */
uint16_t status;
/** The attribute handle associated with the error. */
