ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
c5e5047d99
Spdk/doc
History
Jim Harris d12ba75bd1 blob: add per-blob feature flags 
Similar flags will be added at the blobstore level in a future
patch.

This allows backwards compatibility - i.e. allow older blobstore
applications to open blobstores created by newer blobstore
applications with new features.  Any blob's using a new feature
should have an associated flag set in one of three new flag masks:

- invalid: if a bit is set in this mask that the application is not
	   aware of, do not allow the blob to be opened
- data_ro: if a bit is set in this mask that the application is not
	   aware of, allow the blob to be opened, but do not allow
	   write I/O nor any operation that changes metadata
- md_ro:   if a bit is set in this mask that the application is not
	   aware of, allow the blob to be opened for performing any
	   kind of I/O, but do not allow any operation that changes
	   metadata

While here, bump SPDK_BS_VERSION to 3.  We intend this to be the
last change made to SPDK_BS_VERSION - future versioning will be
done via blobstore or per-blob feature flags instead.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: If059e38bfffbeec25c849a7629a81193b12302c4

Reviewed-on: https://review.gerrithub.io/388703
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-12-04 12:07:21 -05:00
..
.gitignore doc: include changelog in documentation 2017-08-28 13:44:13 -04:00
bdev.md bdev_virtio: added doc page 2017-10-20 19:44:23 -04:00
blob.md blob: add per-blob feature flags 2017-12-04 12:07:21 -05:00
blobfs.md scripts: replace NRHUGE with HUGEMEM in setup.sh 2017-10-12 18:27:21 -04:00
directory_structure.md vhost: Getting Started for SPDK vhost 2017-03-29 13:09:57 -07:00
Doxyfile doc: enable Doxygen tree view navigation 2017-10-31 18:00:12 -04:00
event.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
footer.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
getting_started.md doc: add 'sudo' to pkgdep invocation 2017-12-01 17:08:12 -05:00
header.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
index.md bdev_virtio: added doc page 2017-10-20 19:44:23 -04:00
ioat.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
iscsi.md doc: add a section for user guides 2017-09-26 19:40:58 -04:00
jsonrpc.md doc/jsonrpc: add app RPC method documentation 2017-12-01 16:40:06 -05:00
lvol.md lvol: updated documentation. 2017-10-26 15:04:27 -04:00
Makefile doc: include changelog in documentation 2017-08-28 13:44:13 -04:00
memory.md Add documentation explaining memory management 2017-06-15 14:11:58 -04:00
nvme-cli.md doc: add the documentation for nvme-cli support 2017-07-19 13:52:14 -04:00
nvme.md doc: Improve NVMe documentation entry page 2017-06-22 15:49:28 -04:00
nvmf.md doc: add a section for user guides 2017-09-26 19:40:58 -04:00
porting.md doc: move porting guide into doc/ and add to index 2017-01-17 16:25:04 -07:00
README.md Change doc link to new spdk.io/doc location 2016-12-19 15:57:12 -07:00
stylesheet.css doc: enable Doxygen tree view navigation 2017-10-31 18:00:12 -04:00
vagrant.md doc/vagrant: add commands to run for proxyconf 2017-09-18 12:53:49 -04:00
vhost.md doc/vhost: make some updates to vhost documentation 2017-12-01 17:13:25 -05:00
virtio.md bdev_virtio: added doc page 2017-10-20 19:44:23 -04:00

README.md

SPDK Documentation

The current version of the SPDK documentation can be found online at http://www.spdk.io/doc/

Building the Documentation

To convert the documentation into HTML, install Doxygen and mscgen and run make in the doc directory. The output will be located in doc/output/html.