Skip to content

Commit 724615e

Browse files
tbzatekigaw
authored andcommitted
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 <[email protected]>
1 parent ac74231 commit 724615e

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

doc/api.rst.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ functions.
1616
.. include:: rst/filters.rst
1717
.. include:: rst/util.rst
1818
.. include:: rst/log.rst
19+
.. include:: rst/nbft.rst

src/nvme/nbft.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@
1212
#include <sys/types.h>
1313
#include "util.h"
1414

15+
/**
16+
* DOC: nbft.h
17+
*
18+
* NVM Express Boot Specification, Revision 1.0
19+
*
20+
* Note: this API is currently unstable, subject to further additions.
21+
*/
22+
1523
/*
1624
* ACPI NBFT table structures (TP8012 Boot Specification rev. 1.0)
1725
*/

0 commit comments

Comments
 (0)