diff mbox

doc: mkcephfs man page, -c ceph.conf is not optional

Message ID CACkq2mpfk+Toccayvp6fJ7Hry6CEuceipLJxujq1SQUFXv9STQ@mail.gmail.com (mailing list archive)
State New, archived
Headers show

Commit Message

Travis Rhoden Aug. 17, 2012, 8:45 p.m. UTC
The man page for mkcephfs and the output of mkcephfs --help
do not agree with each other.  the man page says -c ceph.conf
is optional, while mkcephfs --help says it is required.

Through empirical evidence, I believe it is required.  Update
the man page to make it so.

Signed-off-by: Travis Rhoden <trhoden@gmail.com>
---
 doc/man/8/mkcephfs.rst |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

--
1.7.4.4
--
To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Sage Weil Aug. 20, 2012, 8:14 p.m. UTC | #1
Applied, thanks!

On Fri, 17 Aug 2012, Travis Rhoden wrote:

> The man page for mkcephfs and the output of mkcephfs --help
> do not agree with each other.  the man page says -c ceph.conf
> is optional, while mkcephfs --help says it is required.
> 
> Through empirical evidence, I believe it is required.  Update
> the man page to make it so.
> 
> Signed-off-by: Travis Rhoden <trhoden@gmail.com>
> ---
>  doc/man/8/mkcephfs.rst |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
> 
> diff --git a/doc/man/8/mkcephfs.rst b/doc/man/8/mkcephfs.rst
> index ddc378a..5d0c995 100644
> --- a/doc/man/8/mkcephfs.rst
> +++ b/doc/man/8/mkcephfs.rst
> @@ -7,7 +7,7 @@
>  Synopsis
>  ========
> 
> -| **mkcephfs** [ -c *ceph.conf* ] [ --mkbtrfs ] [ -a, --all-hosts [ -k
> +| **mkcephfs** -c *ceph.conf* [ --mkbtrfs ] [ -a, --all-hosts [ -k
>    */path/to/admin.keyring* ] ]
> 
> 
> --
> 1.7.4.4
> --
> To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> 
> 
--
To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/doc/man/8/mkcephfs.rst b/doc/man/8/mkcephfs.rst
index ddc378a..5d0c995 100644
--- a/doc/man/8/mkcephfs.rst
+++ b/doc/man/8/mkcephfs.rst
@@ -7,7 +7,7 @@ 
 Synopsis
 ========

-| **mkcephfs** [ -c *ceph.conf* ] [ --mkbtrfs ] [ -a, --all-hosts [ -k
+| **mkcephfs** -c *ceph.conf* [ --mkbtrfs ] [ -a, --all-hosts [ -k
   */path/to/admin.keyring* ] ]