add a --chapter option to mdbook test. #1741

clovett · 2022-02-09T21:48:47Z

Sometimes when working on large books it is handy to be able to run mdbook on a single chapter of a book. For example:

mdbook test --chapter build

mdbook test --chapter build
2022-02-09 13:48:17 [INFO] (mdbook::book): Skipping chapter 'Introduction'...
2022-02-09 13:48:17 [INFO] (mdbook::book): Skipping chapter 'Installation'...
2022-02-09 13:48:17 [INFO] (mdbook::book): Skipping chapter 'Reading Books'...
2022-02-09 13:48:17 [INFO] (mdbook::book): Skipping chapter 'Creating a Book'...
2022-02-09 13:48:17 [INFO] (mdbook::book): Skipping chapter 'Command Line Tool'...
2022-02-09 13:48:17 [INFO] (mdbook::book): Skipping chapter 'init'...
2022-02-09 13:48:17 [INFO] (mdbook::book): Testing chapter 'build': "d:\\git\\clovett\\mdBook\\guide\\src\\cli/build.md"
2022-02-09 13:48:17 [INFO] (mdbook::book): Skipping chapter 'watch'...
2022-02-09 13:48:17 [INFO] (mdbook::book): Skipping chapter 'serve'...
2022-02-09 13:48:17 [INFO] (mdbook::book): Skipping chapter 'test'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'clean'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'completions'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Format'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'SUMMARY.md'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Configuration'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'General'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Preprocessors'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Renderers'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Environment Variables'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Theme'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'index.hbs'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Syntax highlighting'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Editor'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'MathJax Support'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'mdBook-specific features'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Markdown'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Continuous Integration'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'For Developers'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Preprocessors'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Alternative Backends'...
2022-02-09 13:48:18 [INFO] (mdbook::book): Skipping chapter 'Contributors'...
```

…ic to the name of the rustdoc tool.

ehuss

Thanks! This seems like it could be useful.

I'd like to suggest that perhaps the -c flag could take either a chapter name or file path. In most cases, I know the file path but not the chapter name. File paths also support command-line completion, whereas chapter names need to be typed exactly (and deal with shell quoting and such).

Can you also update the documentation at https://github.com/rust-lang/mdBook/blob/master/guide/src/cli/test.md?

src/book/mod.rs

ehuss · 2022-03-27T23:45:19Z

src/theme/index.hbs

+                if (theme && theme.startsWith('"') && theme.endsWith('"')) {
                    localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
                }

-                if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
+                if (sidebar && sidebar.startsWith('"') && sidebar.endsWith('"')) {


These changes seem unrelated to the PR?

they were null reference bugs I ran into while testing this PR.

I would prefer unrelated changes to not be included.

this is a bit different as I couldn't get the tests to pass without this.

Which tests aren't passing? What kind of errors are you seeing? I don't believe there are any javascript tests, so it is not clear to me how this could have any impact on anything.

Hmmm, trying to repro it I can't find it any more and I see there's a try{ } catch (e) { } around this whole thing, so it's possible I caught the exception in the debugger and mistook it for a bug when it was expecting the try/catch block to catch it and continue. So I reverted these changes.

lovettchris · 2022-05-03T00:13:59Z

I'd like to suggest that perhaps the -c flag could take either a chapter name or file path. In most cases, I know the file path but not the chapter name. File paths also support command-line completion, whereas chapter names need to be typed exactly (and deal with shell quoting and such).

Done.

ehuss · 2022-07-16T19:02:45Z

@clovett Just checking in if you are still interested in this. It looks like there are some test failures.

lovettchris · 2022-08-01T18:18:17Z

I am still interested in this PR, but I'm kinda stumped by the test failures. Clearly the test output changes, and I tried to fix that, but I'm not sure why it didn't work.

ehuss · 2022-08-01T22:39:26Z

The PR changes the output to use chapter_path instead of path. path is absolute whereas chapter_path is relative. That means that the pattern Testing chapter [^:]*: "([^"]+)[\\/]README.md needs to be updated, as there is no leading slash in front of the README.md file.

lovettchris · 2022-08-01T23:38:50Z

The PR changes the output to use chapter_path instead of path. path is absolute whereas chapter_path is relative. That means that the pattern Testing chapter [^:]*: "([^"]+)[\\/]README.md needs to be updated, as there is no leading slash in front of the README.md file.

Ah, thanks for the hint - I think I got it now.

clovett · 2022-08-04T05:56:24Z

@ehuss - yay the tests are passing.

ehuss

I think this will need some tests.

Also, can you add some kind of error message if the --chapter value doesn't match anything?

ehuss · 2022-08-09T19:30:57Z

src/book/mod.rs

-    /// Run `rustdoc` tests on the book, linking against the provided libraries.
-    pub fn test(&mut self, library_paths: Vec<&str>) -> Result<()> {
+    /// Run `rustdoc` tests on the book, linking against the provided libraries
+    /// and optionally testing only a signal named chapter while skipping the others.


Suggested change

/// and optionally testing only a signal named chapter while skipping the others.

/// and optionally testing only a single named chapter while skipping the others.

ehuss · 2022-08-09T19:32:21Z

src/book/mod.rs

-    pub fn test(&mut self, library_paths: Vec<&str>) -> Result<()> {
+    /// Run `rustdoc` tests on the book, linking against the provided libraries
+    /// and optionally testing only a signal named chapter while skipping the others.
+    pub fn test(&mut self, library_paths: Vec<&str>, chapter: Option<&str>) -> Result<()> {


Unfortunately we can't change the API as that would be a semver breaking change.

I think you will need to add a new method, and have the old test call it.

done, I added "test_chapter", but instead of duplicating the code I just make test call test_chapter and I added a couple new tests for "test_chapter".

ehuss · 2022-08-09T19:41:36Z

src/book/mod.rs

+                if chapter.is_some()
+                    && ch.name != chapter.unwrap()
+                    && chapter_path.to_str().unwrap() != chapter.unwrap()


I'd prefer to avoid using unwrap here. Perhaps more like this:

Suggested change

if chapter.is_some()

&& ch.name != chapter.unwrap()

&& chapter_path.to_str().unwrap() != chapter.unwrap()

if let Some(chapter) = chapter {

if ch.name != chapter && chapter_path.to_str() != Some(chapter) {

However, this logic seems wrong. It seems to require that the --chapter value passed in equals both the chapter name and its filename. I would expect it to match one or the other. Perhaps something more like?

!(ch.name == chapter || chapter_path.to_str() == Some(chapter))

it works, notice this is the inverse of the test !(ch.name == chapter || chapter_path == chapter)

ehuss · 2022-08-09T19:42:55Z

src/theme/index.hbs

+                if (theme && theme.startsWith('"') && theme.endsWith('"')) {
                    localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
                }

-                if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
+                if (sidebar && sidebar.startsWith('"') && sidebar.endsWith('"')) {


I would prefer unrelated changes to not be included.

test: add unit tests for test_chapter

lovettchris · 2022-08-11T00:17:19Z

Can you also update the documentation at https://github.com/rust-lang/mdBook/blob/master/guide/src/cli/test.md?

I added:

--chapter

The --chapter (-c) option allows you to test a specific chapter of the
book using the chapter name or the relative path to the chapter.

ehuss · 2022-08-13T18:50:59Z

src/book/mod.rs

+                if chapter_name != "" && ch.name != chapter_name && cp != chapter_name {
+                    info!("Skipping chapter '{}'...", ch.name);


This all seemed to have reverted back to using an empty string as a sentinel instead of an Option. Is there any particular reason for that?

sorry this might be my Rust ignorance, I couldn't figure out how to compare chapter : Option<&str> and ch.name: String. Rust complains: "can't compare std::string::String with std::option::Option<&str>". So, moving them both to &str solved the problem, but I guess I could instead convert ch.name to Option<&str> using:

let cn: Option<&str> = Some(&ch.name);

I pushed this change to see if this is what you prefer...

ehuss · 2022-08-13T18:51:39Z

src/book/mod.rs

+        self.test_chapter(library_paths, None)
+    }
+
+    /// Run `rustdoc` tests on a specific chapter of the book, linking against the provided libraries.


This is a little unclear to me on what happens if chapter is None. Can it include a little more explanation?

Sure thing, I added clarifying comments // test_chapter with chapter:None will run all tests. and on the test_chapter function itself the doc comment: /// If chapterisNone, all tests will be run.

…r names.

…vett/chapters

lovettchris · 2022-08-17T17:45:24Z

@ehuss I think I resolved all the excellent issues you raised.

ehuss

Thanks! Just some code style suggestions.

ehuss · 2022-08-24T19:31:39Z

src/book/mod.rs

+                let cp = chapter_path.to_str();
+                let cn: Option<&str> = Some(&ch.name);
+
+                if chapter.is_some() && cn != chapter && cp != chapter {
+                    info!("Skipping chapter '{}'...", ch.name);
+                    continue;
+                };


Instead of using local variables like this, I still think it would be clearer to use something like the suggestion I posted before. The local variables create an indirection where you then have to refer to other parts of the code to figure out what they mean. Using the values directly I think makes it a little clearer as to what is being checked.

Also, after testing this out a bit, I feel like the output is overwhelmed with the "skipping chapter" text. I'm thinking it might be better to reduce that to a debug message to reduce the noise.

Perhaps something like this:

Suggested change

let cp = chapter_path.to_str();

let cn: Option<&str> = Some(&ch.name);

if chapter.is_some() && cn != chapter && cp != chapter {

info!("Skipping chapter '{}'...", ch.name);

continue;

};

if let Some(chapter) = chapter {

if ch.name != chapter && chapter_path.to_str() != Some(chapter) {

debug!("Skipping chapter '{}'...", ch.name);

continue;

}

}

The skipping chapter prompts are how you find the chapter names so you can write mdbook test -c ? for example then you find the chapter name you want to test and run the specific command. But I could make it so that it looks for the specific string "?" so it only prints in that case.

I pushed the if-check looking for command line arg "?" instead and I added that to the help text to make it discoverable.

Oh, and I see now how you are using if let Some to remove the need for local variables, so I pushed that fix too.

ehuss · 2022-08-24T19:34:43Z

src/book/mod.rs

+        if chapter.is_some() && !chapter_found {
+            bail!(format!("Chapter not found: {:?}", chapter));
+        }


This produces some strange output. Generally it is recommended to not use debug displays for user output. Also, the bail! macro can take formatted strings directly, there is no need to use format!. I think it might be better to extract the name through a pattern and use a display impl. Something like this:

Suggested change

if chapter.is_some() && !chapter_found {

bail!(format!("Chapter not found: {:?}", chapter));

}

if let Some(chapter) = chapter {

if !chapter_found {

bail!("Chapter not found: {}", chapter);

}

}

Much better thanks, I merged your fix. I was just copying the use of bail from a few lines earlier: bail!("One or more tests failed");, so unless there is a better error formatter available, I'll leave the bail as you have written it.

ehuss

Thanks!

…071 - 2025-09-21: Incorrect handling of embedded SVG and MathML leads to mutation XSS after removal) Summary: mdbook imports ammonia for which a vulnerability exist in v3, fortunately the current mdbook uses a fixed version so we can get rid of the vulnerability by upgrading its only dependant. # Changelog ## mdBook 0.4.52 [v0.4.51...v0.4.52](rust-lang/mdBook@v0.4.51...v0.4.52) **Note:** If you have a custom `index.hbs` theme file, it is recommended that you update it to the latest version to pick up the fixes in this release. ### Added - Added the ability to redirect `#` HTML fragments using the existing `output.html.redirect` table. [#2747](rust-lang/mdBook#2747) - Added the `rel="edit"` attribute to the edit page button. [#2702](rust-lang/mdBook#2702) ### Changed - The search index is now only loaded when the search input is opened instead of always being loaded. [#2553](rust-lang/mdBook#2553) [#2735](rust-lang/mdBook#2735) - The `mdbook serve` command has switched its underlying server library from warp to axum. [#2748](rust-lang/mdBook#2748) - Updated dependencies. [#2752](rust-lang/mdBook#2752) ### Fixed - The sidebar is now set to `display:none` when it is hidden in order to prevent the browser's search from thinking the sidebar's text is visible. [#2725](rust-lang/mdBook#2725) - Fixed search index URL not updating correctly when `hash-files` is enabled. [#2742](rust-lang/mdBook#2742) [#2746](rust-lang/mdBook#2746) - Fixed several sidebar animation bugs, particularly when manually resizing. [#2750](rust-lang/mdBook#2750) ## mdBook 0.4.51 [v0.4.50...v0.4.51](rust-lang/mdBook@v0.4.50...v0.4.51) ### Fixed - Fixed regression that broke the `S` search hotkey. [#2713](rust-lang/mdBook#2713) ## mdBook 0.4.50 [v0.4.49...v0.4.50](rust-lang/mdBook@v0.4.49...v0.4.50) ### Added - Added a keyboard shortcut help popup when pressing `?`. [#2608](rust-lang/mdBook#2608) ### Changed - Changed the look of the sidebar resize handle to match the new rustdoc format. [#2691](rust-lang/mdBook#2691) - `/` can now be used to open the search bar. [#2698](rust-lang/mdBook#2698) - Pressing enter from the search bar will navigate to the first entry. [#2698](rust-lang/mdBook#2698) - Updated `opener` to drop some dependencies. [#2709](rust-lang/mdBook#2709) - Updated dependencies, MSRV raised to 1.82. [#2711](rust-lang/mdBook#2711) ### Fixed - Fixed uncaught exception when pressing down when there are no search results. [#2698](rust-lang/mdBook#2698) - Fixed syntax highlighting of Rust code in the ACE editor. [#2710](rust-lang/mdBook#2710) ## mdBook 0.4.49 [v0.4.48...v0.4.49](rust-lang/mdBook@v0.4.48...v0.4.49) ### Added - Added a warning on unused fields in the root of `book.toml`. [#2622](rust-lang/mdBook#2622) ### Changed - Updated dependencies. [#2650](rust-lang/mdBook#2650) [#2688](rust-lang/mdBook#2688) - Updated minimum Rust version to 1.81. [#2688](rust-lang/mdBook#2688) - The unused `book.multilingual` field is no longer serialized, or shown in `mdbook init`. [#2689](rust-lang/mdBook#2689) - Speed up search index loading by using `JSON.parse` instead of parsing JavaScript. [#2633](rust-lang/mdBook#2633) ### Fixed - Search highlighting will not try to highlight in SVG `<text>` elements because it breaks the element. [#2668](rust-lang/mdBook#2668) - Fixed scrolling of the sidebar when a search highlight term is in the URL. [#2675](rust-lang/mdBook#2675) - Fixed issues when multiple footnote definitions use the same ID. Now, only one definition is used, and a warning is displayed. [#2681](rust-lang/mdBook#2681) - The sidebar is now restricted to 80% of the viewport width to make it possible to collapse it when the viewport is very narrow. [#2679](rust-lang/mdBook#2679) ## mdBook 0.4.48 [v0.4.47...v0.4.48](rust-lang/mdBook@v0.4.47...v0.4.48) ### Added - Footnotes now have back-reference links. These links bring the reader back to the original location. As part of this change, footnotes are now only rendered at the bottom of the page. This also includes some styling updates and fixes for footnote rendering. [#2626](rust-lang/mdBook#2626) - Added an "Auto" theme selection option which will default to the system-preferred mode. This will also automatically switch when the system changes the preferred mode. [#2576](rust-lang/mdBook#2576) ### Changed - The `searchindex.json` file has been removed; only the `searchindex.js` file will be generated. [#2552](rust-lang/mdBook#2552) - Updated Javascript code to use eslint. [#2554](rust-lang/mdBook#2554) - An error is generated if there are duplicate files in `SUMMARY.md`. [#2613](rust-lang/mdBook#2613) ## mdBook 0.4.47 [v0.4.46...v0.4.47](rust-lang/mdBook@v0.4.46...v0.4.47) ### Fixed - Fixed search not showing up in sub-directories. [#2586](rust-lang/mdBook#2586) ## mdBook 0.4.46 [v0.4.45...v0.4.46](rust-lang/mdBook@v0.4.45...v0.4.46) ### Changed - The `output.html.hash-files` config option has been added to add hashes to static filenames to bust any caches when a book is updated. `{{resource}}` template tags have been added so that links can be properly generated to those files. [#1368](rust-lang/mdBook#1368) ### Fixed - Playground links for Rust 2024 now set the edition correctly. [#2557](rust-lang/mdBook#2557) ## mdBook 0.4.45 [v0.4.44...v0.4.45](rust-lang/mdBook@v0.4.44...v0.4.45) ### Changed - Added context to error message when rustdoc is not found. [#2545](rust-lang/mdBook#2545) - Slightly changed the styling rules around margins of footnotes. [#2524](rust-lang/mdBook#2524) ### Fixed - Fixed an issue where it would panic if a source_path is not set. [#2550](rust-lang/mdBook#2550) ## mdBook 0.4.44 [v0.4.43...v0.4.44](rust-lang/mdBook@v0.4.43...v0.4.44) ### Added - Added pre-built aarch64-apple-darwin binaries to the releases. [#2500](rust-lang/mdBook#2500) - `mdbook clean` now shows a summary of what it did. [#2458](rust-lang/mdBook#2458) - Added the `output.html.search.chapter` config setting to disable search indexing of individual chapters. [#2533](rust-lang/mdBook#2533) ### Fixed - Fixed auto-scrolling the side-bar when loading a page with a `#` fragment URL. [#2517](rust-lang/mdBook#2517) - Fixed display of sidebar when javascript is disabled. [#2529](rust-lang/mdBook#2529) - Fixed the sidebar visibility getting out of sync with the button. [#2532](rust-lang/mdBook#2532) ### Changed - ❗ Rust code block hidden lines now follow the same logic as rustdoc. This requires a space after the `#` symbol. [#2530](rust-lang/mdBook#2530) - ❗ Updated the Linux pre-built binaries which requires a newer version of glibc (2.34). [#2523](rust-lang/mdBook#2523) - Updated dependencies [#2538](rust-lang/mdBook#2538) [#2539](rust-lang/mdBook#2539) ## mdBook 0.4.43 [v0.4.42...v0.4.43](rust-lang/mdBook@v0.4.42...v0.4.43) ### Fixed - Fixed setting the title in `mdbook init` when no git user is configured. [#2486](rust-lang/mdBook#2486) ### Changed - The Rust 2024 edition no longer needs `-Zunstable-options`. [#2495](rust-lang/mdBook#2495) ## mdBook 0.4.42 [v0.4.41...v0.4.42](rust-lang/mdBook@v0.4.41...v0.4.42) ### Fixed - Fixed chapter list folding. [#2473](rust-lang/mdBook#2473) ## mdBook 0.4.41 [v0.4.40...v0.4.41](rust-lang/mdBook@v0.4.40...v0.4.41) **Note:** If you have a custom `index.hbs` theme file, you will need to update it to the latest version. ### Added - Added preliminary support for Rust 2024 edition. [#2398](rust-lang/mdBook#2398) - Added a full example of the remove-emphasis preprocessor. [#2464](rust-lang/mdBook#2464) ### Changed - Adjusted styling of clipboard/play icons. [#2421](rust-lang/mdBook#2421) - Updated to handlebars v6. [#2416](rust-lang/mdBook#2416) - Attr and section rules now have specific code highlighting. [#2448](rust-lang/mdBook#2448) - The sidebar is now loaded from a common file, significantly reducing the book size when there are many chapters. [#2414](rust-lang/mdBook#2414) - Updated dependencies. [#2470](rust-lang/mdBook#2470) ### Fixed - Improved theme support when JavaScript is disabled. [#2454](rust-lang/mdBook#2454) - Fixed broken themes when localStorage has an invalid theme id. [#2463](rust-lang/mdBook#2463) - Adjusted the line-height of superscripts (and footnotes) to avoid adding extra space between lines. [#2465](rust-lang/mdBook#2465) ## mdBook 0.4.40 [v0.4.39...v0.4.40](rust-lang/mdBook@v0.4.39...v0.4.40) ### Fixed - Reverted the update to pulldown-cmark which broke the semver API. [#2388](rust-lang/mdBook#2388) ## mdBook 0.4.39 [v0.4.38...v0.4.39](rust-lang/mdBook@v0.4.38...v0.4.39) ### Fixed - Fixed the automatic deploy broken in the previous release. [#2383](rust-lang/mdBook#2383) ## mdBook 0.4.38 [v0.4.37...v0.4.38](rust-lang/mdBook@v0.4.37...v0.4.38) ### Added - Added `nix` to the default set of languages supported for syntax highlighting. [#2262](rust-lang/mdBook#2262) ### Changed - The `output.html.curly-quotes` option has been renamed to `output.html.smart-punctuation` to better reflect what it does. The old option `curly-quotes` is kept for compatibility, but may be removed in the future. [#2327](rust-lang/mdBook#2327) - The file-watcher used in `mdbook serve` and `mdbook watch` now uses a poll-based watcher instead of the native operating system notifications. This should fix issues on various systems and environments, and more accurately detect when files change. The native watcher can still be used with the `--watcher native` CLI option. [#2325](rust-lang/mdBook#2325) - `mdbook test` output now includes color, and shows relative paths to the source. [#2259](rust-lang/mdBook#2259) - Updated dependencies, MSRV raised to 1.74 [#2350](rust-lang/mdBook#2350) [#2351](rust-lang/mdBook#2351) [#2378](rust-lang/mdBook#2378) [#2381](rust-lang/mdBook#2381) ### Fixed - Reduced memory allocation when copying files. [#2355](rust-lang/mdBook#2355) - Fixed the horizontal divider in `SUMMARY.md` from being indented into the previous nested section. [#2364](rust-lang/mdBook#2364) - Removed unnecessary `import` in the CSS. [#2260](rust-lang/mdBook#2260) ## mdBook 0.4.37 [v0.4.36...v0.4.37](rust-lang/mdBook@v0.4.36...v0.4.37) ### Changed - ❗️ Updated the markdown parser. This brings in many changes to more closely follow the CommonMark spec. This may cause some small rendering changes. It is recommended to compare the output of the old and new version to check for changes. See <https://github.com/raphlinus/pulldown-cmark/releases/tag/v0.10.0> for more information. [#2308](rust-lang/mdBook#2308) - The warning about the legacy `src/theme` directory has been removed. [#2263](rust-lang/mdBook#2263) - Updated dependencies. MSRV raised to 1.71.0. [#2283](rust-lang/mdBook#2283) [#2293](rust-lang/mdBook#2293) [#2297](rust-lang/mdBook#2297) [#2310](rust-lang/mdBook#2310) [#2309](rust-lang/mdBook#2309) - Some internal performance/memory improvements. [#2273](rust-lang/mdBook#2273) [#2290](rust-lang/mdBook#2290) - Made the `pathdiff` dependency optional based on the `watch` feature. [#2291](rust-lang/mdBook#2291) ### Fixed - The `s` shortcut key handler should not trigger when focus is in an HTML form. [#2311](rust-lang/mdBook#2311) ## mdBook 0.4.36 [v0.4.35...v0.4.36](rust-lang/mdBook@v0.4.35...v0.4.36) ### Added - Added Nim to the default highlighted languages. [#2232](rust-lang/mdBook#2232) - Added a small indicator for the sidebar resize handle. [#2209](rust-lang/mdBook#2209) ### Changed - Updated dependencies. MSRV raised to 1.70.0. [#2173](rust-lang/mdBook#2173) [#2250](rust-lang/mdBook#2250) [#2252](rust-lang/mdBook#2252) ### Fixed - Fixed blank column in print page when the sidebar was visible. [#2235](rust-lang/mdBook#2235) - Fixed indentation of code blocks when Javascript is disabled. [#2162](rust-lang/mdBook#2162) - Fixed a panic when `mdbook serve` or `mdbook watch` were given certain kinds of paths. [#2229](rust-lang/mdBook#2229) ## mdBook 0.4.35 [v0.4.34...v0.4.35](rust-lang/mdBook@v0.4.34...v0.4.35) ### Added - Added the `book.text-direction` setting for explicit support for right-to-left languages. [#1641](rust-lang/mdBook#1641) - Added `rel=prefetch` to the "next" links to potentially improve browser performance. [#2168](rust-lang/mdBook#2168) - Added a `.warning` CSS class which is styled for displaying warning blocks. [#2187](rust-lang/mdBook#2187) ### Changed - Better support of the sidebar when JavaScript is disabled. [#2175](rust-lang/mdBook#2175) ## mdBook 0.4.34 [v0.4.33...v0.4.34](rust-lang/mdBook@v0.4.33...v0.4.34) ### Fixed - Fixed file change watcher failing on macOS with a large number of files. [#2157](rust-lang/mdBook#2157) ## mdBook 0.4.33 [v0.4.32...v0.4.33](rust-lang/mdBook@v0.4.32...v0.4.33) ### Added - The `color-scheme` CSS property is now set based on the light/dark theme, which applies some slight color differences in browser elements like scroll bars on some browsers. [#2134](rust-lang/mdBook#2134) ### Fixed - Fixed watching of extra-watch-dirs when not running in the book root directory. [#2146](rust-lang/mdBook#2146) - Reverted the dependency update to the `toml` crate (again!). This was an unintentional breaking change in 0.4.32. [#2021](rust-lang/mdBook#2021) - Changed macOS change notifications to use the kqueue implementation which should fix some issues with repeated rebuilds when a file changed. [#2152](rust-lang/mdBook#2152) - Don't set a background color in the print page for code blocks in a header. [#2150](rust-lang/mdBook#2150) ## mdBook 0.4.32 [v0.4.31...v0.4.32](rust-lang/mdBook@v0.4.31...v0.4.32) ### Fixed - Fixed theme-color meta tag not syncing with the theme. [#2118](rust-lang/mdBook#2118) ### Changed - Updated all dependencies. [#2121](rust-lang/mdBook#2121) [#2122](rust-lang/mdBook#2122) [#2123](rust-lang/mdBook#2123) [#2124](rust-lang/mdBook#2124) [#2125](rust-lang/mdBook#2125) [#2126](rust-lang/mdBook#2126) ## mdBook 0.4.31 [v0.4.30...v0.4.31](rust-lang/mdBook@v0.4.30...v0.4.31) ### Fixed - Fixed menu border render flash during page navigation. [#2101](rust-lang/mdBook#2101) - Fixed flicker setting sidebar scroll position. [#2104](rust-lang/mdBook#2104) - Fixed compile error with proc-macro2 on latest Rust nightly. [#2109](rust-lang/mdBook#2109) ## mdBook 0.4.30 [v0.4.29...v0.4.30](rust-lang/mdBook@v0.4.29...v0.4.30) ### Added - Added support for heading attributes. Attributes are specified in curly braces just after the heading text. An HTML ID can be specified with `#` and classes with `.`. For example: `## My heading {#custom-id .class1 .class2}` [#2013](rust-lang/mdBook#2013) - Added support for hidden code lines for languages other than Rust. The `output.html.code.hidelines` table allows you to define the prefix character that will be used to hide code lines based on the language. [#2093](rust-lang/mdBook#2093) ### Fixed - Fixed a few minor markdown rendering issues. [#2092](rust-lang/mdBook#2092) ## mdBook 0.4.29 [v0.4.28...v0.4.29](rust-lang/mdBook@v0.4.28...v0.4.29) ### Changed - Built-in fonts are no longer copied when `fonts/fonts.css` is overridden in the theme directory. Additionally, the warning about `copy-fonts` has been removed if `fonts/fonts.css` is specified. [#2080](rust-lang/mdBook#2080) - `mdbook init --force` now skips all interactive prompts as intended. [#2057](rust-lang/mdBook#2057) - Updated dependencies [#2063](rust-lang/mdBook#2063) [#2086](rust-lang/mdBook#2086) [#2082](rust-lang/mdBook#2082) [#2084](rust-lang/mdBook#2084) [#2085](rust-lang/mdBook#2085) ### Fixed - Switched from the `gitignore` library to `ignore`. This should bring some improvements with gitignore handling. [#2076](rust-lang/mdBook#2076) ## mdBook 0.4.28 [v0.4.27...v0.4.28](rust-lang/mdBook@v0.4.27...v0.4.28) ### Changed - The sidebar is now shown on wide screens when localstorage is disabled. [#2017](rust-lang/mdBook#2017) - Preprocessors are now run with `mdbook test`. [#1986](rust-lang/mdBook#1986) ### Fixed - Fixed regression in 0.4.26 that prevented the title bar from scrolling properly on smaller screens. [#2039](rust-lang/mdBook#2039) ## mdBook 0.4.27 [v0.4.26...v0.4.27](rust-lang/mdBook@v0.4.26...v0.4.27) ### Changed - Reverted the dependency update to the `toml` crate. This was an unintentional breaking change in 0.4.26. [#2021](rust-lang/mdBook#2021) ## mdBook 0.4.26 [v0.4.25...v0.4.26](rust-lang/mdBook@v0.4.25...v0.4.26) **The 0.4.26 release has been yanked due to an unintentional breaking change.** ### Changed - Removed custom scrollbars for webkit browsers [#1961](rust-lang/mdBook#1961) - Updated some dependencies [#1998](rust-lang/mdBook#1998) [#2009](rust-lang/mdBook#2009) [#2011](rust-lang/mdBook#2011) - Fonts are now part of the theme. The `output.html.copy-fonts` option has been deprecated. To define custom fonts, be sure to define `theme/fonts.css`. [#1987](rust-lang/mdBook#1987) ### Fixed - Fixed overflow viewport issue with mobile Safari [#1994](rust-lang/mdBook#1994) ## mdBook 0.4.25 [e14d381...1ba74a3](rust-lang/mdBook@e14d381...1ba74a3) ### Fixed - Fixed a regression where `mdbook test -L deps path-to-book` would not work. [#1959](rust-lang/mdBook#1959) ## mdBook 0.4.24 [eb77083...8767ebf](rust-lang/mdBook@eb77083...8767ebf) ### Fixed - The precompiled linux-gnu mdbook binary available on [GitHub Releases](https://github.com/rust-lang/mdBook/releases) inadvertently switched to a newer version of glibc. This release goes back to an older version that should be more compatible on older versions of Linux. [#1955](rust-lang/mdBook#1955) ## mdBook 0.4.23 [678b469...68a75da](rust-lang/mdBook@678b469...68a75da) ### Changed - Updated all dependencies [#1951](rust-lang/mdBook#1951) [#1952](rust-lang/mdBook#1952) [#1844](rust-lang/mdBook#1844) - Updated minimum Rust version to 1.60. [#1951](rust-lang/mdBook#1951) ### Fixed - Fixed a regression where playground code was missing hidden lines, preventing it from compiling correctly. [#1950](rust-lang/mdBook#1950) ## mdBook 0.4.22 [40c06f5...4844f72](rust-lang/mdBook@40c06f5...4844f72) ### Added - Added a `--chapter` option to `mdbook test` to specify a specific chapter to test. [#1741](rust-lang/mdBook#1741) - Added CSS styling for `<kbd>` tags. [#1906](rust-lang/mdBook#1906) - Added pre-compiled binaries for `x86_64-unknown-linux-musl` and `aarch64-unknown-linux-musl` (see [Releases](https://github.com/rust-lang/mdBook/releases)). [#1862](rust-lang/mdBook#1862) - Added `build.extra-watch-dirs` which is an array of additional directories to watch for changes when running `mdbook serve`. [#1884](rust-lang/mdBook#1884) ### Changed - Removed the `type="text/javascript"` attribute from `<script>` tags. [#1881](rust-lang/mdBook#1881) - Switched to building with Rust Edition 2021. This raises the minimum supported Rust version to 1.56. [#1887](rust-lang/mdBook#1887) - When hidden code is hidden, the hidden parts are no longer copied to the clipboard via the copy button. [#1911](rust-lang/mdBook#1911) - Various HTML changes and fixes to be more compliant with HTML5. [#1924](rust-lang/mdBook#1924) - The theme picker now shows which theme is currently selected. [#1935](rust-lang/mdBook#1935) ### Fixed - Avoid blank line at the end of an ACE code block [#1836](rust-lang/mdBook#1836) Reviewed By: kuecks Differential Revision: D83200549 fbshipit-source-id: 55b4adb5f5c9588c9b2b772f1b82909afe8c03cd

