From dea15a73fe5f9b68f52e1c7a8bdad83219b6e7e3 Mon Sep 17 00:00:00 2001 From: jimharris Date: Wed, 7 May 2014 17:17:16 +0000 Subject: [PATCH] MFC r263303: Update nvme(4) and nvd(4) man pages to clarify the differences between their respective device nodes. git-svn-id: svn://svn.freebsd.org/base/stable/10@265575 ccf9f872-aa2e-dd11-9fc8-001c23d0bc1f --- share/man/man4/nvd.4 | 18 ++++++++++++++++-- share/man/man4/nvme.4 | 13 ++++++++----- 2 files changed, 24 insertions(+), 7 deletions(-) diff --git a/share/man/man4/nvd.4 b/share/man/man4/nvd.4 index 450940549..15200a442 100644 --- a/share/man/man4/nvd.4 +++ b/share/man/man4/nvd.4 @@ -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 @@ -33,7 +33,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 9, 2013 +.Dd March 18, 2014 .Dt NVD 4 .Os .Sh NAME @@ -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 diff --git a/share/man/man4/nvme.4 b/share/man/man4/nvme.4 index cdea78887..8a22d6833 100644 --- a/share/man/man4/nvme.4 +++ b/share/man/man4/nvme.4 @@ -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 @@ -33,7 +33,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 9, 2013 +.Dd March 18, 2014 .Dt NVME 4 .Os .Sh NAME @@ -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 @@ -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, -- 2.45.0