Repository navigation
Update all mnemonics - #4406
Update all mnemonics#4406
Conversation
krasimirgg
left a comment
There was a problem hiding this comment.
I like the addition of labels in these messages, but could we keep them as English prose. That seems to be the status quo for such messages in other languages' rulesets too.
Where is this the status quo? One thing I value about having the mnemonic in the progress message is it helps me locate where the action is implemented and tends to be the most consistent pattern across rules. |
Internally, we get glimpses of progress messages from all sorts of language integrations and they seem to mostly use a sentence. I think the idea is this is intended to be displayed to users that don't necessarily understand where the meaning of mnemonics and internal details of rulesets. I like to to think of it in terms of https://xkcd.com/303: you could shout back the progress message :) In Bazel, mnemonic is defined as "A one-word description of the action, for example, CppCompile or GoLink", whereas progress_message is defined as "Progress message to show to the user during the build, for example, "Compiling foo.cc to create foo.o"".
At the same time, I agree that the label and mnemonic are useful pieces of information to include -- so I suggest keep the high-level format as a single sentence that explains roughly what's happening, while using labels to disambiguate crates with the same name and also mentioning the mnemonic, like: (aside, I don't think mentioning the number of files is super useful, and sometimes it's actively misleading when we have generated source files -- you can have 1 "source file" but a huge generated one that takes a lot of time to compile, or a whole directory of generated source files counted as one). |
|
How about this, can folks propose progress messages for the following mnemonics? I care more about consistency than I do my proposed format.
|
|
I'm also not confident in the need for a flag for this change. I would be happy to just update the progress messages. |
|
Agreed on dropping the What do you think about setting up some rules of thumb across all actions:
|
experimental_simple_progress_messages|
re: #4406 (comment) |
This change updates all mnemonics part of the public interface to be consistent with each other.