Bug 140457

Summary: [patch] Grammar fix for isspace(3)
Product: Documentation Reporter: Jeremy Huddleston <jeremyhu>
Component: Books & ArticlesAssignee: Warren Block <wblock>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Jeremy Huddleston 2009-11-10 21:50:02 UTC
Grammar fix for src/lib/libc/locale/isspace.3
Comment 1 Bruce Evans freebsd_committer freebsd_triage 2009-11-11 12:08:28 UTC
On Tue, 10 Nov 2009, Jeremy Huddleston wrote:

>> Fix:
> --- isspace.3.bsdnew	2009-11-10 13:13:10.000000000 -0800
> +++ isspace.3	2009-11-10 13:45:41.000000000 -0800
> @@ -54,9 +54,9 @@ For any locale, this includes the follow
> .It "\&``\et''\t``\en''\t``\ev''\t``\ef''\t``\er''\t`` ''"
> .El
> .Pp
> -In the "C" locale
> +In the "C" locale,

This and the other commas you want to add are improvements, but is this
because they are required by grammar or style?

> .Fn isspace
> -successful test is limited to this characters only.
> +successful test is limited to these characters only.
> The value of the argument must be representable as an
> .Vt "unsigned char"
> or the value of

isspace.3 has several more grammar errors.  In FreeBSD changes, I noticed:

% Index: isspace.3
% ===================================================================
% RCS file: /home/ncvs/src/lib/libc/locale/isspace.3,v
% retrieving revision 1.1
% retrieving revision 1.22
% diff -u -2 -r1.1 -r1.22
% --- isspace.3	27 May 1994 04:56:44 -0000	1.1
% +++ isspace.3	4 Sep 2009 07:44:58 -0000	1.22
% ...
%  .Sh DESCRIPTION
%  The
%  .Fn isspace
% -function tests for the standard white-space characters.
% -In the ASCII character set, this includes the following characters:
% -.sp
% -.Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
% -.It \&011\ ht \t012\ nl \t013\ vt \t014\ np \t015\ cr
% -.It \&040\ sp
% +function tests for the white-space characters.

This got mangled by removing "standard" without removing "the".  The
latter applies to "standard", not the the white-space characters, and
not removing it defeats the point of removing "standard" (by suggesting
that there is a single set of white-space characters, instead of a
standard set and nonstandard extensions).

% +For any locale, this includes the following standard characters:
% +.Pp
% +.Bl -column \&`\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___
% +.It "\&``\et''\t``\en''\t``\ev''\t``\ef''\t``\er''\t`` ''"
%  .El
% +.Pp
% +In the "C" locale
% +.Fn isspace
% +successful test is limited to this characters only.

"isspace successful test" still has a couple of grammar errors.

The C standard has much better wording for this, of course.  POSIX.1
(which FreeBSD has permission to copy) unfortunately doesn't copy the
C standard, and it has grammatically correct but otherwise poor wording
(at least in a draft 2001 version) (it refers to the C standard and a
generic section), so copying it wouldn't be useful.

The C standard says "standard white space" like the above used to, but
doesn't say "the standard", and it handles the bug fixed in the above
better by saying "standard ... or ... locale-specific...".  Then it
lists the standard white-space characters (hopefully the same set as
above).  Then it has very good wording instead of "successful test is
limited to this [sic] characters".

isblank.3 has the same bugs.

Bruce
Comment 2 Mark Linimon freebsd_committer freebsd_triage 2009-11-11 17:24:41 UTC
Responsible Changed
From-To: freebsd-bugs->freebsd-doc

Over to maintainer(s).
Comment 3 dfilter service freebsd_committer freebsd_triage 2011-09-27 18:54:19 UTC
Author: schweikh
Date: Tue Sep 27 17:54:10 2011
New Revision: 225808
URL: http://svn.freebsd.org/changeset/base/225808

Log:
  Fix grammar.
  
  PR:		140457
  Submitted by:	jeremyhu AT apple.com
  MFC after:	2 weeks

Modified:
  head/lib/libc/locale/isspace.3

Modified: head/lib/libc/locale/isspace.3
==============================================================================
--- head/lib/libc/locale/isspace.3	Tue Sep 27 17:41:48 2011	(r225807)
+++ head/lib/libc/locale/isspace.3	Tue Sep 27 17:54:10 2011	(r225808)
@@ -47,16 +47,16 @@
 .Sh DESCRIPTION
 The
 .Fn isspace
-function tests for the white-space characters.
+function tests for white-space characters.
 For any locale, this includes the following standard characters:
 .Pp
 .Bl -column \&`\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___
 .It "\&``\et''\t``\en''\t``\ev''\t``\ef''\t``\er''\t`` ''"
 .El
 .Pp
-In the "C" locale
+In the "C" locale,
 .Fn isspace
-successful test is limited to this characters only.
+returns non-zero for these characters only.
 The value of the argument must be representable as an
 .Vt "unsigned char"
 or the value of
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 4 Jens Schweikhardt freebsd_committer freebsd_triage 2011-09-27 18:54:41 UTC
State Changed
From-To: open->patched

