ENH: Docs for relative paths in link_directories

The link_directories command treats relative paths differently from most
CMake commands.  This notes the difference in the documentation.
See issue #8377.

1 files changed, 6 insertions, 1 deletions

diff --git a/Source/cmLinkDirectoriesCommand.h b/Source/cmLinkDirectoriesCommand.h
index 7f37ebf..b575931 100644
--- a/Source/cmLinkDirectoriesCommand.h
+++ b/Source/cmLinkDirectoriesCommand.h
@@ -66,7 +66,12 @@ public:
     return
       "  link_directories(directory1 directory2 ...)\n"
       "Specify the paths in which the linker should search for libraries. "
-      "The command will apply only to targets created after it is called.";
+      "The command will apply only to targets created after it is called. "
+      "For historical reasons, relative paths given to this command are "
+      "passed to the linker unchanged "
+      "(unlike many CMake commands which interpret them relative to the "
+      "current source directory)."
+      ;
     }
   
   cmTypeMacro(cmLinkDirectoriesCommand, cmCommand);