Skip to content

Commit c06a57e

Browse files
committed
doc: Clarify and expand descriptions of NonFiles
Discussed in: #1730 (comment) At least for now, they remain called `NonFile`s (and sometimes referred to as "non-files" in text), but more specifically defined.
1 parent 29cb775 commit c06a57e

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

gix-dir/src/entry.rs

+5-3
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,13 @@ pub enum Property {
2626
/// The kind of the entry, seated in their kinds available on disk.
2727
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Ord, PartialOrd)]
2828
pub enum Kind {
29-
/// Something that is not a file, like a named pipe or character device.
29+
/// Something that is not a regular file, directory, or symbolic link.
3030
///
31-
/// These can only exist in the filesystem.
31+
/// These can only exist in the filesystem, because Git repositories do not support them.
32+
/// They do not appear as blobs in a repository, and their type is not specifiable in a tree object.
33+
/// Examples include named pipes (FIFOs), character devices, block devices, and sockets.
3234
NonFile,
33-
/// The entry is a blob, executable or not.
35+
/// The entry is a blob, representing a regular file, executable or not.
3436
File,
3537
/// The entry is a symlink.
3638
Symlink,

gix-status/src/index_as_worktree/types.rs

+3-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,9 @@ impl Outcome {
103103
pub enum Change<T = (), U = ()> {
104104
/// This corresponding file does not exist in the worktree anymore.
105105
Removed,
106-
/// 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.
106+
/// The type of file changed compared to the worktree.
107+
///
108+
/// Examples include when a symlink is now a regular file, or a regular file was replaced with a named pipe.
107109
///
108110
/// ### Deviation
109111
///

0 commit comments

Comments
 (0)