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

Sort interface names, to make documentation reproducible #1342

Merged
merged 1 commit into from Jul 10, 2022

Conversation

umlaeute
Copy link
Contributor

@umlaeute umlaeute commented Jul 7, 2022

can.VALID_INTERFACES is a frozenset, and therefore an unordered collection.

Therefore, the output of python3 -m can.logger -h (that is: the help for the --interface flag) depends on the actual ordering of the elements, which is undefined.
This means that the output (and in consequence the sphinx documentation) is not reproducible (as it might yield different results based on...whatever).

Since Reproducible Builds is a good thing™, this patch sorts the interfaces before displaying them.

@codecov
Copy link

codecov bot commented Jul 7, 2022

Codecov Report

Merging #1342 (79290af) into develop (5bca2d7) will increase coverage by 0.04%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #1342      +/-   ##
===========================================
+ Coverage    66.01%   66.06%   +0.04%     
===========================================
  Files           86       86              
  Lines         8960     8960              
===========================================
+ Hits          5915     5919       +4     
+ Misses        3045     3041       -4     

@zariiii9003 zariiii9003 merged commit 7b1893d into hardbyte:develop Jul 10, 2022
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.

None yet

2 participants