From 724615ecc21496f32dc543ec4fc8cfd537a82826 Mon Sep 17 00:00:00 2001 From: Tomas Bzatek Date: Thu, 15 Feb 2024 10:33:20 -0500 Subject: [PATCH] doc: Document the NBFT API Added an explicit note about unstable API, that is in fact semi-unstable whereas existing structures are stable and new API will possibly be added at the end of the structs. Signed-off-by: Tomas Bzatek --- doc/api.rst.in | 1 + src/nvme/nbft.h | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/doc/api.rst.in b/doc/api.rst.in index 34787661..57188f63 100644 --- a/doc/api.rst.in +++ b/doc/api.rst.in @@ -16,3 +16,4 @@ functions. .. include:: rst/filters.rst .. include:: rst/util.rst .. include:: rst/log.rst +.. include:: rst/nbft.rst diff --git a/src/nvme/nbft.h b/src/nvme/nbft.h index 6012e160..48aaecf4 100644 --- a/src/nvme/nbft.h +++ b/src/nvme/nbft.h @@ -12,6 +12,14 @@ #include #include "util.h" +/** + * DOC: nbft.h + * + * NVM Express Boot Specification, Revision 1.0 + * + * Note: this API is currently unstable, subject to further additions. + */ + /* * ACPI NBFT table structures (TP8012 Boot Specification rev. 1.0) */ -- 2.50.1