Allow disabling the automatic use of our internal swtfb client by setting an env #118
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
…ct old way This should ensure that binaries built using this version are fixable without recompiling should issues with our current rm2fb client arise.
Sorry, but my pc has a billion toolchains and I'm not sure which one right now compiles correctly
fenollp
reviewed
Jan 26, 2024
| @@ -50,7 +50,19 @@ impl Framebuffer { | |||
| let device = &*device::CURRENT_DEVICE; | |||
| match device.model { | |||
| Model::Gen1 => Framebuffer::device(device.get_framebuffer_path()), | |||
| Model::Gen2 => Framebuffer::rm2fb(device.get_framebuffer_path()), | |||
| Model::Gen2 => { | |||
| // Auto-select old method still if env LIBREMARKABLE_FB_DISFAVOR_INTERNAL_RM2FB is set affirmatively | |||
There was a problem hiding this comment.
Could you add a mention in the README about this behavior plz?
fenollp
reviewed
Jan 26, 2024
Comment on lines
+55
to
+64
| if let Ok(env_answer) = std::env::var("LIBREMARKABLE_FB_DISFAVOR_INTERNAL_RM2FB") { | ||
| let env_answer = env_answer.to_lowercase(); | ||
| if env_answer == "1" || env_answer == "true" || env_answer == "yes" { | ||
| Framebuffer::device(device.get_framebuffer_path()) | ||
| } else { | ||
| Framebuffer::rm2fb(device.get_framebuffer_path()) | ||
| } | ||
| } else { | ||
| Framebuffer::rm2fb(device.get_framebuffer_path()) | ||
| } |
There was a problem hiding this comment.
How about this? (untested)
Suggested change
| if let Ok(env_answer) = std::env::var("LIBREMARKABLE_FB_DISFAVOR_INTERNAL_RM2FB") { | |
| let env_answer = env_answer.to_lowercase(); | |
| if env_answer == "1" || env_answer == "true" || env_answer == "yes" { | |
| Framebuffer::device(device.get_framebuffer_path()) | |
| } else { | |
| Framebuffer::rm2fb(device.get_framebuffer_path()) | |
| } | |
| } else { | |
| Framebuffer::rm2fb(device.get_framebuffer_path()) | |
| } | |
| match std::env::var("LIBREMARKABLE_FB_DISFAVOR_INTERNAL_RM2FB").ok() { | |
| Some("1") => Framebuffer::device(device.get_framebuffer_path()), | |
| _ => Framebuffer::rm2fb(device.get_framebuffer_path()), | |
| } |
There was a problem hiding this comment.
(I'm more inclined to be restrictive in the possible values, but feel free to revert that)
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.
There was an issue raised at #117 where presumably a new library is used as a shim for rM 2 Framebuffer support, but it doesn't seem to use the offical server, which our client relies on.
In general there had been issues raised that issues could arise even with the official shim if it gets updated but our implementation still does the old behaviour. Such applications would require to be recompiled to use
Framebuffer::deviceinstead ofFramebuffer::newor otherwise not work.This PR allows people to make libremarkable choose the old implementation in case the developer didn't care about it anyway / left the choice up to libremarkable.
It is done by setting the lengthy env
LIBREMARKABLE_FB_DISFAVOR_INTERNAL_RM2FBto1,yesortrue(case-insensitive). Feel free to suggest a better name, I couldn't think of any.Package maintainers could also fix arising issues by setting that env in some wrapper script for that binary without the need of any source code change or even re-complication if the binary is recent enough.
Basically this should future proof applications built using libremarkable better.