Bug 251181 - [iscsi][doc] ctladm.8 misleading examples
Summary: [iscsi][doc] ctladm.8 misleading examples
Status: In Progress
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Edward Tomasz Napierala
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2020-11-16 09:23 UTC by Ruslan Makhmatkhanov
Modified: 2020-11-23 14:39 UTC (History)
3 users (show)

See Also:


Attachments
screenshot of a problem (29.79 KB, image/png)
2020-11-16 09:23 UTC, Ruslan Makhmatkhanov
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Ruslan Makhmatkhanov freebsd_committer 2020-11-16 09:23:11 UTC
Created attachment 219725 [details]
screenshot of a problem

May be I'm missing something, but it looks like something else supposed to be used as a backing store pathname in examples (see screenshot attached)


Here is what in ctladm.8 man-page (/usr/src/usr.sbin/ctladm/ctladm.8):

Create a LUN using the block backend, and specify the file
.Pa src/usr.sbin/ctladm/ctladm.8
as the backing store.
The size of the LUN will be derived from the size of the file.
.Pp
.Dl ctladm create -b block -o file=src/usr.sbin/ctladm/ctladm.8
.Pp
Create a LUN using the block backend, specify the file
.Pa src/usr.sbin/ctladm/ctladm.8
as the backing store, and specify the
.Tn SCSI
VPD page 0x80 and 0x83 serial number
.Fl ( S )
and device ID
.Fl ( d ) .
.Pp
.Dl ctladm create -b block -o file=src/usr.sbin/ctladm/ctladm.8 -S MYSERIAL321 -d MYDEVID123
.Pp


PS. For some reason bugzilla fails to generate Preview when clicking Preview tab here.
Comment 1 Edward Tomasz Napierala freebsd_committer 2020-11-17 11:53:47 UTC
https://reviews.freebsd.org/D27249
Comment 2 commit-hook freebsd_committer 2020-11-23 14:31:31 UTC
A commit references this bug:

Author: trasz
Date: Mon Nov 23 14:30:28 UTC 2020
New revision: 367956
URL: https://svnweb.freebsd.org/changeset/base/367956

Log:
  Replace paths in ctladm(8) examples with something sensible.

  PR:		251181
  Reviewed by:	0mp, rm, ygy
  MFC after:	2 weeks
  Sponsored by:	EPSRC
  Differential Revision:	https://reviews.freebsd.org/D27249

Changes:
  head/usr.sbin/ctladm/ctladm.8