##// END OF EJS Templates
rust: Add doc-comments to DirstateStatus fields...
Simon Sapin -
r47881:623c8e4d default
parent child Browse files
Show More
@@ -256,18 +256,39 b' pub struct StatusOptions {'
256
256
257 #[derive(Debug)]
257 #[derive(Debug)]
258 pub struct DirstateStatus<'a> {
258 pub struct DirstateStatus<'a> {
259 /// Tracked files whose contents have changed since the parent revision
259 pub modified: Vec<HgPathCow<'a>>,
260 pub modified: Vec<HgPathCow<'a>>,
261
262 /// Newly-tracked files that were not present in the parent
260 pub added: Vec<HgPathCow<'a>>,
263 pub added: Vec<HgPathCow<'a>>,
264
265 /// Previously-tracked files that have been (re)moved with an hg command
261 pub removed: Vec<HgPathCow<'a>>,
266 pub removed: Vec<HgPathCow<'a>>,
267
268 /// (Still) tracked files that are missing, (re)moved with an non-hg
269 /// command
262 pub deleted: Vec<HgPathCow<'a>>,
270 pub deleted: Vec<HgPathCow<'a>>,
271
272 /// Tracked files that are up to date with the parent.
273 /// Only pupulated if `StatusOptions::list_clean` is true.
263 pub clean: Vec<HgPathCow<'a>>,
274 pub clean: Vec<HgPathCow<'a>>,
275
276 /// Files in the working directory that are ignored with `.hgignore`.
277 /// Only pupulated if `StatusOptions::list_ignored` is true.
264 pub ignored: Vec<HgPathCow<'a>>,
278 pub ignored: Vec<HgPathCow<'a>>,
279
280 /// Files in the working directory that are neither tracked nor ignored.
281 /// Only pupulated if `StatusOptions::list_unknown` is true.
265 pub unknown: Vec<HgPathCow<'a>>,
282 pub unknown: Vec<HgPathCow<'a>>,
283
284 /// Was explicitly matched but cannot be found/accessed
266 pub bad: Vec<(HgPathCow<'a>, BadMatch)>,
285 pub bad: Vec<(HgPathCow<'a>, BadMatch)>,
286
267 /// Either clean or modified, but we can’t tell from filesystem metadata
287 /// Either clean or modified, but we can’t tell from filesystem metadata
268 /// alone. The file contents need to be read and compared with that in
288 /// alone. The file contents need to be read and compared with that in
269 /// the parent.
289 /// the parent.
270 pub unsure: Vec<HgPathCow<'a>>,
290 pub unsure: Vec<HgPathCow<'a>>,
291
271 /// Only filled if `collect_traversed_dirs` is `true`
292 /// Only filled if `collect_traversed_dirs` is `true`
272 pub traversed: Vec<HgPathBuf>,
293 pub traversed: Vec<HgPathBuf>,
273 }
294 }
General Comments 0
You need to be logged in to leave comments. Login now