Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use consistent case in signature and key messages #3426

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

pmatilai
Copy link
Member

@pmatilai pmatilai commented Nov 5, 2024

The signature and key related messages are a historical mess of inconsistency, we have at least the following in closely related messages that happen under slightly different circumstances:

  • Header V4 RSA/SHA256 Signature
  • RSA signature: NOTFOUND
  • signatures OK
  • key ID
  • Key Fingerprint

Just use lower case consistently for everything but acronyms, so the above becomes

  • Header V4 RSA/SHA256 signature
  • RSA signature: NOTFOUND
  • signatures OK
  • key ID
  • key fingerprint

This will no doubt break somebody's fine-tuned script but we're breaking them in 6.0 anyhow so this is the right time for this kind of cleanup.

The signature and key related messages are a historical mess of
inconsistency, we have at least the following in closely related messages
that happen under slightly different circumstances:
- Header V4 RSA/SHA256 Signature
- RSA signature: NOTFOUND
- signatures OK
- key ID
- Key Fingerprint

Just use lower case consistently for everything but acronyms, so the
above becomes
- Header V4 RSA/SHA256 signature
- RSA signature: NOTFOUND
- signatures OK
- key ID
- key fingerprint

This will no doubt break somebody's fine-tuned script but we're breaking
them in 6.0 anyhow so this is the right time for this kind of cleanup.
@pmatilai pmatilai requested a review from a team as a code owner November 5, 2024 07:10
@pmatilai pmatilai requested review from ffesti and removed request for a team November 5, 2024 07:10
@pmatilai
Copy link
Member Author

pmatilai commented Nov 5, 2024

Loosely related to the multiple signatures stuff - this was driving me crazy when writing tests.

@pmatilai
Copy link
Member Author

pmatilai commented Nov 5, 2024

(also, all the Signature/signature case differences while "digest" was consistently "digest")

@ffesti
Copy link
Contributor

ffesti commented Nov 5, 2024

What about "Header"?

@pmatilai
Copy link
Member Author

pmatilai commented Nov 5, 2024

Header (and Payload) only appear as the first word on the line where upper case seems appropriate.
The examples here aren't of course showing the full context so it's not obvious from there.

@pmatilai
Copy link
Member Author

pmatilai commented Nov 5, 2024

Oh and FWIW, there will be other changes to the messages coming through #3385. Those changes are best discussed in that ticket, I just think this is obvious enough not to require prior discussion.

@ffesti
Copy link
Contributor

ffesti commented Nov 5, 2024

Not sure if I like that "only appear as the first word on the line" argument when we lower cased the first word everywhere else. Anyway, this is a lot better than before and we change change Payload and Header later on.

@ffesti ffesti merged commit 02f09b3 into rpm-software-management:master Nov 5, 2024
1 check passed
@pmatilai
Copy link
Member Author

pmatilai commented Nov 5, 2024

Those other messages don't appear as the first thing on the line, they're just out of context here. But thanks for merging, will help preserve my sanity going forward 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants