From: Tomas Bzatek <tbzatek@redhat.com>
Date: Thu, 15 Feb 2024 15:33:20 +0000 (-0500)
Subject: doc: Document the NBFT API
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=724615ecc21496f32dc543ec4fc8cfd537a82826;p=users%2Fsagi%2Flibnvme.git

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 <tbzatek@redhat.com>
---

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 <sys/types.h>
 #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)
  */