xref: /spdk/test/external_code/README.md (revision 63ee471b6411a7b35c8e2495a0a89d61d4d3d10f)
1This directory is meant to demonstrate how to link an external application and bdev
2module to the SPDK libraries. The makefiles contain six examples of linking against spdk
3libraries. They cover linking an application both with and without a custom bdev. For each of
4these categories, they also demonstrate linking against the spdk combined shared library,
5individual shared libraries, and static libraries.
6
7This directory also contains a convenient test script, test_make.sh, which automates making SPDK
8and testing all six of these linker options. It takes a single argument, the path to an SPDK
9repository and should be run as follows:
10
11~~~bash
12sudo ./test_make.sh /path/to/spdk
13~~~
14
15The application `hello_bdev` is a symlink and bdev module `passthru_external` have been copied from their namesakes
16in the top level [SPDK github repository](https://github.com/spdk/spdk) and don't have any special
17functionality.
18