From a6ba963ad4501930243f0e6e20d81af3f09c477c Mon Sep 17 00:00:00 2001 From: Armando Montanez Date: Fri, 1 Jul 2022 21:47:50 +0000 Subject: [PATCH] pw_snapshot: Update software_version comments Updates the inline documentation for the software_version field of the snapshot Metadata proto message to clarify that the field is intentionally not tokenizable. Change-Id: I26498e88d310c537f087d33a2762e3bffc45bb34 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/100800 Reviewed-by: Carlos Chinchilla Commit-Queue: Auto-Submit Pigweed-Auto-Submit: Armando Montanez --- pw_snapshot/pw_snapshot_protos/snapshot_metadata.proto | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/pw_snapshot/pw_snapshot_protos/snapshot_metadata.proto b/pw_snapshot/pw_snapshot_protos/snapshot_metadata.proto index dabf49b0a..12b3ffbd9 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]"