Merge branch 'ft/diff-rename-default-score-is-half' into maint
[gitweb.git] / t / README
index 35b3c5c2faec0ed543dde460a30de63c48e5f1e7..ec5246886132f919ec4b6b05bfedd65eb2011690 100644 (file)
--- a/t/README
+++ b/t/README
@@ -595,6 +595,20 @@ library for your script to use.
                test_cmp expected actual
        '
 
+ - test_ln_s_add <path1> <path2>
+
+   This function helps systems whose filesystem does not support symbolic
+   links. Use it to add a symbolic link entry to the index when it is not
+   important that the file system entry is a symbolic link, i.e., instead
+   of the sequence
+
+       ln -s foo bar &&
+       git add bar
+
+   Sometimes it is possible to split a test in a part that does not need
+   the symbolic link in the file system and a part that does; then only
+   the latter part need be protected by a SYMLINKS prerequisite (see below).
+
 Prerequisites
 -------------