Skip to content

Commit

Permalink
perlapi: Combine sv_eq(), sv_eq_flags() entries
Browse files Browse the repository at this point in the history
  • Loading branch information
khwilliamson committed May 12, 2023
1 parent 788391b commit 9a25725
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions sv.c
Expand Up @@ -7989,23 +7989,19 @@ S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
}

/*
=for apidoc sv_eq
=for apidoc sv_eq
=for apidoc_item sv_eq_flags

Returns a boolean indicating whether the strings in the two SVs are
identical. Is UTF-8 and S<C<'use bytes'>> aware, handles get magic, and will
coerce its args to strings if necessary.

This function does not handle operator overloading. For a version that does,
see instead C<sv_streq>.
These each eturn a boolean indicating whether the strings in the two SVs are
identical. They are UTF-8 and S<C<'use bytes'>> aware, and each will coerce
its args to strings if necessary.

=for apidoc sv_eq_flags

Returns a boolean indicating whether the strings in the two SVs are
identical. Is UTF-8 and S<C<'use bytes'>> aware and coerces its args to strings
if necessary. If the flags has the C<SV_GMAGIC> bit set, it handles get-magic, too.
They differ only in that C<sv_eq> always handles get magic, while
C<sv_eq_flags> handles get magic only when the C<flags> parameter has the
C<SV_GMAGIC> bit set.

This function does not handle operator overloading. For a version that does,
see instead C<sv_streq_flags>.
These functions do not handle operator overloading. For versions that do,
see instead C<sv_streq> or C<sv_streq_flags>.

=cut
*/
Expand Down

0 comments on commit 9a25725

Please sign in to comment.