Merge pull request #2442 from sylvestre/doc

Document the source documentation + document some modules

DEVELOPER_INSTRUCTIONS.md

@@ -1,3 +1,14 @@
+Documentation
+-------------
+
+The source of the documentation is available on:
+
+https://uutils.github.io/coreutils-docs/coreutils/
+
+The documentation is updated everyday on this repository:
+
+https://github.com/uutils/coreutils-docs
+
 Code Coverage Report Generation
 ---------------------------------
 

src/uucore/src/lib/features/fs.rs

@@ -6,6 +6,8 @@
 // For the full copyright and license information, please view the LICENSE
 // file that was distributed with this source code.
 
+//! Set of functions to manage files and symlinks
+
 #[cfg(unix)]
 use libc::{
     mode_t, S_IFBLK, S_IFCHR, S_IFDIR, S_IFIFO, S_IFLNK, S_IFMT, S_IFREG, S_IFSOCK, S_IRGRP,

src/uucore/src/lib/features/fsext.rs

@@ -7,6 +7,8 @@
 // For the full copyright and license information, please view the LICENSE file
 // that was distributed with this source code.
 
+//! Set of functions to manage file systems
+
 // spell-checker:ignore (arch) bitrig ; (fs) cifs smbfs
 
 extern crate time;

src/uucore/src/lib/features/mode.rs

@@ -5,6 +5,8 @@
 // For the full copyright and license information, please view the LICENSE
 // file that was distributed with this source code.
 
+//! Set of functions to parse modes
+
 // spell-checker:ignore (vars) fperm srwx
 
 use libc::{mode_t, S_IRGRP, S_IROTH, S_IRUSR, S_IWGRP, S_IWOTH, S_IWUSR};

src/uucore/src/lib/features/perms.rs

@@ -3,6 +3,8 @@
 // For the full copyright and license information, please view the LICENSE
 // file that was distributed with this source code.
 
+//! Common functions to manage permissions
+
 use crate::error::UResult;
 pub use crate::features::entries;
 use crate::fs::resolve_relative_path;

src/uucore/src/lib/features/process.rs

@@ -9,6 +9,8 @@
 // spell-checker:ignore (vars) cvar exitstatus
 // spell-checker:ignore (sys/unix) WIFSIGNALED
 
+//! Set of functions to manage IDs
+
 use libc::{gid_t, pid_t, uid_t};
 use std::fmt;
 use std::io;