From fb388ceb536a2a43b3b5c2d3ae6262a8d3e5cea5 Mon Sep 17 00:00:00 2001 From: timbo Date: Sat, 31 Dec 2005 17:42:40 +0000 Subject: [PATCH] Doc updates thanks to Honza Pazdziora git-svn-id: http://svn.perl.org/modules/dbd-oracle/trunk@2348 50811bd7-b8ce-0310-adc1-d9db26280581 --- Makefile.PL | 25 ++++++++++++----------- README | 53 ++++++++++++++++++++++++------------------------ README.help.txt | 5 +++-- README.hpux.txt | 2 +- README.java.txt | 2 +- README.vms.txt | 2 +- README.win32.txt | 2 +- t/01base.t | 4 ++-- test.pl | 2 +- 9 files changed, 49 insertions(+), 48 deletions(-) diff --git a/Makefile.PL b/Makefile.PL index 2326c379..b36509a9 100755 --- a/Makefile.PL +++ b/Makefile.PL @@ -148,7 +148,7 @@ $OH =~ s:/$::; die qq{ The $ORACLE_ENV environment variable must be set. It must be set to hold the path to an Oracle installation directory on this machine (or a machine with a compatible architecture). - See the README.clients file for more information. + See the README.clients.txt file for more information. ABORTED! } unless $OH; @@ -157,7 +157,7 @@ print "os=$os\n"; die qq{ The $ORACLE_ENV environment variable value ($OH) is not valid. It must be set to hold the path to an Oracle installation directory on this machine (or a machine with a compatible architecture) - See the README.clients file for more information. + See the README.clients.txt file for more information. ABORTED! } unless (($os eq 'VMS') ? -d $OH : (-e "$OH/libclntsh.so.10.1" || -e "$OH/oci.dll") ? 1 : -d "$OH/lib/."); @@ -168,7 +168,7 @@ die qq{ The $ORACLE_ENV environment variable value ($OH) is not valid. die qq{ The $ORACLE_ENV environment variable value ($OH) is not valid. It must be set to hold the path to an Oracle installation directory on this machine (or a machine with a compatible architecture) - See the README.clients file for more information. + See the README.clients.txt file for more information. ABORTED! } unless ( -d $OH ); @@ -194,7 +194,8 @@ if ($os eq 'darwin') { close FH; unless ($stripped) { warn "WARNING: symbol table may need modification in Oracle library:\n" - ."\t$oracle_lib\nIF the build fails in the linking stage, manual modification is required - see README.macosx\n"; + ."\t$oracle_lib\nIF the build fails in the linking stage,\n" + . "manual modification is required - see README.macosx.txt\n"; } } @@ -253,7 +254,7 @@ elsif (($os eq 'MSWin32') or ($os =~ /cygwin/i)) { if ($Config{cc} =~ /gcc/i) { system("dlltool --input-def oci.def --output-lib liboci.a") if ! -f "liboci.a"; - die "Could not find or create liboci.a. See README.wingcc\n" + die "Could not find or create liboci.a. See README.wingcc.txt\n" if ! -f "liboci.a"; my $pwd = cwd(); $opts{LIBS} = [ "-L$pwd -loci" ]; @@ -603,13 +604,13 @@ else { # --- trawl the guts of Oracle's make files looking the how it wants to l if ($Config{cc} =~ /gcc/i) { print "Warning: perl was not built with -fpic or -fPIC in compiler flags.\n", " You may need to rebuild perl from sources.\n", - " See instructions in README.hpux\n" + " See instructions in README.hpux.txt\n" unless $ccf =~ m/-fpic\b/i; } else { print "Warning: perl was not built with +z or +Z in compiler flags.\n", " You may need to rebuild perl from sources.\n", - " See instructions in README.hpux\n" + " See instructions in README.hpux.txt\n" unless $ccf =~ m/\+[zZ]/; } } @@ -715,7 +716,7 @@ if ($os eq 'hpux') { $opts{LINKTYPE} = 'static'; } else { - print "*** Warning: If you have trouble, see README.hpux...\n" + print "*** Warning: If you have trouble, see README.hpux.txt...\n" ." you may have to build your own perl, or go hunting for libraries\n"; } print "*** Warning: If you have trouble, try perl Makefile.PL -l\n" unless $::opt_l; @@ -814,7 +815,7 @@ check_security() unless $os eq 'VMS' or $os eq 'MSWin32' or $os =~ /cygwin/i; print "\n"; print "*** If you have problems...\n"; -print " read all the log printed above, and the README and README.help files.\n"; +print " read all the log printed above, and the README and README.help.txt files.\n"; print " (Of course, you have read README by now anyway, haven't you?)\n\n"; exit 0; @@ -1082,7 +1083,7 @@ sub find_mkfile { somewhere non-standard you can specify where it is using the -m option: perl Makefile.PL -m /path/to/your.mk - See README.clients for more information and some alternatives. + See README.clients.txt for more information and some alternatives. } unless ($os eq 'MSWin32') || ($os eq 'VMS') || ($mkfile && -f $mkfile) || $::opt_F; @@ -1419,7 +1420,7 @@ sub find_headers { print "I can't find the header files I need in your Oracle installation.\n"; print "You probably need to install some more Oracle components.\n"; print "I'll keep going, but the compile will probably fail.\n"; - print "See README.clients for more information.$BELL\n"; + print "See README.clients.txt for more information.$BELL\n"; print "*********************************************************\n\n"; sleep 5; } @@ -1758,7 +1759,7 @@ sub check_security { print "\n"; warn "*** WARNING - YOUR ORACLE INSTALLATION HAS A SECURITY PROBLEM.$BELL\n"; - warn " Read the README.sec file for more information and patch details.$BELL\n"; + warn " Read the README.sec.txt file for more information and patch details.$BELL\n"; warn " This is just a warning. It does not affect DBD::Oracle in any way.\n\n"; sleep 6; } diff --git a/README b/README index efdc01ec..05ef429c 100644 --- a/README +++ b/README @@ -9,22 +9,22 @@ DBD::Oracle -- an Oracle interface for Perl 5. AND THEN READ ANY README.* FILES RELEVANT TO YOUR PLATFORM: - README.aix - AIX - README.hpux - HP-UX - README.java - Java/thread problem on Solaris - README.macosx - Mac OS/X - README.win32 - MS Windows - README.wingcc - MS Windows using GCC + README.aix.txt - AIX + README.hpux.txt - HP-UX + README.java.txt - Java/thread problem on Solaris + README.macosx.txt - Mac OS/X + README.win32.txt - MS Windows + README.wingcc.txt - MS Windows using GCC README.* - see if there's a file for your platform You may find these useful - README.help - Help and hints on build problems - README.sec - Oracle security issues to be aware of - README.login - Help on how to connect to Oracle - README.longs - Help on handling LONGs - README.utf8 - Help on using UFT8 - README.clients - What Oracle client files you need installed + README.help.txt - Help and hints on build problems + README.sec.txt - Oracle security issues to be aware of + README.login.txt - Help on how to connect to Oracle + README.longs.txt - Help on handling LONGs + README.utf8.txt - Help on using UFT8 + README.clients.txt - What Oracle client files you need installed *** QUICK START GUIDE: @@ -88,7 +88,7 @@ The supplied tests will connect to the database using the value of the ORACLE_USERID environment variable to supply the username/password so you should set that to a valid value (e.g. 'scott/tiger') before starting the test. Using 'system/manager' might work but is not -recommended! Please read README.login. +recommended! Please read README.login.txt. make test @@ -122,11 +122,11 @@ You should not need to make any changes. If you do please let me know so that I can try to make it automatic in a later release. If you just can't login or login takes a long time then read -README.login +README.login.txt If you can't get it to build on a minimally configured client system -then read README.client, it might help but basically I can't help much. -Others on the dbi-users mailing list probably can. +then read README.client.txt, it might help but basically I can't help +much. Others on the dbi-users mailing list probably can. If you have linking problems (errors related to libraries or functions) then you could try forcing a 'static' build using: @@ -140,7 +140,7 @@ then you could try forcing a 'static' build using: make install (install DBD::Oracle) ->>> Also carefully read the README.help file which is full of useful +>>> Also carefully read the README.help.txt file which is full of useful >>> tips and workarounds for various problems of various systems. @@ -221,14 +221,13 @@ Tim. =============================================================================== Examples and other info: -README.help -- READ IT FIRST IF YOU HAVE ANY PROBLEMS -README.win32 -- building DBD::Oracle under MS Windows -README.wingcc -- building DBD::Oracle under MS Windows with gcc -README.macosx -- building DBD::Oracle under MacOS X -README.clients -- building/using DBD::Oracle on minimally configured systems -README.login -- help for login problems -README.longs -- examples dealing with LONG types (blobs) -README.utf8 -- Perl 5.6.1, Oracle, and UTF-8 +README.help.txt -- READ IT FIRST IF YOU HAVE ANY PROBLEMS +README.win32.txt -- building DBD::Oracle under MS Windows +README.wingcc.txt -- building DBD::Oracle under MS Windows with gcc +README.macosx.txt -- building DBD::Oracle under MacOS X +README.clients.txt -- building/using DBD::Oracle on minimally configured systems +README.login.txt -- help for login problems +README.longs.txt -- examples dealing with LONG types (blobs) DBI 'home page': http://dbi.perl.org @@ -269,8 +268,8 @@ then the chances are that DBD::Oracle will as well. =============================================================================== -See the large README.help file for lots of hints and advice about building and -runtime issues. +See the large README.help.txt file for lots of hints and advice +about building and runtime issues. End. diff --git a/README.help.txt b/README.help.txt index 4df53452..cfbe9932 100644 --- a/README.help.txt +++ b/README.help.txt @@ -155,7 +155,7 @@ See 'Hang during "repetitive connect/open/close/disconnect" test' below. ------------------------------------------------------------------------------- HP-UX: General -Read README.hpux. Then read it again. +Read README.hpux.txt. Then read it again. HP's bundled C compiler is dumb. Very dumb. You're almost bound to have problems if you use it - you'll certainly need to do a 'static link' @@ -260,7 +260,8 @@ Verbrugghen jverbrug@be.oracle.com) ------------------------------------------------------------------------------- Connection/Login takes a long time -Try connect('', 'user/passwd@tnsname', ''). See README.login and item above. +Try connect('', 'user/passwd@tnsname', ''). See README.login.txt and +item above. ------------------------------------------------------------------------------- Error: ORA-00604: error occurred at recursive SQL level (DBD: login failed) diff --git a/README.hpux.txt b/README.hpux.txt index 298d457b..071f68fb 100644 --- a/README.hpux.txt +++ b/README.hpux.txt @@ -12,7 +12,7 @@ after resolving some undefined symbol errors, I succeeded where for I had previously despaired of finding the time to hack out the right incantation. -This F describes the combined knowledge of a number of +This F describes the combined knowledge of a number of folks who invested many hours discovering a working set of build options. The instructions in this file, which include building Perl from source, will produce a working dynamically linked DBD-Oracle that can diff --git a/README.java.txt b/README.java.txt index bd267b89..8958df27 100644 --- a/README.java.txt +++ b/README.java.txt @@ -1,4 +1,4 @@ -README.java +README.java.txt This file relates to a specific problem on Solaris platforms for Oracle 8.1.6 (and possibly later versions) where loading diff --git a/README.vms.txt b/README.vms.txt index 137ac862..1826395b 100644 --- a/README.vms.txt +++ b/README.vms.txt @@ -1,4 +1,4 @@ -=head1 README.vms for DBI and DBD::Oracle +=head1 README.vms.txt for DBI and DBD::Oracle Date: Wed, 15 Sep 2004 11:44:09 +0300 From: Jakob Snoer diff --git a/README.win32.txt b/README.win32.txt index 0ae5d072..39f09c15 100644 --- a/README.win32.txt +++ b/README.win32.txt @@ -1,7 +1,7 @@ In general, on Windows, it's best to just use ActiveState Perl and the PPM package manager to install a pre-built version of DBD::Oracle. -If you built Perl with gcc, read README.wingcc as well as this file. +If you built Perl with gcc, read README.wingcc.txt as well as this file. --- other information, some of which is out of date --- diff --git a/t/01base.t b/t/01base.t index f760fdc8..559a69cd 100755 --- a/t/01base.t +++ b/t/01base.t @@ -26,10 +26,10 @@ if ($@) { warn "The remaining tests will probably also fail with the same error.\a\n\n"; # try to provide some useful pointers for some cases if ($@ =~ /Solaris patch.*Java/i) { - warn "*** Please read the README.java file for help. ***\n"; + warn "*** Please read the README.java.txt file for help. ***\n"; } else { - warn "*** Please read the README and README.help files for help. ***\n"; + warn "*** Please read the README and README.help.txt files for help. ***\n"; } warn "\n"; sleep 5; diff --git a/test.pl b/test.pl index 15ba8d0e..30881cea 100755 --- a/test.pl +++ b/test.pl @@ -96,7 +96,7 @@ &test1(); print "\nTesting repetitive connect/open/close/disconnect:\n"; -print "If this test hangs then read the README.help file.\n"; +print "If this test hangs then read the README.help.txt file.\n"; print "Expect sequence of digits, no other messages:\n"; #DBI->internal->{DebugDispatch} = 2; foreach(1..$opt_n) { print "$_ "; &test2(); }