Bug 84850

Summary: [patch] strspn(3) manpage description is too esoteric
Product: Documentation Reporter: Gary W. Swearingen <garys>
Component: Books & ArticlesAssignee: Gary W. Swearingen <garys>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff
none
file.diff none

Description Gary W. Swearingen 2005-08-12 20:00:30 UTC 
The strspn(3) description does not help those who need a description.

The term "span" is too esoteric and even after I determined what the
function does, I'm still not sure whether it's meaningful to say that
the function "spans" something, when it just computes a number. Even
if I understand what the function returns, I'm left wondering whether
"spanning" is a side-effect of the function I should also understand.
(The source code shows that spanning is not a side effect, of course.)

Similarly for strcspn(3).

Fix: Leave the existing text alone for traditionalists, but add to the
DESCRIPTION.

Except also make it refer to both strings the same way.

AFAIK (not far), the new text is compatible with multi-byte
characters, but that should be considered by reviewers.

How-To-Repeat: n/a
Comment 1 Gary W. Swearingen freebsd_committer freebsd_triage 2005-08-29 00:45:37 UTC 
Responsible Changed
From-To: freebsd-doc->garys

Ready to get review and approval.
Comment 2 Gary W. Swearingen freebsd_committer freebsd_triage 2005-08-30 14:01:12 UTC 
State Changed
From-To: open->patched

Patched in HEAD.
Comment 3 Gary W. Swearingen freebsd_committer freebsd_triage 2005-09-07 18:51:17 UTC 
State Changed
From-To: patched->closed

Two files patched in HEAD, RELENG_6, RELENG_5.