mirror of
https://github.com/RGBCube/uutils-coreutils
synced 2025-07-28 11:37:44 +00:00
mdbook docs
This commit is contained in:
parent
4b79419514
commit
951035e49c
6 changed files with 129 additions and 0 deletions
|
@ -389,3 +389,7 @@ unix_socket = "0.5.0"
|
||||||
[[bin]]
|
[[bin]]
|
||||||
name = "coreutils"
|
name = "coreutils"
|
||||||
path = "src/bin/coreutils.rs"
|
path = "src/bin/coreutils.rs"
|
||||||
|
|
||||||
|
[[bin]]
|
||||||
|
name = "uudoc"
|
||||||
|
path = "src/bin/uudoc.rs"
|
||||||
|
|
1
docs/docs/.gitignore
vendored
Normal file
1
docs/docs/.gitignore
vendored
Normal file
|
@ -0,0 +1 @@
|
||||||
|
book
|
6
docs/docs/book.toml
Normal file
6
docs/docs/book.toml
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
[book]
|
||||||
|
authors = ["Terts Diepraam"]
|
||||||
|
language = "en"
|
||||||
|
multilingual = false
|
||||||
|
src = "src"
|
||||||
|
title = "Uutils Documentation"
|
3
docs/docs/src/SUMMARY.md
Normal file
3
docs/docs/src/SUMMARY.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Summary
|
||||||
|
|
||||||
|
- [Chapter 1](./chapter_1.md)
|
1
docs/docs/src/chapter_1.md
Normal file
1
docs/docs/src/chapter_1.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# Chapter 1
|
114
src/bin/uudoc.rs
Normal file
114
src/bin/uudoc.rs
Normal file
|
@ -0,0 +1,114 @@
|
||||||
|
// This file is part of the uutils coreutils package.
|
||||||
|
//
|
||||||
|
// (c) Michael Gehring <mg@ebfe.org>
|
||||||
|
//
|
||||||
|
// For the full copyright and license information, please view the LICENSE
|
||||||
|
// file that was distributed with this source code.
|
||||||
|
|
||||||
|
use clap::App;
|
||||||
|
use clap::Arg;
|
||||||
|
use clap::Shell;
|
||||||
|
use std::cmp;
|
||||||
|
use std::collections::hash_map::HashMap;
|
||||||
|
use std::ffi::OsStr;
|
||||||
|
use std::ffi::OsString;
|
||||||
|
use std::io::{self, Write};
|
||||||
|
use std::path::{Path, PathBuf};
|
||||||
|
use std::process;
|
||||||
|
use uucore::display::Quotable;
|
||||||
|
|
||||||
|
const VERSION: &str = env!("CARGO_PKG_VERSION");
|
||||||
|
|
||||||
|
include!(concat!(env!("OUT_DIR"), "/uutils_map.rs"));
|
||||||
|
|
||||||
|
fn usage<T>(utils: &UtilityMap<T>, name: &str) {
|
||||||
|
println!("{} {}\n", name, VERSION);
|
||||||
|
println!("Generate markdown documentation for uutils");
|
||||||
|
println!("Usage: {} [util]\n", name);
|
||||||
|
println!("Currently defined functions:\n");
|
||||||
|
#[allow(clippy::map_clone)]
|
||||||
|
let mut utils: Vec<&str> = utils.keys().map(|&s| s).collect();
|
||||||
|
utils.sort_unstable();
|
||||||
|
let display_list = utils.join(", ");
|
||||||
|
let width = cmp::min(textwrap::termwidth(), 100) - 4 * 2; // (opinion/heuristic) max 100 chars wide with 4 character side indentions
|
||||||
|
println!(
|
||||||
|
"{}",
|
||||||
|
textwrap::indent(&textwrap::fill(&display_list, width), " ")
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn binary_path(args: &mut impl Iterator<Item = OsString>) -> PathBuf {
|
||||||
|
match args.next() {
|
||||||
|
Some(ref s) if !s.is_empty() => PathBuf::from(s),
|
||||||
|
_ => std::env::current_exe().unwrap(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn name(binary_path: &Path) -> &str {
|
||||||
|
binary_path.file_stem().unwrap().to_str().unwrap()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
uucore::panic::mute_sigpipe_panic();
|
||||||
|
|
||||||
|
let utils = util_map();
|
||||||
|
let mut args = uucore::args_os();
|
||||||
|
|
||||||
|
let binary = binary_path(&mut args);
|
||||||
|
let binary_as_util = name(&binary);
|
||||||
|
|
||||||
|
// binary name equals util name?
|
||||||
|
if let Some(&(uumain, _)) = utils.get(binary_as_util) {
|
||||||
|
process::exit(uumain((vec![binary.into()].into_iter()).chain(args)));
|
||||||
|
}
|
||||||
|
|
||||||
|
// binary name equals prefixed util name?
|
||||||
|
// * prefix/stem may be any string ending in a non-alphanumeric character
|
||||||
|
let util_name = if let Some(util) = utils.keys().find(|util| {
|
||||||
|
binary_as_util.ends_with(*util)
|
||||||
|
&& !(&binary_as_util[..binary_as_util.len() - (*util).len()])
|
||||||
|
.ends_with(char::is_alphanumeric)
|
||||||
|
}) {
|
||||||
|
// prefixed util => replace 0th (aka, executable name) argument
|
||||||
|
Some(OsString::from(*util))
|
||||||
|
} else {
|
||||||
|
// unmatched binary name => regard as multi-binary container and advance argument list
|
||||||
|
uucore::set_utility_is_second_arg();
|
||||||
|
args.next()
|
||||||
|
};
|
||||||
|
|
||||||
|
// 0th argument equals util name?
|
||||||
|
if let Some(util_os) = util_name {
|
||||||
|
fn not_found(util: &OsStr) -> ! {
|
||||||
|
println!("{}: function/utility not found", util.maybe_quote());
|
||||||
|
process::exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
let util = match util_os.to_str() {
|
||||||
|
Some(util) => util,
|
||||||
|
None => not_found(&util_os),
|
||||||
|
};
|
||||||
|
|
||||||
|
match utils.get(util) {
|
||||||
|
Some(&(uumain, app)) => {
|
||||||
|
print_markdown(app);
|
||||||
|
}
|
||||||
|
None => {
|
||||||
|
if util == "--help" || util == "-h" {
|
||||||
|
usage(&utils, binary_as_util);
|
||||||
|
process::exit(0);
|
||||||
|
} else {
|
||||||
|
not_found(&util_os);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// no arguments provided
|
||||||
|
usage(&utils, binary_as_util);
|
||||||
|
process::exit(0);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn print_markdown(app: &App) {
|
||||||
|
for arg in app.get_arguments() {}
|
||||||
|
}
|
Loading…
Add table
Add a link
Reference in a new issue