summaryrefslogtreecommitdiff
path: root/lib/English.pm
diff options
context:
space:
mode:
authorJohn Tobey <jtobey@john-edwin-tobey.org>1998-11-19 09:14:15 -0500
committerGurusamy Sarathy <gsar@cpan.org>1998-11-28 18:08:50 +0000
commit19ddd453f2e40b974c6259d7b47fde33e9f744b5 (patch)
tree3713c7b43705a8b722b441ba9cc52017e432ae29 /lib/English.pm
parentdf4a00a5f8fe391f745418d99ee82968fe9faa58 (diff)
downloadperl-19ddd453f2e40b974c6259d7b47fde33e9f744b5.tar.gz
PATCH: document English.pm sawampersand and thread issues
Message-Id: <m0zgZWx-000FOgC@feynman.localnet> p4raw-id: //depot/perl@2362
Diffstat (limited to 'lib/English.pm')
-rw-r--r--lib/English.pm8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/English.pm b/lib/English.pm
index bbb6bd7b28..7aa0d84617 100644
--- a/lib/English.pm
+++ b/lib/English.pm
@@ -15,6 +15,14 @@ English - use nice English (or awk) names for ugly punctuation variables
=head1 DESCRIPTION
+You should I<not> use this module in programs intended to be portable
+among Perl versions, programs that must perform regular expression
+matching operations efficiently, or libraries intended for use with
+such programs. In a sense, this module is deprecated. The reasons
+for this have to do with implementation details of the Perl
+interpreter which are too thorny to go into here. Perhaps someday
+they will be fixed to make "C<use English>" more practical.
+
This module provides aliases for the built-in variables whose
names no one seems to like to read. Variables with side-effects
which get triggered just by accessing them (like $0) will still