From 1c04ce6f3ab0f18f5ad36353ddbb07e2c8eb4468 Mon Sep 17 00:00:00 2001
From: Kefu Chai <kchai@redhat.com>
Date: Tue, 4 May 2021 10:59:03 +0800
Subject: [PATCH] doc/man: build and install cephfs-shell manpage

otherwise the manpage of cephfs-shell is not built and installed.

Signed-off-by: Kefu Chai <kchai@redhat.com>
---
 ceph.spec.in                           | 1 +
 debian/cephfs-shell.install            | 1 +
 doc/cephfs/index.rst                   | 4 ++--
 doc/man/8/CMakeLists.txt               | 5 +++++
 doc/{cephfs => man/8}/cephfs-shell.rst | 0
 doc/man_index.rst                      | 1 +
 6 files changed, 10 insertions(+), 2 deletions(-)
 rename doc/{cephfs => man/8}/cephfs-shell.rst (100%)

diff --git a/ceph.spec.in b/ceph.spec.in
index 82295884696..39c3bade79f 100644
--- a/ceph.spec.in
+++ b/ceph.spec.in
@@ -2317,6 +2317,7 @@ 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 4713a81b115..ee9e1399ff8 100644
--- a/debian/cephfs-shell.install
+++ b/debian/cephfs-shell.install
@@ -1,2 +1,3 @@
 usr/bin/cephfs-shell
 usr/lib/python3*/dist-packages/cephfs_shell-*.egg-info
+usr/share/man/man8/cephfs-shell.8
diff --git a/doc/cephfs/index.rst b/doc/cephfs/index.rst
index 02ae3e9b293..c4c7e221313 100644
--- a/doc/cephfs/index.rst
+++ b/doc/cephfs/index.rst
@@ -57,7 +57,7 @@ for interactive access or scripting via the `cephfs-shell`_.
 .. _deploy MDS manually as needed: add-remove-mds
 .. _Orchestrator deployment table: ../mgr/orchestrator/#current-implementation-status
 .. _Mount CephFS\: Prerequisites: mount-prerequisites
-.. _cephfs-shell: cephfs-shell
+.. _cephfs-shell: ../man/8/cephfs-shell
 
 
 .. raw:: html
@@ -115,7 +115,7 @@ Mounting CephFS
     Mount CephFS using Kernel Driver <mount-using-kernel-driver>
     Mount CephFS using FUSE <mount-using-fuse>
     Mount CephFS on Windows <ceph-dokan>
-    Use the CephFS Shell <cephfs-shell>
+    Use the CephFS Shell <../../man/8/cephfs-shell>
     Supported Features of Kernel Driver <kernel-features>
     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 8e1b9373fc8..c39b3e1a4c1 100644
--- a/doc/man/8/CMakeLists.txt
+++ b/doc/man/8/CMakeLists.txt
@@ -43,6 +43,11 @@ list(APPEND man_srcs
   cephadm.rst
   cephfs-mirror.rst)
 
+if(WITH_CEPHFS_SHELL)
+  list(APPEND man_srcs
+    cephfs-shell.rst)
+endif()
+
 if(HAVE_LIBFUSE)
   list(APPEND man_srcs
     ceph-fuse.rst
diff --git a/doc/cephfs/cephfs-shell.rst b/doc/man/8/cephfs-shell.rst
similarity index 100%
rename from doc/cephfs/cephfs-shell.rst
rename to doc/man/8/cephfs-shell.rst
diff --git a/doc/man_index.rst b/doc/man_index.rst
index 30ab1c3eba7..d89cac2d310 100644
--- a/doc/man_index.rst
+++ b/doc/man_index.rst
@@ -25,6 +25,7 @@
    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