'tahoe rm' without a path gives an AssertionError with no explanation

[davidsarah]

Reported by drewp on IRC:

A new user tried to do a tahoe rm on a mutable file (SSK URI) without a path. The error he got was an assertion failure at src/allmydata/scripts/tahoe_rm.py#L24.

tahoe rm only works on directory entries, and therefore requires a path after the URI or alias, but that is non-obvious.

For a mutable file, it would be possible to truncate the file or write a marker in place of it, although that would not necessarily delete all shares. This ticket is just for the error message, and maybe documentation about what a user can do in this situation.

See also #776 (users are confused by "tahoe rm").

[davidsarah]

tahoe_rm.py: better error message when there is no path. docs/deleting.rst needs to be written. Includes test. refs #1292

[warner]

code change and test looks great. But if it references docs/deleting.rst, then it needs to be written.

[warner]

I'm not seeing any progress towards a docs/deleting.rst, so I'm kicking this out of 1.8.2 . We can land it as soon as we've got those docs.

[zooko]

Hey, I thought we could fix docs after the code freeze.

[warner]

Hmmm. I'm happy to have docs get fixed or added after the code freeze, but I'm not excited about landing a code change which explicitly references a missing piece of documentation. I wouldn't want to ship this change without the docs, and given the non-trivial challenge of explaining what "delete" means in an object-graph FS to a traditional-FS audience, I'm not confident that the documentation will appear before the release. And then I'd be faced with deciding between yanking the code change on the day of the release (way after code freeze) vs shipping with an embarassing dangling docs-pointer.

Once we get the docs, the release manager may choose to accept the patch during freeze (it is pretty small, after all).

[warner]

assigning back to davidsarah to write docs/deleting.rst

[davidsarah]

How about we land something that omits the reference to deleting.rst, but fixes the assert -- for example using just the string "'tahoe rm' can only unlink directory entries, so a path must be given." Then we can change that string if the docs are written before the final release.

[davidsarah]

test_cli.py: Test for error message when 'tahoe rm' is invoked without a path. refs #1292

[zooko]

Removing reviewed since I don't need to push this patch to trunk and adding review-needed since someone (Brian) needs to answer a question about what to do. There, now there are no tickets left with reviewed on them. Send more reviewed tickets!

[warner]

patch2 looks good, sorry about the delay. The error message is clear enough for me. Explaining how deletion works in general can live in another ticket and be written another day, now that this patch doesn't imply it's preexistence.

[david-sarah@…]

In 00fefeba4969605d:

test_cli.py: Test for error message when 'tahoe rm' is invoked without a path. refs #1292

[david-sarah@…]

In 52963f4a76809cde:

tahoe_rm.py: better error message when there is no path. refs #1292

[warner]

closed by 00fefeba4969605d and 52963f4a76809cde