Skip to contentSkip to conversation

nvme-cli: Plea for help to document fabrics commands

DISCUSSION J Freyensee 2 participants 2 messages Sep 22, 2016 – Sep 23, 2016 NVMe

lore
Share & tools
lore
#0 lore raw

With NVMe-over-Fabrics being merged into the existing NVMe code base, contributions were also made to nvme-cli to enable fabrics features in the tool. However, documentation (specifically man pages) are lacking for fabrics features in nvme-cli, which doesn't bode well as the tool has maintained very good documentation for all the other commands/features that already exist for NVMe.

I would like to propose a divide-and-conquer strategy to get new man pages added for the fabrics features to get it up to par with the rest of the tool.

I'll volunteer to take on "discover".

I believe that leaves "connect-all", "connect", and "disconnect" still to be documented (unless I missed something...Christoph or Ming) for other people to conquer?

Thanks,
Jay

#1 lore raw

This has been on my TODO list for a while..

I'll wait for you to finish discover and will do the rest after that as I think we can reuse a lot of the discover documentaiton for connect and connect-all.