ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2025-04-28 06:49:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

some doc improvements

Browse Source
This commit is contained in:
Jean-Paul Calderone 2023-01-12 15:37:07 -05:00
parent 2490f0f58a
commit 2d23e2e640
2 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/allmydata/client.py
View File

@ -1102,16 +1102,18 @@ class _Client(node.Node, pollmixin.PollMixin):
:param version: If given, the mutable file format for the new object :param version: If given, the mutable file format for the new object
(otherwise a format will be chosen automatically). (otherwise a format will be chosen automatically).
:param unique_keypair: **Warning** This valuely independently :param unique_keypair: **Warning** This value independently determines
determines the identity of the mutable object to create. There the identity of the mutable object to create. There cannot be two
cannot be two different mutable objects that share a keypair. different mutable objects that share a keypair. They will merge
They will merge into one object (with undefined contents). into one object (with undefined contents).
It is not common to pass a non-None value for this parameter. If It is common to pass a None value (or not pass a valuye) for this
None is given then a new random keypair will be generated. parameter. In these cases, a new random keypair will be
generated.
If non-None, the given public/private keypair will be used for the If non-None, the given public/private keypair will be used for the
new object. new object. The expected use-case is for implementing compliance
tests.
:return: A Deferred which will fire with a representation of the new :return: A Deferred which will fire with a representation of the new
mutable object after it has been uploaded. mutable object after it has been uploaded.

1
src/allmydata/scripts/cli.py
View File

@ -189,6 +189,7 @@ class PutOptions(FileStoreOptions):
"***Warning*** " "***Warning*** "
"It is possible to use this option to spoil the normal security properties of mutable objects. " "It is possible to use this option to spoil the normal security properties of mutable objects. "
"It is also possible to corrupt or destroy data with this option. " "It is also possible to corrupt or destroy data with this option. "
"Most users will not need this option and can ignore it. "
"For mutables only, " "For mutables only, "
"this gives a file containing a PEM-encoded 2048 bit RSA private key to use as the signature key for the mutable. " "this gives a file containing a PEM-encoded 2048 bit RSA private key to use as the signature key for the mutable. "
"The private key must be handled at least as strictly as the resulting capability string. " "The private key must be handled at least as strictly as the resulting capability string. "