Skip to content

Commit

Permalink
Doc updates thanks to Honza Pazdziora
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.perl.org/modules/dbd-oracle/trunk@2348 50811bd7-b8ce-0310-adc1-d9db26280581
  • Loading branch information
timbo committed Dec 31, 2005
1 parent 26b52ba commit fb388ce
Show file tree
Hide file tree
Showing 9 changed files with 49 additions and 48 deletions.
25 changes: 13 additions & 12 deletions Makefile.PL
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -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/.");

Expand All @@ -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 );
Expand All @@ -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";
}
}

Expand Down Expand Up @@ -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" ];
Expand Down Expand Up @@ -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]/;
}
}
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;

Expand Down Expand Up @@ -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;
}
Expand Down Expand Up @@ -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;
}
Expand Down
53 changes: 26 additions & 27 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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:
Expand All @@ -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.


Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.

5 changes: 3 additions & 2 deletions README.help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -260,7 +260,8 @@ Verbrugghen [email protected])
-------------------------------------------------------------------------------
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)
Expand Down
2 changes: 1 addition & 1 deletion README.hpux.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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<README.hpux> describes the combined knowledge of a number of
This F<README.hpux.txt> 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
Expand Down
2 changes: 1 addition & 1 deletion README.java.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.vms.txt
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>
Expand Down
2 changes: 1 addition & 1 deletion README.win32.txt
Original file line number Diff line number Diff line change
@@ -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 ---

Expand Down
4 changes: 2 additions & 2 deletions t/01base.t
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion test.pl
Original file line number Diff line number Diff line change
Expand Up @@ -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(); }
Expand Down

0 comments on commit fb388ce

Please sign in to comment.