From: Tokunori Ikegami <ikegami.t@gmail.com>
Date: Thu, 7 Jul 2022 14:30:54 +0000 (+0900)
Subject: docs: Add nvme command RETURNS section for #1560 requirement
X-Git-Tag: v2.1-rc0~11^2
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=2e094245fa0e1abdcf0fc99bae78391c20df3941;p=users%2Fsagi%2Fnvme-cli.git

docs: Add nvme command RETURNS section for #1560 requirement

Required information on how an invoking process might determine success or
failure.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
---

diff --git a/Documentation/nvme.txt b/Documentation/nvme.txt
index 26fcb95e..87de7b83 100644
--- a/Documentation/nvme.txt
+++ b/Documentation/nvme.txt
@@ -45,6 +45,11 @@ Plugins/Vendor extension commands
 
 include::cmd-plugins.txt[]
 
+RETURNS
+-------
+All commands will behave the same, they will return 0 on success and 1 on
+failure.
+
 FURTHER DOCUMENTATION
 ---------------------
 See the freely available references on the http://nvmexpress.org[Official