Skip to content

Commit

Permalink
Merge pull request aws#1474 from kyleknap/rb-doc-update
Browse files Browse the repository at this point in the history
Update rb help documentation
  • Loading branch information
kyleknap committed Sep 2, 2015
2 parents 0f8fefe + eed7f33 commit ed610bc
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions awscli/customizations/s3/subcommands.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,12 @@

FORCE = {'name': 'force', 'action': 'store_true',
'help_text': (
"Deletes all objects in the bucket including the bucket itself.")}
"Deletes all objects in the bucket including the bucket itself. "
"Note that versioned objects will not be deleted in this "
"process which would cause the bucket deletion to fail because "
"the bucket would not be empty. To delete versioned "
"objects use the ``s3api delete-object`` command with "
"the ``--version-id`` parameter.")}


FOLLOW_SYMLINKS = {'name': 'follow-symlinks', 'action': 'store_true',
Expand Down Expand Up @@ -593,7 +598,13 @@ class MbCommand(S3TransferCommand):

class RbCommand(S3TransferCommand):
NAME = 'rb'
DESCRIPTION = "Deletes an S3 bucket."
DESCRIPTION = (
"Deletes an empty S3 bucket. A bucket must be completely empty "
"of objects and versioned objects before it can be deleted. "
"However, the ``--force`` parameter can be used to delete "
"the non-versioned objects in the bucket before the bucket is "
"deleted."
)
USAGE = "<S3Path>"
ARG_TABLE = [{'name': 'paths', 'nargs': 1, 'positional_arg': True,
'synopsis': USAGE}, FORCE]
Expand Down

0 comments on commit ed610bc

Please sign in to comment.