Fix try_load_port to match its documented interface. #1533
Merged
Conversation
This file contains hidden or 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
The last two paths in try_load_port translated a nonexistent port directory or missing CONTROL file into errors, which is the try_load_port_required interface. No path returned the "nullptr scfl" result. The only caller of try_load_port in registries.cpp therefore clearly wanted the "_required" behavior.
BillyONeal
commented
Oct 28, 2024
| std::string spdx_location = "git+https://github.com/Microsoft/vcpkg#ports/"; | ||
| spdx_location.append(port_name.data(), port_name.size()); | ||
| return Paragraphs::try_load_port(m_fs, port_name, PortLocation{path, std::move(spdx_location)}) | ||
| return Paragraphs::try_load_port_required(m_fs, port_name, PortLocation{path, std::move(spdx_location)}) |
Member
Author
There was a problem hiding this comment.
As an aside, I think this behavior is wrong, and this really should return the nullptr case. However, fixing that I believe is what resulted in #1486 (comment)
This PR intentionally does not change existing product behavior.
ras0219-msft
approved these changes
Oct 28, 2024
| const PortLocation& port_location) | ||
| { | ||
| auto load_result = try_load_port(fs, port_name, port_location); | ||
| auto load_result = try_load_port(fs, port_location); |
Collaborator
There was a problem hiding this comment.
If this is the only caller, should try_load_port be inlined?
Member
Author
There was a problem hiding this comment.
I intend to add other callers :)
Member
Author
There was a problem hiding this comment.
(Specifically, how I discovered this situation: overlay-ports want to try-load-port and it's OK if there's no port there: because it might be a directory containing overlays rather than the overlay itself)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The last two paths in try_load_port translated a nonexistent port directory or missing CONTROL file into errors, which is the try_load_port_required interface. No path returned the "nullptr scfl" result.
The only caller of try_load_port in registries.cpp therefore clearly wanted the "_required" behavior.