Add a note about a perl issue on VMS and how to work around it

I bug in perl's File::Spec->canonpath() was uncovered.  There's
nothing we can do about it (except re-implementing canonpath()),
except working around the problem (a directory rename) and reporting
the issue to the perl module developers.

Reviewed-by: Rich Salz <rsalz@openssl.org>

diff --git a/INSTALL b/INSTALL
index ed7849e7cbdc0c85b82dc1efeca8b9b769220055..3655eb7b3febb416c00e3256be258e2e0976b681 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -15,8 +15,8 @@
     header files
   * a supported operating system
 
- For additional platform specific requirements and other details,
- please read one of these:
+ For additional platform specific requirements, solutions to specific
+ issues and other details, please read one of these:
 
   * NOTES.VMS (OpenVMS)
   * NOTES.WIN (any supported Windows)

diff --git a/NOTES.VMS b/NOTES.VMS
index 6aeda11c77fe5e21b9f8acfa11710c5e6033cc8b..3e9a57e8052b60455c9ad400797dcec0e4f2ed16 100644 (file)
--- a/NOTES.VMS
+++ b/NOTES.VMS
@@ -27,6 +27,24 @@
  running the tests, as they affect the Perl interpreter.
 
 
+ About ODS-5 directory names and Perl
+ ------------------------------------
+
+ It seems that the perl function canonpath() in the File::Spec module
+ doesn't treat file specifications where the last directory name
+ contains periods very well.  Unfortunately, some versions of VMS tar
+ will keep the periods in the OpenSSL source directory instead of
+ converting them to underscore, thereby leaving your source in
+ something like [.openssl-1^.1^.0].  This will lead to issues when
+ configuring and building OpenSSL.
+
+ We have no replacement for Perl's canonpath(), so the best workaround
+ for now is to rename the OpenSSL source directory, as follows (please
+ adjust for the actual source directory name you have):
+
+    $ rename openssl-1^.1^.0.DIR openssl-1_1_0.DIR 
+
+
  About MMS and DCL
  -----------------