Skip to content

Commit

Permalink
Merge PR #52867 into main
Browse files Browse the repository at this point in the history
* refs/pull/52867/head:
	doc: modify and add descriptions for  cephfs-shell commands.

Reviewed-by: Venky Shankar <[email protected]>
Reviewed-by: Jos Collin <[email protected]>
  • Loading branch information
vshankar committed Aug 21, 2023
2 parents 44f4d78 + 6869ba3 commit 83ab48a
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/tools/cephfs/shell/cephfs-shell
Original file line number Diff line number Diff line change
Expand Up @@ -917,7 +917,7 @@ class CephFSShell(Cmd):
return self.complete_filenames(text, line, begidx, endidx)

ls_parser = argparse.ArgumentParser(
description='Copy a file from Ceph File System from Local Directory.')
description='List all the files and directories in the current working directory.')
ls_parser.add_argument('-l', '--long', action='store_true',
help='Detailed list of items in the directory.')
ls_parser.add_argument('-r', '--reverse', action='store_true',
Expand Down Expand Up @@ -1122,7 +1122,8 @@ class CephFSShell(Cmd):
"""
return self.complete_filenames(text, line, begidx, endidx)

mv_parser = argparse.ArgumentParser(description='Move File.')
mv_parser = argparse.ArgumentParser(description='Rename a file or Move a file\
from source path to the destination.')
mv_parser.add_argument('src_path', type=str, action=path_to_bytes,
help='Source File Path.')
mv_parser.add_argument('dest_path', type=str, action=path_to_bytes,
Expand Down Expand Up @@ -1189,7 +1190,7 @@ class CephFSShell(Cmd):
"""
return self.complete_filenames(text, line, begidx, endidx)

cat_parser = argparse.ArgumentParser(description='')
cat_parser = argparse.ArgumentParser(description='Print contents of a file')
cat_parser.add_argument('paths', help='Name of Files', action=path_to_bytes,
nargs='+')

Expand Down Expand Up @@ -1245,7 +1246,7 @@ class CephFSShell(Cmd):
index_dict = {1: self.path_complete}
return self.index_based_complete(text, line, begidx, endidx, index_dict)

lcd_parser = argparse.ArgumentParser(description='')
lcd_parser = argparse.ArgumentParser(description='Moves into the given local directory')
lcd_parser.add_argument('path', type=str, action=path_to_bytes, help='Path')

@with_argparser(lcd_parser)
Expand Down

0 comments on commit 83ab48a

Please sign in to comment.