clovett added 4 commits February 9, 2022 13:45

add a --chapter option to mdbook test.

f0189cd

fix unit tests

4d78119

fix expected output

bf6d452

move command line parsing code and make test output comparison agnost…

71e490d

…ic to the name of the rustdoc tool.

ehuss reviewed Mar 27, 2022

View reviewed changes

ehuss added the S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. label Apr 15, 2022

clovett added 2 commits May 2, 2022 17:11

Merge branch 'master' into clovett/chapters

6e3d275

CR feedback, switch to Option<&str> for chatper parameter.

99a8c0d

Fix tests

f1c07b0

Merge branch 'master' into clovett/chapters

ed0ee85

fix: unit test expected output has changed.

96245d2

fix: fmt --check

7c55869

clovett requested a review from ehuss August 4, 2022 05:55

ehuss reviewed Aug 9, 2022

View reviewed changes

lovettchris and others added 2 commits August 10, 2022 17:06

fix: add test_chapter method so test can remain api compatible.

0926c52

test: add unit tests for test_chapter

doc: add documentation of new --chapter option.

05ed667

clovett added 2 commits August 10, 2022 17:17

doc: fix typo.

601b6df

fix: remove redundant check.

20cca38

ehuss reviewed Aug 13, 2022

View reviewed changes

