Bug 36461

Summary: dd(1) manual has fatal spaces after "conv="
Product: Documentation Reporter: Gary W. Swearingen <swear>
Component: Books & ArticlesAssignee: Giorgos Keramidas <keramida>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Gary W. Swearingen 2002-03-29 04:50:01 UTC
The dd(1) manual has extra spaces after the "conv=" operand syntax
line, which, if used in a command, is fatal.
================

Fix: 

Change "conv= value[, value ...]" to "conv=value[,value,...]".

Maybe add to description "spaces are not allowed".
How-To-Repeat: 
dd if=/dev/zero of=/dev/null conv= lcase
dd if=/dev/zero of=/dev/null conv=lcase, sparse
================
Comment 1 Tom Rhodes freebsd_committer freebsd_triage 2002-03-29 07:27:41 UTC
Gary, this may be ``illegal'' mdoc, but could you tell me what you think
about the following changes?  I have removed the old values and changed
added new ones according to the pr report.  Little doubt is in my mind
that you or ru, or Giorgos will say ``Hey Tom, there IS a backspace
macro or something...  Oh well, the output looked ok when I did an
nroff -man dd.1 on my machine...

--
Tom Rhodes


--- dd.1.old	Fri Mar 29 02:11:03 2002
+++ dd.1	Fri Mar 29 02:22:47 2002
@@ -151,8 +151,7 @@
 For all other devices, the correct number of blocks is read without
 distinguishing between a partial or complete block being read.
 .It Xo
-.Cm conv=
-.Ns Cm value Ns Op \&, Cm value \&...
+.Cm conv=value[,value,...]
 .Xc
 Where
 .Cm value
Comment 2 Giorgos Keramidas freebsd_committer freebsd_triage 2002-03-30 02:00:16 UTC
On 2002-03-29 17:49, Gary W. Swearingen wrote:

> (If I was going to bother ru at all, I'd just flat out ask him how to
> implement that one line so he doesn't have to wade through the trivial
> stuff.  But that's your business, of course.)

If you (Gary or Tom, that is) prefer the arguments to in "italics",
you will probably like the following:

%%%
Index: dd.1
===================================================================
RCS file: /home/ncvs/src/bin/dd/dd.1,v
retrieving revision 1.18
diff -2 -u -r1.18 dd.1
--- dd.1	15 Aug 2001 09:09:34 -0000	1.18
+++ dd.1	29 Mar 2002 15:07:18 -0000
@@ -152,6 +152,5 @@
 distinguishing between a partial or complete block being read.
 .It Xo
-.Cm conv=
-.Ns Cm value Ns Op \&, Cm value \&...
+.Cm conv= Ns Cm value Ns Op \&, Ns Cm value Ns \&, Ns \&...
 .Xc
 Where
%%%
Comment 3 Gary W. Swearingen 2002-03-30 03:39:44 UTC
Giorgos Keramidas <keramida@freebsd.org> writes:
> 
> If you (Gary or Tom, that is) prefer the arguments to in "italics",
> you will probably like the following:
...
> +.Cm conv= Ns Cm value Ns Op \&, Ns Cm value Ns \&, Ns \&...

Well, the "before" version uses "Cm", but the other operands seem to use
"Ar", so this seems better:

.Cm conv= Ns Ar value Ns Op \&, Ns Ar value Ns \&, Ns \&...
.Xc
Where
.Ar value
Comment 4 darklogik 2002-03-30 20:09:08 UTC
On 29 Mar 2002 19:39:44 -0800
swear@blarg.net (Gary W. Swearingen) wrote:

> Giorgos Keramidas <keramida@freebsd.org> writes:
> > 
> > If you (Gary or Tom, that is) prefer the arguments to in
> > "italics", you will probably like the following:

Italics isn't really a huge deal in my opinion, the only REAL worry
I had was markup.  Limited knowledge of mdoc(7) tells me to either
have a more experianced person review my work before application into
the system.  This is your call Gary, if you want it in italics just
say so and Keramida can commit his patch.

-- 
Tom (Darklogik) Rhodes
www.FreeBSD.org  -The Power To Serve
www.Pittgoth.com -Pittgoth Discussion Portal
trhodes@ {Pittgoth.com, FreeBSD.org}
Comment 5 Gary W. Swearingen 2002-03-31 04:09:44 UTC
Tom Rhodes <darklogik@pittgoth.com> writes:

> Italics isn't really a huge deal in my opinion, the only REAL worry
> I had was markup.  Limited knowledge of mdoc(7) tells me to either
> have a more experianced person review my work before application into
> the system.  This is your call Gary, if you want it in italics just
> say so and Keramida can commit his patch.

I didn't know why italics was mentioned -- I never see it in manuals.
But I just now read that ".Em" usually gives italics while I see
underlined text from both ".Em" and ".Ar" (but bold text from ".Cm").

I notice that the nslookup(8) manual uses Ar right of "=", but then it
is describing interactive commands (.It Ic port= Ns Ar value).

My call is Giorgos' last effort except with "Ar" on the right side of
the "=" like the rest of the operands have, plus "Ar" on the
corresponding reference to "value" in the description.  But I'll not
complain if the committer wants it otherwise (as long as it has no
spaces, of course).
Comment 6 darklogik 2002-03-31 21:49:54 UTC
On 30 Mar 2002 19:09:44 -0800
swear@blarg.net (Gary W. Swearingen) wrote:

> Tom Rhodes <darklogik@pittgoth.com> writes:
> 
> > Italics isn't really a huge deal in my opinion, the only REAL
> > worry I had was markup.  Limited knowledge of mdoc(7) tells me to
> > either have a more experianced person review my work before
> > application into the system.  This is your call Gary, if you want
> > it in italics just say so and Keramida can commit his patch.
> 
> I didn't know why italics was mentioned -- I never see it in
> manuals. But I just now read that ".Em" usually gives italics while
> I see underlined text from both ".Em" and ".Ar" (but bold text from
> ".Cm").
> 
> I notice that the nslookup(8) manual uses Ar right of "=", but then
> it is describing interactive commands (.It Ic port= Ns Ar value).
> 
> My call is Giorgos' last effort except with "Ar" on the right side
> of the "=" like the rest of the operands have, plus "Ar" on the
> corresponding reference to "value" in the description.  But I'll not
> complain if the committer wants it otherwise (as long as it has no
> spaces, of course).
> 

Yes, the final outcome must fix the original error ;)  I see that
Giorgos has already taken the care to cc Ruslan on the matter, and
we will go from there.  Although, I will continue to watch the
developments of this issue to be sure that a resolution appears. 
Thanks alot Gary.

-- 
Tom (Darklogik) Rhodes
www.FreeBSD.org  -The Power To Serve
www.Pittgoth.com -Pittgoth Discussion Portal
trhodes@ {Pittgoth.com, FreeBSD.org}
Comment 7 Giorgos Keramidas freebsd_committer freebsd_triage 2002-03-31 21:50:10 UTC
State Changed
From-To: open->closed

This and other changes have been committed to -CURRENT. 
MFC coming soon... 


Comment 8 Giorgos Keramidas freebsd_committer freebsd_triage 2002-03-31 21:50:10 UTC
Responsible Changed
From-To: freebsd-doc->keramida
Comment 9 Giorgos Keramidas freebsd_committer freebsd_triage 2002-03-31 21:51:57 UTC
State Changed
From-To: closed->patched

Hmmm, my bad.  Until the MFC this should remain in 'patched' state.
Comment 10 Giorgos Keramidas freebsd_committer freebsd_triage 2002-04-10 03:12:00 UTC
State Changed
From-To: patched->closed

Change has been MFC'ed.