diff --git a/pw_snapshot/pw_snapshot_protos/snapshot_metadata.proto b/pw_snapshot/pw_snapshot_protos/snapshot_metadata.proto index dabf49b0a5..12b3ffbd98 100644 --- a/pw_snapshot/pw_snapshot_protos/snapshot_metadata.proto +++ b/pw_snapshot/pw_snapshot_protos/snapshot_metadata.proto @@ -48,8 +48,11 @@ message Metadata { bytes project_name = 3 [(tokenizer.format) = TOKENIZATION_OPTIONAL]; // Version characters must be alphanumeric, punctuation, and space. This - // string is case-sensitive. This should either be human readable text, or - // tokenized data. + // string is case-sensitive. This should always be human readable text, and + // does not support tokenization by design. If this field was tokenized, it's + // possible that the token could be lost (e.g. generated by a local developer + // build and not uploaded anywhere) and a firmware version running on a device + // in the field would be left entirely unidentifiable. // // Examples: // "codename-local-[build_id]"