Document hardlink limitation.

2 files changed, 12 insertions, 0 deletions

diff --git a/ChangeLog b/ChangeLog
index a1c11d6..cd8f71c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,7 @@
 Unreleased Changes
 ------------------
 
+* Documented limited hardlink support.
 * Added support for building with Meson.
 * Added support for more SSH options.
 * Dropped support for the *nodelay* workaround - the last OpenSSH
diff --git a/README.rst b/README.rst
index 943d12f..0a536a6 100644
--- a/README.rst
+++ b/README.rst
@@ -88,6 +88,9 @@ the sshfs developers know!
 Caveats
 -------
 
+Rename
+~~~~~~
+
 Some SSH servers do not support atomically overwriting the destination
 when renaming a file. In this case you will get an error when you
 attempt to rename a file and the destination already exists. A
@@ -98,6 +101,14 @@ someone (or something) recreates the destination file after SSHFS has
 removed it, but before SSHFS had the time to rename the old file. In
 this case, the rename will still fail.
 
+Hardlinks
+~~~~~~~~~
+
+If the SSH server supports the *hardlinks* extension, SSHFS will allow
+you to create hardlinks. However, hardlinks will always appear as
+individual files when seen through an SSHFS mount, i.e. they will
+appear to have different inodes and an *st_nlink* value of 1.
+
 
 Getting Help
 ------------