From 19b0cc01b0d0d93691b74edb6070cda8f476ff57 Mon Sep 17 00:00:00 2001 From: Boris Zbarsky Date: Thu, 3 Nov 2022 14:56:42 -0400 Subject: [PATCH] Add a spec reference to the chip-tool docs for timedInteractionTimeoutMs. (#23468) People keep being confused by what this means, if they don't know what timed interactions are. Point to the spec section they should read to figure that out. --- examples/chip-tool/commands/clusters/ClusterCommand.h | 3 ++- examples/chip-tool/commands/clusters/WriteAttributeCommand.h | 3 ++- .../commands/clusters/ClusterCommandBridge.h | 3 ++- .../commands/clusters/WriteAttributeCommandBridge.h | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/examples/chip-tool/commands/clusters/ClusterCommand.h b/examples/chip-tool/commands/clusters/ClusterCommand.h index 70875643691edf..4b8325074a8716 100644 --- a/examples/chip-tool/commands/clusters/ClusterCommand.h +++ b/examples/chip-tool/commands/clusters/ClusterCommand.h @@ -140,7 +140,8 @@ class ClusterCommand : public InteractionModelCommands, public ModelCommand, pub void AddArguments() { AddArgument("timedInteractionTimeoutMs", 0, UINT16_MAX, &mTimedInteractionTimeoutMs, - "If provided, do a timed invoke with the given timed interaction timeout."); + "If provided, do a timed invoke with the given timed interaction timeout. See \"7.6.10. Timed Interaction\" in " + "the Matter specification."); AddArgument("suppressResponse", 0, 1, &mSuppressResponse); AddArgument("repeat-count", 1, UINT16_MAX, &mRepeatCount); AddArgument("repeat-delay-ms", 0, UINT16_MAX, &mRepeatDelayInMs); diff --git a/examples/chip-tool/commands/clusters/WriteAttributeCommand.h b/examples/chip-tool/commands/clusters/WriteAttributeCommand.h index 1cb6ff35383628..ac9f6233a65ff4 100644 --- a/examples/chip-tool/commands/clusters/WriteAttributeCommand.h +++ b/examples/chip-tool/commands/clusters/WriteAttributeCommand.h @@ -200,7 +200,8 @@ class WriteAttribute : public InteractionModelWriter, public ModelCommand, publi void AddArguments() { AddArgument("timedInteractionTimeoutMs", 0, UINT16_MAX, &mTimedInteractionTimeoutMs, - "If provided, do a timed write with the given timed interaction timeout."); + "If provided, do a timed write with the given timed interaction timeout. See \"7.6.10. Timed Interaction\" in " + "the Matter specification."); AddArgument("data-version", 0, UINT32_MAX, &mDataVersions, "Comma-separated list of data versions for the clusters being written."); AddArgument("suppressResponse", 0, 1, &mSuppressResponse); diff --git a/examples/darwin-framework-tool/commands/clusters/ClusterCommandBridge.h b/examples/darwin-framework-tool/commands/clusters/ClusterCommandBridge.h index c1212025fc624a..87022306220e30 100644 --- a/examples/darwin-framework-tool/commands/clusters/ClusterCommandBridge.h +++ b/examples/darwin-framework-tool/commands/clusters/ClusterCommandBridge.h @@ -117,7 +117,8 @@ class ClusterCommand : public ModelCommand { void AddArguments() { AddArgument("timedInteractionTimeoutMs", 0, UINT16_MAX, &mTimedInteractionTimeoutMs, - "If provided, do a timed invoke with the given timed interaction timeout."); + "If provided, do a timed invoke with the given timed interaction timeout. See \"7.6.10. Timed Interaction\" in the " + "Matter specification."); AddArgument("repeat-count", 1, UINT16_MAX, &mRepeatCount); AddArgument("repeat-delay-ms", 0, UINT16_MAX, &mRepeatDelayInMs); ModelCommand::AddArguments(); diff --git a/examples/darwin-framework-tool/commands/clusters/WriteAttributeCommandBridge.h b/examples/darwin-framework-tool/commands/clusters/WriteAttributeCommandBridge.h index 6c74b9bdb6744e..c6ba60f86388f7 100644 --- a/examples/darwin-framework-tool/commands/clusters/WriteAttributeCommandBridge.h +++ b/examples/darwin-framework-tool/commands/clusters/WriteAttributeCommandBridge.h @@ -107,7 +107,8 @@ class WriteAttribute : public ModelCommand { void AddArguments() { AddArgument("timedInteractionTimeoutMs", 0, UINT16_MAX, &mTimedInteractionTimeoutMs, - "If provided, do a timed write with the given timed interaction timeout."); + "If provided, do a timed write with the given timed interaction timeout. See \"7.6.10. Timed Interaction\" in the " + "Matter specification."); ModelCommand::AddArguments(); }