Skip to content

Commit 2ca6350

Browse files
xxx:squash: doc update
Signed-off-by: John Mulligan <[email protected]>
1 parent a97b653 commit 2ca6350

File tree

2 files changed

+5
-10
lines changed

2 files changed

+5
-10
lines changed

docs/api-status.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1956,7 +1956,7 @@
19561956
},
19571957
{
19581958
"name": "Image.EncryptionLoad2",
1959-
"comment": "EncryptionLoad2 enables IO on an open encrypted image. The difference\nbetween EncryptionLoad and EncryptionLoad2 is that EncryptionLoad2 can open\nancestor images with a different encryption options than the current image.\nThe first EncryptionOptions in the slice is applied to the current image,\nthe second to the first ancestor, the third to the second ancestor and so\non. If the length of the slice is smaller than the number of ancestors the\nfinal item in the slice will be applied to all remaining ancestors, or if\nthe ancestor does not match the encryption format the ancestor will be\ninterpreted as plain-text.\n\nImplements:\n\n\tint rbd_encryption_load2(rbd_image_t image,\n\t const rbd_encryption_spec_t *specs,\n\t size_t spec_count);\n",
1959+
"comment": "EncryptionLoad2 enables IO on an open encrypted image. Multiple encryption\noption values can be passed to this call in a slice. For more information\nabout how items in the slice are applied to images, and possibly ancestor\nimages refer to the documentation in the C api for rbd_encryption_load2.\n\nImplements:\n\n\tint rbd_encryption_load2(rbd_image_t image,\n\t const rbd_encryption_spec_t *specs,\n\t size_t spec_count);\n",
19601960
"added_in_version": "$NEXT_RELEASE",
19611961
"expected_stable_version": "$NEXT_RELEASE_STABLE"
19621962
}

rbd/encryption_load2.go

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,10 @@ func (opts EncryptionOptionsLUKS2) writeEncryptionSpec(spec *C.rbd_encryption_sp
5555
}
5656
}
5757

58-
// EncryptionLoad2 enables IO on an open encrypted image. The difference
59-
// between EncryptionLoad and EncryptionLoad2 is that EncryptionLoad2 can open
60-
// ancestor images with a different encryption options than the current image.
61-
// The first EncryptionOptions in the slice is applied to the current image,
62-
// the second to the first ancestor, the third to the second ancestor and so
63-
// on. If the length of the slice is smaller than the number of ancestors the
64-
// final item in the slice will be applied to all remaining ancestors, or if
65-
// the ancestor does not match the encryption format the ancestor will be
66-
// interpreted as plain-text.
58+
// EncryptionLoad2 enables IO on an open encrypted image. Multiple encryption
59+
// option values can be passed to this call in a slice. For more information
60+
// about how items in the slice are applied to images, and possibly ancestor
61+
// images refer to the documentation in the C api for rbd_encryption_load2.
6762
//
6863
// Implements:
6964
//

0 commit comments

Comments
 (0)