From 6c18d738e7f183a7c5230d87e2111b80e952bc0c Mon Sep 17 00:00:00 2001 From: James Swan <122404367+swan-amazon@users.noreply.github.com> Date: Thu, 19 Dec 2024 20:48:23 +0000 Subject: [PATCH] [doc] Improve Terms and Conditions commissioning arguments documentation Updated documentation for T&C-related commissioning arguments to better reflect their actual usage and purpose: - require-tc-acknowledgements: Clarified the impact on commissioning flow - tc-acknowledgements: Explained the bit-field usage for user acceptance - tc-acknowledgements-version: Added context about version tracking --- .../chip-tool/commands/pairing/PairingCommand.h | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/examples/chip-tool/commands/pairing/PairingCommand.h b/examples/chip-tool/commands/pairing/PairingCommand.h index 5d3363a7d86f55..4fc0929d2bbc33 100644 --- a/examples/chip-tool/commands/pairing/PairingCommand.h +++ b/examples/chip-tool/commands/pairing/PairingCommand.h @@ -204,16 +204,17 @@ class PairingCommand : public CHIPCommand, Argument::kOptional); AddArgument("require-tc-acknowledgements", 0, 1, &mRequireTCAcknowledgements, - "Terms and Conditions acknowledgements is known to be required or not, (when required, the commissioner " - "will wait until they are provided)"); + "Indicates whether Terms and Conditions acknowledgements are required during commissioning. If set to " + "true, the commissioner must provide valid T&C acknowledgements or the commissioning will fail. If false, " + "the T&C acknowledgement step will be skipped."); AddArgument("tc-acknowledgements", 0, UINT16_MAX, &mTCAcknowledgements, - "Terms and Conditions acknowledgements to use to set the General Commissioning cluster's TC " - "Acknowledgements bit-field"); + "Bit-field value indicating which Terms and Conditions have been accepted by the user. This value is sent " + "to the device during commissioning via the General Commissioning cluster"); AddArgument("tc-acknowledgements-version", 0, UINT16_MAX, &mTCAcknowledgementVersion, - "Terms and Conditions acknowledgement version to use to set the General Commissioning cluster's TC " - "Acknowledgement version"); + "Version number of the Terms and Conditions that were accepted by the user. This value is sent to the " + "device during commissioning to indicate which T&C version was acknowledged"); } AddArgument("timeout", 0, UINT16_MAX, &mTimeout);