Skip to content

Clarify and expand descriptions of NonFiles #1734

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Dec 22, 2024
Merged

Clarify and expand descriptions of NonFiles #1734

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c06a57e
doc: Clarify and expand descriptions of `NonFile`s
EliahKagan Dec 22, 2024
d90412b
fix!: rename `entry::Kind::NonFile` to `entry::Kind::Untrackable`.
Byron Dec 22, 2024
329a734
adapt to changes in `gix-dir`
Byron Dec 22, 2024
154b21f
Reword "non-files" in documentation comments
EliahKagan Dec 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions gix-dir/src/entry.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,13 @@ pub enum Property {
/// The kind of the entry, seated in their kinds available on disk.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd)]
pub enum Kind {
/// Something that is not a file, like a named pipe or character device.
/// Something that is not a regular file, directory, or symbolic link.
///
/// These can only exist in the filesystem.
/// These can only exist in the filesystem, because Git repositories do not support them.
/// They do not appear as blobs in a repository, and their type is not specifiable in a tree object.
/// Examples include named pipes (FIFOs), character devices, block devices, and sockets.
NonFile,
/// The entry is a blob, executable or not.
/// The entry is a blob, representing a regular file, executable or not.
File,
/// The entry is a symlink.
Symlink,
Expand Down
4 changes: 3 additions & 1 deletion gix-status/src/index_as_worktree/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,9 @@ impl Outcome {
pub enum Change<T = (), U = ()> {
/// This corresponding file does not exist in the worktree anymore.
Removed,
/// The type of file changed compared to the worktree, i.e. a symlink is now a file, or a file was replaced with a named pipe.
/// The type of file changed compared to the worktree.
///
/// Examples include when a symlink is now a regular file, or a regular file was replaced with a named pipe.
///
/// ### Deviation
///
Expand Down
Loading