From 52faaf848e026b463185b7705ec1df2987153a1d Mon Sep 17 00:00:00 2001 From: Patrick Donnelly Date: Tue, 4 May 2021 14:30:39 -0700 Subject: [PATCH] Revert "Merge PR #41134 into master" This reverts commit 93bca2d0e9d771e3019af5e7228af7986c20ab61, reversing changes made to 7e70b15c437a2fbe207b515a98b8b21880980867. Signed-off-by: Patrick Donnelly --- ceph.spec.in | 1 - debian/cephfs-shell.install | 1 - doc/{man/8 => cephfs}/cephfs-shell.rst | 47 +++++++------------------- doc/cephfs/index.rst | 2 +- doc/man/8/CMakeLists.txt | 1 - doc/man_index.rst | 1 - 6 files changed, 13 insertions(+), 40 deletions(-) rename doc/{man/8 => cephfs}/cephfs-shell.rst (95%) diff --git a/ceph.spec.in b/ceph.spec.in index 39c3bade79f06..82295884696ac 100644 --- a/ceph.spec.in +++ b/ceph.spec.in @@ -2317,7 +2317,6 @@ fi %files -n cephfs-shell %{python3_sitelib}/cephfs_shell-*.egg-info %{_bindir}/cephfs-shell -%{_mandir}/man8/cephfs-shell.8* %endif %files -n cephfs-top diff --git a/debian/cephfs-shell.install b/debian/cephfs-shell.install index ee9e1399ff808..4713a81b11578 100644 --- a/debian/cephfs-shell.install +++ b/debian/cephfs-shell.install @@ -1,3 +1,2 @@ usr/bin/cephfs-shell usr/lib/python3*/dist-packages/cephfs_shell-*.egg-info -usr/share/man/man8/cephfs-shell.8 diff --git a/doc/man/8/cephfs-shell.rst b/doc/cephfs/cephfs-shell.rst similarity index 95% rename from doc/man/8/cephfs-shell.rst rename to doc/cephfs/cephfs-shell.rst index 62ebf60f20509..244d78bda12a5 100644 --- a/doc/man/8/cephfs-shell.rst +++ b/doc/cephfs/cephfs-shell.rst @@ -1,22 +1,10 @@ -:orphan: -=================================================== -cephfs-shell -- Shell-like tool talking with CephFS -=================================================== - -.. program:: cephfs-shell - -Synopsis -======== - -| **cephfs-shell** [options] [command] -| **cephfs-shell** [options] -- [command, command,...] - -Description -=========== +============= +CephFS Shell +============= CephFS Shell provides shell-like commands that directly interact with the -Ceph File System. +:term:`Ceph File System`. This tool can be used in interactive mode as well as in non-interactive mode. In former mode, cephfs-shell opens a shell session and after the given command @@ -29,20 +17,16 @@ return value. Behaviour of CephFS Shell can be tweaked using ``cephfs-shell.conf``. Refer to `CephFS Shell Configuration File`_ for details. -Options -======= - -.. option:: -c, --config FILE - - Path to cephfs-shell.conf - -.. option:: -b, --batch FILE +Usage : - Path to batch file. + cephfs-shell [options] [command] + cephfs-shell [options] -- [command, command,...] -.. option:: -t, --test FILE +Options : + -c, --config FILE Path to cephfs-shell.conf + -b, --batch FILE Path to batch file. + -t, --test FILE Path to transcript(s) in FILE for testing - Path to transcript(s) in FILE for testing .. note:: @@ -532,9 +516,7 @@ Right now, CephFS Shell inherits all its options from its dependency ``cmd2``. Therefore, these options might vary with the version of ``cmd2`` installed on your system. Refer to ``cmd2`` docs for a description of these options. -Following is a sample ``cephfs-shell.conf`` - -.. code-block:: ini +Following is a sample ``cephfs-shell.conf``:: [cephfs-shell] prompt = CephFS:~/>>> @@ -604,8 +586,3 @@ Following exit codes are returned by cephfs shell +-----------------------------------------------+-----------+ | Interrupted function call | 22 | +-----------------------------------------------+-----------+ - -Files -===== - -``~/.cephfs-shell.conf`` diff --git a/doc/cephfs/index.rst b/doc/cephfs/index.rst index b3de0f268aa10..02ae3e9b29346 100644 --- a/doc/cephfs/index.rst +++ b/doc/cephfs/index.rst @@ -115,7 +115,7 @@ Mounting CephFS Mount CephFS using Kernel Driver Mount CephFS using FUSE Mount CephFS on Windows - Use the CephFS Shell <../../man/8/cephfs-shell> + Use the CephFS Shell Supported Features of Kernel Driver Manual: ceph-fuse <../../man/8/ceph-fuse> Manual: mount.ceph <../../man/8/mount.ceph> diff --git a/doc/man/8/CMakeLists.txt b/doc/man/8/CMakeLists.txt index e020f347801df..8e1b9373fc83a 100644 --- a/doc/man/8/CMakeLists.txt +++ b/doc/man/8/CMakeLists.txt @@ -38,7 +38,6 @@ list(APPEND man_srcs ${osd_srcs} ${mon_srcs} ceph-mds.rst - cephfs-shell.rst cephfs-top.rst librados-config.rst cephadm.rst diff --git a/doc/man_index.rst b/doc/man_index.rst index d89cac2d31055..30ab1c3eba7a4 100644 --- a/doc/man_index.rst +++ b/doc/man_index.rst @@ -25,7 +25,6 @@ man/8/cephadm man/8/cephfs-top man/8/cephfs-mirror - man/8/cephfs-shell man/8/crushtool man/8/librados-config man/8/monmaptool -- 2.39.5