1 //! Auto-generate stub docs for the unstable book
3 use std::collections::BTreeSet;
5 use std::fs::{self, File};
8 use tidy::features::{collect_lang_features, collect_lib_features, Features};
9 use tidy::unstable_book::{
10 collect_unstable_book_section_file_names, collect_unstable_feature_names, LANG_FEATURES_DIR,
11 LIB_FEATURES_DIR, PATH_STR,
14 /// A helper macro to `unwrap` a result except also print out details like:
16 /// * The file/line of the panic
17 /// * The expression that failed
18 /// * The error itself
23 Err(e) => panic!("{} failed with {}", stringify!($e), e),
28 fn generate_stub_issue(path: &Path, name: &str, issue: u32) {
29 let mut file = t!(File::create(path));
30 t!(write!(file, include_str!("stub-issue.md"), name = name, issue = issue));
33 fn generate_stub_no_issue(path: &Path, name: &str) {
34 let mut file = t!(File::create(path));
35 t!(write!(file, include_str!("stub-no-issue.md"), name = name));
38 fn set_to_summary_str(set: &BTreeSet<String>, dir: &str) -> String {
40 .map(|ref n| format!(" - [{}]({}/{}.md)", n.replace('-', "_"), dir, n))
41 .fold("".to_owned(), |s, a| s + &a + "\n")
44 fn generate_summary(path: &Path, lang_features: &Features, lib_features: &Features) {
45 let compiler_flags = collect_unstable_book_section_file_names(&path.join("src/compiler-flags"));
47 let compiler_flags_str = set_to_summary_str(&compiler_flags, "compiler-flags");
49 let unstable_lang_features = collect_unstable_feature_names(&lang_features);
50 let unstable_lib_features = collect_unstable_feature_names(&lib_features);
52 let lang_features_str = set_to_summary_str(&unstable_lang_features, "language-features");
53 let lib_features_str = set_to_summary_str(&unstable_lib_features, "library-features");
55 let mut file = t!(File::create(&path.join("src/SUMMARY.md")));
56 t!(file.write_fmt(format_args!(
57 include_str!("SUMMARY.md"),
58 compiler_flags = compiler_flags_str,
59 language_features = lang_features_str,
60 library_features = lib_features_str
64 fn generate_unstable_book_files(src: &Path, out: &Path, features: &Features) {
65 let unstable_features = collect_unstable_feature_names(features);
66 let unstable_section_file_names = collect_unstable_book_section_file_names(src);
67 t!(fs::create_dir_all(&out));
68 for feature_name in &unstable_features - &unstable_section_file_names {
69 let feature_name_underscore = feature_name.replace('-', "_");
70 let file_name = format!("{feature_name}.md");
71 let out_file_path = out.join(&file_name);
72 let feature = &features[&feature_name_underscore];
74 if let Some(issue) = feature.tracking_issue {
75 generate_stub_issue(&out_file_path, &feature_name_underscore, issue.get());
77 generate_stub_no_issue(&out_file_path, &feature_name_underscore);
82 fn copy_recursive(from: &Path, to: &Path) {
83 for entry in t!(fs::read_dir(from)) {
85 let t = t!(e.metadata());
86 let dest = &to.join(e.file_name());
88 t!(fs::copy(&e.path(), dest));
89 } else if t.is_dir() {
90 t!(fs::create_dir_all(dest));
91 copy_recursive(&e.path(), dest);
97 let library_path_str = env::args_os().nth(1).expect("library/ path required");
98 let compiler_path_str = env::args_os().nth(2).expect("compiler/ path required");
99 let src_path_str = env::args_os().nth(3).expect("src/ path required");
100 let dest_path_str = env::args_os().nth(4).expect("destination path required");
101 let library_path = Path::new(&library_path_str);
102 let compiler_path = Path::new(&compiler_path_str);
103 let src_path = Path::new(&src_path_str);
104 let dest_path = Path::new(&dest_path_str);
106 let lang_features = collect_lang_features(compiler_path, &mut false);
107 let lib_features = collect_lib_features(library_path)
109 .filter(|&(ref name, _)| !lang_features.contains_key(name))
112 let doc_src_path = src_path.join(PATH_STR);
114 t!(fs::create_dir_all(&dest_path));
116 generate_unstable_book_files(
117 &doc_src_path.join(LANG_FEATURES_DIR),
118 &dest_path.join(LANG_FEATURES_DIR),
121 generate_unstable_book_files(
122 &doc_src_path.join(LIB_FEATURES_DIR),
123 &dest_path.join(LIB_FEATURES_DIR),
127 copy_recursive(&doc_src_path, &dest_path);
129 generate_summary(&dest_path, &lang_features, &lib_features);