Expand from_fs doc
#1818
Merged
Expand from_fs doc
#1818
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
This expands and slightly corrects the `gix_index::entry::from_fs` documentation: - To be more precise about the expectation of where the metadata come from (it needn't specifically be the `symlink_metadata` function, and it is sometimes even an `fstat`-like function rather than an `lstat`-like function, though not `stat`). - To mention that default values are used for unavailable data. - To mention that truncation is sometimes performed on some fields. Comments are also updated regarding some cases of truncation: why casting down to 32-bit should be okay for `st_dev` and `st_ino` (see GitoxideLabs#1817).
Byron
approved these changes
Jan 30, 2025
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.
Fixes #1817
This expands and slightly corrects the
gix_index::entry::from_fsdocumentation:symlink_metadatafunction, and it is sometimes even anfstat-like function rather than anlstat-like function, though notstat).Comments are also updated regarding some cases of truncation: why casting down to 32-bit should be okay for
st_devandst_ino. Thest_devcase is discussed in #1817. I think this applies also tost_ino, but if that is less certain then further changes may be needed here.