clovett added 4 commits August 15, 2022 12:56

doc: add clarifying comments.

5ec488c

Merge branch 'master' into clovett/chapters

9172005

fix: revert changes from code review.

c1004f7

fix: cr feedback no need to unwrap Option<&str> when comparing chapte…

e979012

…r names.

Merge branch 'clovett/chapters' of github.com:clovett/mdBook into clo…

d383ae0

…vett/chapters

ehuss reviewed Aug 24, 2022

View reviewed changes

clovett added 2 commits August 24, 2022 13:25

fix: code review comments.

4ead38f

fix: code review cleanup

1747094

ehuss approved these changes Aug 26, 2022

View reviewed changes

ehuss merged commit 74eb405 into rust-lang:master Aug 26, 2022

lovettchris mentioned this pull request Sep 2, 2022

rebase on latest mdbook from https://github.com/rust-lang/mdBook leanprover/mdBook#12

Closed

	/// and optionally testing only a signal named chapter while skipping the others.
	/// and optionally testing only a single named chapter while skipping the others.

		if chapter_name != "" && ch.name != chapter_name && cp != chapter_name {
		info!("Skipping chapter '{}'...", ch.name);

-        if chapter.is_some() && !chapter_found {
-            bail!(format!("Chapter not found: {:?}", chapter));
-        }
+        if let Some(chapter) = chapter {
+            if !chapter_found {
+                bail!("Chapter not found: {}", chapter);
+            }
+        }

add a --chapter option to mdbook test. #1741

add a --chapter option to mdbook test. #1741

Uh oh!

Conversation

clovett commented Feb 9, 2022

Uh oh!

ehuss left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lovettchris commented May 3, 2022

Uh oh!

ehuss commented Jul 16, 2022

Uh oh!

lovettchris commented Aug 1, 2022

Uh oh!

ehuss commented Aug 1, 2022

Uh oh!

lovettchris commented Aug 1, 2022

Uh oh!

clovett commented Aug 4, 2022

Uh oh!

ehuss left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lovettchris Aug 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lovettchris commented Aug 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

--chapter

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lovettchris commented Aug 17, 2022

Uh oh!

ehuss left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

lovettchris Aug 11, 2022 •

edited

Loading

lovettchris commented Aug 11, 2022 •

edited

Loading