This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
5.004 removed deprecated %OVERLOAD support silently
[perl5.git] / hints / README.hints
index 84503ce..2c27068 100644 (file)
@@ -1,57 +1,39 @@
 These files are used by Configure to set things which Configure either
-can't or doesn't guess properly.  Most of these hints files are from
-perl4.  They may or may not work with perl5, but they are probably a
-good starting point.
+can't or doesn't guess properly.  Most of these hint files have been
+tested with at least some version of perl5, but some are still left
+over from perl4.  I would appreciate hearing about any problems
+or suggested changes.
 
-The following hints files have been tested with at least some version
-of perl5 and are probably reasonably close to being correct:
+Hint file naming convention:   Each hint file name should have only
+one '.'.  (This is for portability to non-unix filesystems.)  Names
+should also fit in <= 14 characters, for portability to older SVR3
+systems.  File names are of the form $osname_$osvers.sh, with all '.'
+changed to '_', and all characters such as '/' that don't belong in
+Unix filenames omitted.
 
-aix.sh
-bsd386.sh
-dec_osf.sh
-dgux.sh
-esix4.sh
-freebsd.sh
-hpux_9.sh
-irix_4.sh
-irix_5.sh
-isc.sh
-linux.sh
-netbsd.sh
-next_3_2.sh
-sco_3.sh
-solaris_2.sh
-sunos_4_1.sh
-svr4.sh
-titanos.sh
-ultrix_4.sh
-unicos.sh
-utekv.sh
+For example, consider SunOS 4.1.3.  Configure determines $osname=sunos
+(all names are converted to lower case) and $osvers=4.1.3.  Configure
+will search for an appropriate hint file in the following order:
 
-The following hints files have not been tested with perl5:
+       sunos_4_1_3.sh
+       sunos_4_1.sh
+       sunos_4.sh
+       sunos.sh
 
-3b1.sh
-altos486.sh
-apollo.sh
-aux.sh
-dnix.sh
-dynix.sh
-fps.sh
-genix.sh
-greenhills.sh
-i386.sh
-isc_2.sh
-mips.sh
-mpc.sh
-ncr_tower.sh
-opus.sh
-sco_2_3_0.sh
-sco_2_3_1.sh
-sco_2_3_2.sh
-sco_2_3_3.sh
-sco_2_3_4.sh
-stellar.sh
-sunos_4_0.sh
-ti1500.sh
-unisysdynix.sh
-uts.sh
+If you need to create a hint file, please try to use as general a name
+as possible and include minor version differences inside case or test
+statements.  Be sure also to include a default choice.  (See
+aix.sh for one example.) That way, if you write a hint file for
+foonix 3.2, it might still work without any changes when foonix 3.3 is
+released.
+
+Please also comment carefully on why the different hints are needed.
+That way, a future version of Configure may be able to automatically
+detect what is needed.  A glossary of config.sh variables is in the
+file Porting/Glossary.
+
+Have the appropriate amount of fun :-)
+
+    Andy Dougherty             doughera@lafcol.lafayette.edu
+    Dept. of Physics
+    Lafayette College, Easton PA 18042