Bug 77024

Summary: typo/bad grammar in indent(1) manpage
Product: Documentation Reporter: adrian <adrian>
Component: Books & ArticlesAssignee: Giorgos Keramidas <keramida>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
indent.1.diff.gz none

Description adrian 2005-02-02 17:50:12 UTC 
	The bug ssection of the indent(1) manpage has a typo that is
	grammatically incorrect.  I also reworded the section slightly
	to make it read more clearly.

Fix: Apply this patch:
How-To-Repeat: 	Read the bug section of the manpage.
Comment 1 Giorgos Keramidas freebsd_committer freebsd_triage 2005-02-03 11:12:09 UTC 
% --- indent.1.orig	Thu Feb  3 00:35:20 2005
% +++ indent.1	Thu Feb  3 00:36:37 2005
% @@ -534,7 +534,7 @@
%  .Pp
%  .Dl indent *.c
%  .Pp
% -to the shell in an attempt to indent all the
% +To the shell this is an attempt to indent all the
%  .Em C
%  programs in a directory.
% -This is probably a bug, not a feature.
% +It is probably a bug, not a feature.

This shows too little context from the original manpage.  Reading both the
preceding paragraph and the one that follows the displayed material we see:

%    A common mistake that often causes grief is typing:
%
%          indent *.c
%
%    to the shell in an attempt to indent all the C programs in a
%    directory.  This is probably a bug, not a feature.

If you read both these paragraphs as one sentence, it probably
makes more sense.  I agree it looks a bit confusing though.

We can probably rewrite this part as:

%   A common mistake is to try to indent all the C programs in a
%   directory by typing:
%
%         indent *.c
%
%   This is probably a bug, not a feature.
Comment 2 adrian 2005-02-03 17:17:04 UTC 
 	Sounds good to me.  Better than the original.

 	Adrian
-- 
[ adrian@ubergeeks.com ]

On Thu, 3 Feb 2005, Giorgos Keramidas wrote:

> % --- indent.1.orig	Thu Feb  3 00:35:20 2005
> % +++ indent.1	Thu Feb  3 00:36:37 2005
> % @@ -534,7 +534,7 @@
> %  .Pp
> %  .Dl indent *.c
> %  .Pp
> % -to the shell in an attempt to indent all the
> % +To the shell this is an attempt to indent all the
> %  .Em C
> %  programs in a directory.
> % -This is probably a bug, not a feature.
> % +It is probably a bug, not a feature.
>
> This shows too little context from the original manpage.  Reading both the
> preceding paragraph and the one that follows the displayed material we see:
>
> %    A common mistake that often causes grief is typing:
> %
> %          indent *.c
> %
> %    to the shell in an attempt to indent all the C programs in a
> %    directory.  This is probably a bug, not a feature.
>
> If you read both these paragraphs as one sentence, it probably
> makes more sense.  I agree it looks a bit confusing though.
>
> We can probably rewrite this part as:
>
> %   A common mistake is to try to indent all the C programs in a
> %   directory by typing:
> %
> %         indent *.c
> %
> %   This is probably a bug, not a feature.
>
Comment 3 Giorgos Keramidas freebsd_committer freebsd_triage 2005-02-03 21:17:42 UTC 
State Changed
From-To: open->patched

Committed to HEAD.
Comment 4 Giorgos Keramidas freebsd_committer freebsd_triage 2005-02-03 21:17:42 UTC 
Responsible Changed
From-To: freebsd-doc->keramida

I'll MFC this in a while.  Most likely in a week or so.
Comment 5 Giorgos Keramidas freebsd_committer freebsd_triage 2005-02-22 13:09:32 UTC 
State Changed
From-To: patched->closed

The fix of this PR and several other more recent updates to the 
manpage have been merged to RELENG_5.  Thanks for sending this 
problem report and helping us improve the manpage :-)