aboutsummaryrefslogtreecommitdiff
path: root/crates/vfs
diff options
context:
space:
mode:
authorArnaud <[email protected]>2021-01-07 11:18:25 +0000
committerArnaud <[email protected]>2021-01-07 11:18:25 +0000
commitd216d718bf545052d77968688861f83861a0225b (patch)
tree35bd55a71bc6e867ad2870f9d1518afcd6981de4 /crates/vfs
parentf80f4ff223081040cfa0f72da6ddea8329e2f977 (diff)
Use `file_set::FileSet` and `FileSet` consistently in doc
The first occurrence of `FileSet` has the full path (`file_set::FileSet`), while every other is simply `FileSet`.
Diffstat (limited to 'crates/vfs')
-rw-r--r--crates/vfs/src/lib.rs10
1 files changed, 5 insertions, 5 deletions
diff --git a/crates/vfs/src/lib.rs b/crates/vfs/src/lib.rs
index 8c8d1114d..2b7b14524 100644
--- a/crates/vfs/src/lib.rs
+++ b/crates/vfs/src/lib.rs
@@ -18,15 +18,15 @@
18//! free-form via list of globs, it's up to the [`Handle`] to interpret the globs 18//! free-form via list of globs, it's up to the [`Handle`] to interpret the globs
19//! in any specific way. 19//! in any specific way.
20//! 20//!
21//! VFS stores a flat list of files. [`FileSet`] can partition this list of files 21//! VFS stores a flat list of files. [`file_set::FileSet`] can partition this list
22//! into disjoint sets of files. Traversal-like operations (including getting 22//! of files into disjoint sets of files. Traversal-like operations (including
23//! the neighbor file by the relative path) are handled by the [`FileSet`]. 23//! getting the neighbor file by the relative path) are handled by the [`FileSet`].
24//! [`FileSet`]s are also pushed to salsa and cause it to re-check `mod foo;` 24//! [`FileSet`]s are also pushed to salsa and cause it to re-check `mod foo;`
25//! declarations when files are created or deleted. 25//! declarations when files are created or deleted.
26//! 26//!
27//! [`file_set::FileSet`] and [`loader::Entry`] play similar, but different roles. 27//! [`FileSet`] and [`loader::Entry`] play similar, but different roles.
28//! Both specify the "set of paths/files", one is geared towards file watching, 28//! Both specify the "set of paths/files", one is geared towards file watching,
29//! the other towards salsa changes. In particular, single [`file_set::FileSet`] 29//! the other towards salsa changes. In particular, single [`FileSet`]
30//! may correspond to several [`loader::Entry`]. For example, a crate from 30//! may correspond to several [`loader::Entry`]. For example, a crate from
31//! crates.io which uses code generation would have two [`Entries`] -- for sources 31//! crates.io which uses code generation would have two [`Entries`] -- for sources
32//! in `~/.cargo`, and for generated code in `./target/debug/build`. It will 32//! in `~/.cargo`, and for generated code in `./target/debug/build`. It will