From a8182288e5f07b7760e1e88632c9530818325b64 Mon Sep 17 00:00:00 2001 From: Varsha Rao Date: Thu, 4 Apr 2019 15:05:39 +0530 Subject: [PATCH] docs: Add note to execute cephfs-shell Signed-off-by: Varsha Rao --- doc/cephfs/cephfs-shell.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/cephfs/cephfs-shell.rst b/doc/cephfs/cephfs-shell.rst index 7e81bfffcfc6..be8f4e299dfd 100644 --- a/doc/cephfs/cephfs-shell.rst +++ b/doc/cephfs/cephfs-shell.rst @@ -14,6 +14,18 @@ Options : -b, --batch FILE Process a batch file. -t, --test FILE Test against transcript(s) in FILE + +.. note:: + + Latest version of the cmd2 module is required for running cephfs-shell. + If CephFS is installed through source, execute cephfs-shell in the build + directory. It can also be executed as following using virtualenv: + +.. code:: bash + + [build]$ virtualenv -p python3 venv && source venv/bin/activate && pip3 install cmd2 + [build]$ source vstart_environment.sh && source venv/bin/activate && python3 ../src/tools/cephfs/cephfs-shell + Commands ======== -- 2.47.3