Try to unify punctuation of messages. #16654
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Most of the error messages that are printed by the "zpool" or "zfs" commands use a common punctuation, where after a dot, there are *two* spaces before the capital letter of the next sentence. However, there were a couple of messages that used a different punctuation, where only one space was used between the dot and the next sentence. This commit unifies error, warning and info messages to use the same punctuation with two spaces after the dot. Signed-off-by: Tobias Plüss <[email protected]>
behlendorf
reviewed
Oct 16, 2024
There was a problem hiding this comment.
Thanks for making a consistency pass over these messages. Can you just refresh this PR and address the style warnings it introduced.
https://github.com/openzfs/zfs/actions/runs/11350309995/job/31568414363?pr=16654
behlendorf
added
the
Status: Revision Needed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
I noticed this just recently when I was tinkering around with one of my pools and got some ZFS error messages. It seemed to me that not all messages were formatted the same way.
Most of the error messages that are printed by the "zpool" or "zfs" commands use the common punctuation, where after a dot, there are two spaces before the capital letter of the next sentence. This is also true for most of the comments. However, there were a couple of messages that used a different punctuation, where only one space was used between the dot and the next sentence. I tried to unify the formatting of all error and info messages, such that everywhere the same punctuation is used. All comments, copyrights and so on are, of course, completely untouched, just the strings that are printed on the console, and are therefore visible to users, I have corrected in the sense that they are all using identical punctuation.
Technically for sure useless, I just noticed that not everything is formatted in the same way and thought maybe it would be nice if this was the case.
Description
How Has This Been Tested?
Types of changes
Checklist:
Signed-off-by.