Documentation patch: Tie::Hash, Tie::Scalar, Tie::SubstrHash
authorRandy J Ray <rjray@uswest.com>
Tue, 6 Feb 1996 17:04:47 +0000 (10:04 -0700)
committerAndy Dougherty <doughera@lafcol.lafayette.edu>
Tue, 6 Feb 1996 17:04:47 +0000 (10:04 -0700)
commit64d0c9732b520ac8f3a9448f7c3f9f5b4209bd6d
treeb9565a30f3b8e16afcf8ff1fc652b1b674a0d6c1
parent6c31b3367b143518785862fbdca365a32245ff3d
Documentation patch: Tie::Hash, Tie::Scalar, Tie::SubstrHash

[This finishes a job started by Randy Ray with perl5.002b1f.]

This patch updates the files lib/TieHash.pm and lib/SubstrHash.pm. Those
two files are moved to a new directory called lib/Tie. A new tie-related
class for scalars, lib/Tie/Scalar.pm, is added. Each of these has pod
documentation that passes through pod2man without complaint. All package
names are updated to reflect this structure, and the "standard" sub-classes
for hashes and scalars are named Tie::StdHash and Tie::StdScalar, in
keeping with the group consensus.

With this, the documentation for Tie::Hash should be fine, Tie::Scalar
exists and is documented, and Tie::SubstrHash (formerly just SubstrHash)
is also documented, albeit weakly. I have no examples of usage to show, and
I suspect a possible bug or two, but without examples it's hard to say.

As it happens, this patch also impacts the DBM-style extensions, as they
(DB_File, NDBM_File, GBM_File, ODBM_File, SDBM_File) all inherited from
the old TieHash.pm as a base class.
lib/Tie/Hash.pm
lib/Tie/Scalar.pm [new file with mode: 0644]
lib/Tie/SubstrHash.pm