Skip to content

Commit

Permalink
Update nvme(4) and nvd(4) man pages to clarify the differences between
Browse files Browse the repository at this point in the history
their respective device nodes.

Sponsored by:	Intel
MFC after:	3 days
  • Loading branch information
jimharris committed Mar 18, 2014
1 parent caea603 commit 6153138
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 7 deletions.
18 changes: 16 additions & 2 deletions share/man/man4/nvd.4
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\"
.\" Copyright (c) 2012-2013 Intel Corporation
.\" Copyright (c) 2012-2014 Intel Corporation
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -33,7 +33,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd July 9, 2013
.Dd March 18, 2014
.Dt NVD 4
.Os
.Sh NAME
Expand Down Expand Up @@ -62,8 +62,22 @@ It depends on the
.Xr nvme 4
driver for notification of existing NVMe namespaces and submission of NVM
I/O commands.
.Pp
Device nodes from the
.Nm
driver will have the format /dev/nvdX and are
.Xr GEOM 4
disks which can be partitioned by
.Xr geom 8 .
Note that device nodes from the
.Xr nvme 4
driver are not
.Xr GEOM 4
disks and cannot be partitioned.
.Sh SEE ALSO
.Xr GEOM 4 ,
.Xr nvme 4 ,
.Xr geom 8 ,
.Xr nvmecontrol 8 ,
.Xr disk 9
.Sh HISTORY
Expand Down
13 changes: 8 additions & 5 deletions share/man/man4/nvme.4
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\"
.\" Copyright (c) 2012-2013 Intel Corporation
.\" Copyright (c) 2012-2014 Intel Corporation
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -33,7 +33,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd July 9, 2013
.Dd March 18, 2014
.Dt NVME 4
.Os
.Sh NAME
Expand All @@ -54,7 +54,8 @@ nvme_load="YES"
.Pp
Most users will also want to enable
.Xr nvd 4
to surface NVM Express namespaces as disk devices.
to surface NVM Express namespaces as disk devices which can be
partitioned.
Note that in NVM Express terms, a namespace is roughly equivalent to a
SCSI LUN.
.Sh DESCRIPTION
Expand All @@ -73,11 +74,13 @@ API for registering NVMe namespace consumers such as
API for submitting NVM commands to namespaces
.It
Ioctls for controller and namespace configuration and management
.El
.Pp
The
.Nm
creates controller devices in the format
driver creates controller device nodes in the format
.Pa /dev/nvmeX
and namespace devices in
and namespace device nodes in
the format
.Pa /dev/nvmeXnsY .
Note that the NVM Express specification starts numbering namespaces at 1,
Expand Down

0 comments on commit 6153138

Please sign in to comment.