Skip to content

Commit

Permalink
[doc] Clarify required arguments for T&C acknowledgements
Browse files Browse the repository at this point in the history
Update help text for require-tc-acknowledgements to explicitly state which
arguments must be provided when T&C acknowledgements are required. Instead
of the vague "valid T&C acknowledgements", now specifically mentions that
both tc-acknowledgements and tc-acknowledgements-version arguments are
mandatory for successful commissioning when this option is enabled.
  • Loading branch information
swan-amazon committed Dec 19, 2024
1 parent f2e7ba5 commit c8ff0e0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions examples/chip-tool/commands/pairing/PairingCommand.h
Original file line number Diff line number Diff line change
Expand Up @@ -205,8 +205,8 @@ class PairingCommand : public CHIPCommand,

AddArgument("require-tc-acknowledgements", 0, 1, &mRequireTCAcknowledgements,
"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.");
"true, the tc-acknowledgements and tc-acknowledgements-version arguments must be provided for the "
"commissioning to succeed. If false, the T&C acknowledgement step will be skipped.");

AddArgument("tc-acknowledgements", 0, UINT16_MAX, &mTCAcknowledgements,
"Bit-field value indicating which Terms and Conditions have been accepted by the user. This value is sent "
Expand Down

0 comments on commit c8ff0e0

Please sign in to comment.