Skip to content

Commit 579a903

Browse files
committed
Update README
Rename Notes section Add note on assumed pmem mount path
1 parent 44fd708 commit 579a903

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,12 @@ where `<mode>` is one of `posix`, `sync` or `strict`. Example: `make -C tests p
118118

119119
Tip: Redirect stderr for less verbose output: e.g `make test 2>/dev/null`
120120

121-
## Notes
121+
## Implementation Notes
122122
1. Only regular files, block special files and directories (only for consistency guarantees) are handled by SplitFS, the other file types are delegated to POSIX.
123123
2. Only files in the persistent memory mount are handled by SplitFS, rest are delegated to POSIX.
124124
Currently this is only done by examination of absolute paths specified, we aim to have this check for relative paths too, soon.
125+
3. Currently, the persistent memory mount is assumed to be at `/mnt/pmem_emul/`.
126+
We aim to have this controlled via a runtime environment variable soon.
125127

126128
## License
127129

0 commit comments

Comments
 (0)