Commit 3cf53552 authored by Tigran Mkrtchyan's avatar Tigran Mkrtchyan
Browse files

docs: add API-changes file to describe migration path

Motivation:
as nfs4j api is not stable yet, breaking changes have to be documented.

Modification:
add API-changes.md as well as warning in the README.md

Result:
library users are better informed.

Acked-by: Paul Millar
Acked-by: Lea Morschel
Acked-by: Olufemi Adeyemi
Target: master
parent 0fc77645
# Changes to NFS4J public API
## 0.19
- NFSv41DeviceManager methods updated to take raw XDR arguments:
- layoutGet(...) -> layoutGet(CompoundContext context, LAYOUTGET4args args)
- layoutReturn(...) -> layoutReturn(CompoundContext context, LAYOUTRETURN4args args)
- getDeviceInfo(...) -> getDeviceInfo(CompoundContext context, GETDEVICEINFO4args args)
- getDeviceList(...) -> getDeviceList(CompoundContext context, GETDEVICELIST4args args)
- NFSv41DeviceManager extended with additional methods:
- layoutCommit
- layoutError
- layoutStats
- io_info4 modified to use primitive longs as member fields
- LayoutDriver#acceptLayoutReturnData accepts CompoundContext as argument
- Introduced `ExportTable` interface to allow alternative ways for file system export management.
......@@ -81,6 +81,16 @@ Use NFS4J in your project
</repositories>
```
IMPORTANT WARNINGS
------------------
Though **NFS4J** is used by the [dCache](https://dcache.org) and other projects in production,
the public API is still _unstable_ and subject to change (indicated by leading zero in the
version number). Thus, is should be considered as `beta`.
Please consult the [API changes](API-changes.md) document when switching between version numbers.
The patch level releases are not affected by API changes, of course.
License
--------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment