Bug 121938

Summary: reference to vinum() is wrong in newfs(8) man page.
Product: Documentation Reporter: Federico GDB <federicogalvezdurand>
Component: Books & ArticlesAssignee: Remko Lodder <remko>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Federico GDB 2008-03-21 14:30:01 UTC
newfs(8) man page refers to vinum(8).
It should be vinum(4).

Fix: Patch attached with submission follows:
How-To-Repeat: man 8 newfs
Comment 1 dfilter service freebsd_committer freebsd_triage 2008-03-21 20:16:30 UTC
remko       2008-03-21 20:16:25 UTC

  FreeBSD src repository

  Modified files:
    sbin/newfs           newfs.8 
  Log:
  Replace reference from vinum.8 to gvinum.8, it was advised in the PR to
  replace this with vinum.4, but that's the kernel interface manual, which
  is not appropriate in my understanding.  I think that gvinum is a suitable
  replacement for this.
  
  PR:             docs/121938
  Submitted by:   "Federico" <federicogalvezdurand at yahoo dot com>
  MFC after:      3 days
  
  Revision  Changes    Path
  1.73      +2 -2      src/sbin/newfs/newfs.8
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 2 Remko Lodder freebsd_committer freebsd_triage 2008-03-21 20:17:12 UTC
State Changed
From-To: open->patched

set to patched, did so in current. 


Comment 3 Remko Lodder freebsd_committer freebsd_triage 2008-03-21 20:17:12 UTC
Responsible Changed
From-To: freebsd-doc->remko

reassign to me
Comment 4 dfilter service freebsd_committer freebsd_triage 2008-03-24 10:45:25 UTC
remko       2008-03-24 10:45:17 UTC

  FreeBSD src repository

  Modified files:        (Branch: RELENG_6)
    sbin/newfs           newfs.8 
  Log:
  MFC rev 1.73 newfs.8
  
    Replace reference from vinum.8 to gvinum.8, it was advised in the PR to
    replace this with vinum.4, but that's the kernel interface manual, which
    is not appropriate in my understanding.  I think that gvinum is a suitable
    replacement for this.
  
    PR:             docs/121938
    Submitted by:   "Federico" <federicogalvezdurand at yahoo dot com>
    MFC after:      3 days
  
  Revision  Changes    Path
  1.69.2.1  +2 -2      src/sbin/newfs/newfs.8
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 5 dfilter service freebsd_committer freebsd_triage 2008-03-24 10:46:04 UTC
remko       2008-03-24 10:46:00 UTC

  FreeBSD src repository

  Modified files:        (Branch: RELENG_7)
    sbin/newfs           newfs.8 
  Log:
  MFC rev 1.73 newfs.8
  
    Replace reference from vinum.8 to gvinum.8, it was advised in the PR to
    replace this with vinum.4, but that's the kernel interface manual, which
    is not appropriate in my understanding.  I think that gvinum is a suitable
    replacement for this.
  
    PR:             docs/121938
    Submitted by:   "Federico" <federicogalvezdurand at yahoo dot com>
    MFC after:      3 days
  
  Revision  Changes    Path
  1.70.2.1  +2 -2      src/sbin/newfs/newfs.8
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 6 Remko Lodder freebsd_committer freebsd_triage 2008-03-24 10:46:51 UTC
State Changed
From-To: patched->closed

Committed. Thanks!
Comment 7 Federico GDB 2008-03-24 12:12:27 UTC
--- remko@FreeBSD.org wrote:

> Synopsis: reference to vinum() is wrong in newfs(8)
> man page.
> 
> State-Changed-From-To: patched->closed
> State-Changed-By: remko
> State-Changed-When: Mon Mar 24 10:46:51 UTC 2008
> State-Changed-Why: 
> Committed. Thanks!
> 
> http://www.freebsd.org/cgi/query-pr.cgi?pr=121938
> 

In newfs(8) the main (and maybe only) reason to call a
reference on vinum(4) was the deprecated usage of
"newfs -v " (Releases < 5.x) to create a UFS file
system on a vinum volume.

That reference is still there in vinum(4) with
insufficient wording, it should say it is valid only
for Releases < 5.x. 

Section 20.7.1 is also confusing on this matter
invoking the same usage of newfs to show the wrong and
right way of creating a file system on a vinum(4)
volume.

Using gvinum(8) does not help to understand how to use
newfs(8) to create a new UFS file system on a vinum(4)
volume. Therefore, I do not see the point on calling a
reference to gvinum(8) in newfs(8). At least not with
this version of gvinum(8).

If the reference to vinum(4) in newfs(8) is not
desirable then it should be glabel(8), which advises
the right way of using newfs(8) to create a file
system on a vinum volume.

If you agree on: 
a) removing vinum(x) from newfs(8) references;
b) adding glabel(8) to newfs(8) references; 
then I can submit a patch for newfs(8), vinum(4) and
Section 20.7.1 with the right text, for your
approval/rejection.

Please, advise.




      ____________________________________________________________________________________
Looking for last minute shopping deals?  
Find them fast with Yahoo! Search.  http://tools.search.yahoo.com/newsearch/category.php?category=shopping
Comment 8 Federico GDB 2008-03-24 14:16:20 UTC
--- remko@FreeBSD.org wrote:

> Synopsis: reference to vinum() is wrong in newfs(8)
> man page.
> 
> State-Changed-From-To: patched->closed
> State-Changed-By: remko
> State-Changed-When: Mon Mar 24 10:46:51 UTC 2008
> State-Changed-Why: 
> Committed. Thanks!
> 
> http://www.freebsd.org/cgi/query-pr.cgi?pr=121938
> 

Sorry, replying to myself.
I take it back, glabel(8) has nothing to do with
labeling a vinum(4) volume... I need more sleep.

*The Handbook Section 20.7.1 needs clean up. It is not
clear which usages of newfs(8) there is the correct.
*The suggested gvinum(8) replacement for vinum(4) in
newfs(8) does not really contribute to newfs(8).
*The vinum(4) needs a modification in sub-section
MAKING FILE SYSTEMS.

.



      ____________________________________________________________________________________
Never miss a thing.  Make Yahoo your home page. 
http://www.yahoo.com/r/hs