Patched in HEAD. Await MFC.
Comment 5 dfilter service freebsd_committer freebsd_triage 2012-06-26 00:39:54 UTC
Author: wblock (doc committer)
Date: Mon Jun 25 23:39:35 2012
New Revision: 237584
URL: http://svn.freebsd.org/changeset/base/237584

Log:
  MFC r225808:
  
  Fix grammar.
  
  PR:		140457
  Submitted by:	jeremyhu AT apple.com
  Approved by:	gjb (mentor)

Modified:
  stable/9/lib/libc/locale/isspace.3
Directory Properties:
  stable/9/lib/libc/   (props changed)

Modified: stable/9/lib/libc/locale/isspace.3
==============================================================================
--- stable/9/lib/libc/locale/isspace.3	Mon Jun 25 23:22:43 2012	(r237583)
+++ stable/9/lib/libc/locale/isspace.3	Mon Jun 25 23:39:35 2012	(r237584)
@@ -47,16 +47,16 @@
 .Sh DESCRIPTION
 The
 .Fn isspace
-function tests for the white-space characters.
+function tests for white-space characters.
 For any locale, this includes the following standard characters:
 .Pp
 .Bl -column \&`\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___
 .It "\&``\et''\t``\en''\t``\ev''\t``\ef''\t``\er''\t`` ''"
 .El
 .Pp
-In the "C" locale
+In the "C" locale,
 .Fn isspace
-successful test is limited to this characters only.
+returns non-zero for these characters only.
 The value of the argument must be representable as an
 .Vt "unsigned char"
 or the value of
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 6 dfilter service freebsd_committer freebsd_triage 2012-06-26 00:40:33 UTC
Author: wblock (doc committer)
Date: Mon Jun 25 23:40:19 2012
New Revision: 237585
URL: http://svn.freebsd.org/changeset/base/237585

Log:
  MFC r225808:
  
  Fix grammar.
  
  PR:		140457
  Submitted by:	jeremyhu AT apple.com
  Approved by:	gjb (mentor)

Modified:
  stable/8/lib/libc/locale/isspace.3
Directory Properties:
  stable/8/lib/libc/   (props changed)

Modified: stable/8/lib/libc/locale/isspace.3
==============================================================================
--- stable/8/lib/libc/locale/isspace.3	Mon Jun 25 23:39:35 2012	(r237584)
+++ stable/8/lib/libc/locale/isspace.3	Mon Jun 25 23:40:19 2012	(r237585)
@@ -47,16 +47,16 @@
 .Sh DESCRIPTION
 The
 .Fn isspace
-function tests for the white-space characters.
+function tests for white-space characters.
 For any locale, this includes the following standard characters:
 .Pp
 .Bl -column \&`\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___
 .It "\&``\et''\t``\en''\t``\ev''\t``\ef''\t``\er''\t`` ''"
 .El
 .Pp
-In the "C" locale
+In the "C" locale,
 .Fn isspace
-successful test is limited to this characters only.
+returns non-zero for these characters only.
 The value of the argument must be representable as an
 .Vt "unsigned char"
 or the value of
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 7 dfilter service freebsd_committer freebsd_triage 2012-06-26 00:41:06 UTC
Author: wblock (doc committer)
Date: Mon Jun 25 23:40:58 2012
New Revision: 237586
URL: http://svn.freebsd.org/changeset/base/237586

Log:
  MFC r225808:
  
  Fix grammar.
  
  PR:		140457
  Submitted by:	jeremyhu AT apple.com
  Approved by:	gjb (mentor)

Modified:
  stable/7/lib/libc/locale/isspace.3
Directory Properties:
  stable/7/lib/libc/   (props changed)

Modified: stable/7/lib/libc/locale/isspace.3
==============================================================================
--- stable/7/lib/libc/locale/isspace.3	Mon Jun 25 23:40:19 2012	(r237585)
+++ stable/7/lib/libc/locale/isspace.3	Mon Jun 25 23:40:58 2012	(r237586)
@@ -47,16 +47,16 @@
 .Sh DESCRIPTION
 The
 .Fn isspace
-function tests for the white-space characters.
+function tests for white-space characters.
 For any locale, this includes the following standard characters:
 .Pp
 .Bl -column \&`\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___ \&``\et''___
 .It "\&``\et''\t``\en''\t``\ev''\t``\ef''\t``\er''\t`` ''"
 .El
 .Pp
-In the "C" locale
+In the "C" locale,
 .Fn isspace
-successful test is limited to this characters only.
+returns non-zero for these characters only.
 The value of the argument must be representable as an
 .Vt "unsigned char"
 or the value of
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 8 Warren Block freebsd_committer freebsd_triage 2012-07-22 23:52:53 UTC
Responsible Changed
From-To: freebsd-doc->wblock

Take.
Comment 9 Warren Block freebsd_committer freebsd_triage 2012-07-22 23:53:25 UTC
State Changed
From-To: patched->closed

Patch committed to head and MFCed to 9, 8, and 7.  Thanks!