clarify SvPV* and SvPV_force* docs
authorDavid Mitchell <davem@iabyn.com>
Thu, 9 May 2013 14:17:10 +0000 (15:17 +0100)
committerDavid Mitchell <davem@iabyn.com>
Thu, 9 May 2013 14:50:46 +0000 (15:50 +0100)
commitfd1423831cf9d78f9470d3a04e5c4e64f66173a6
tree595afe4694d17dab76d0eef6de3d3512b7c7a7ed
parent47c9d59fcd27684d94480b806b8b6e001aac91cc
clarify SvPV* and SvPV_force* docs

See RT #116407.

Make it clear that SvPV(sv) does not always equal SvPVX(sv), and to use
SvPV_force() if necessary. Also, clarify that SvPV_force() will destroy
any non-string content like a reference. Then, make the other SvPV*
descriptions in general refer back to SvPV() or SvPV_force(), so that
people will spot these added caveats.
sv.h