Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

mdbook build flag that doesn't implicitly create files and errors if bad path in SUMMARY.md #253

Closed
frewsxcv opened this issue Apr 17, 2017 · 3 comments
Closed

mdbook build flag that doesn't implicitly create files and errors if bad path in SUMMARY.md #253

frewsxcv opened this issue Apr 17, 2017 · 3 comments

Comments

@frewsxcv
Copy link
Member

For rustc's CI, we set the filesystem to be mostly read-only. If a rustc docs contributor accidentally adds in an invalid path, we get these obscure read-only errors because mdbook is trying to create a file even though we don't want it to. It'd be helpful if there was a mdbook build flag like --nocreate or --strict that doesn't attempt to create files from SUMMARY.md if they don't exist and instead results in a build error.

Does this sound alright? If so, I can implement this.
@steveklabnik
Copy link
Member

Seems good to me.

@azerupi
Copy link
Contributor

azerupi commented Apr 17, 2017

Yes, sounds good!
I am not sure about the exact flag to use, --strict definitely sounds too generic. --nocreate could be ok, even though it does not clearly show that it only affects the creation of source files. Anyway, this is just a small thing that can be discussed and changed when the PR is ready :)

frewsxcv referenced this issue in frewsxcv/mdBook Apr 18, 2017
@frewsxcv
Implement new 'no-create' build flag.
c6e8133 
Fixes https://github.com/azerupi/mdBook/issues/253.
@frewsxcv frewsxcv mentioned this issue Apr 18, 2017
Merged
@frewsxcv
Copy link
Member Author

Opened a PR: https://github.com/azerupi/mdBook/issues/254

@frewsxcv frewsxcv mentioned this issue Apr 27, 2017
Merged
frewsxcv referenced this issue in frewsxcv/rust Apr 27, 2017
@frewsxcv
Bump mdbook dep to pick up new 'create missing' toggle feature.
a517a96 
This will avoid obscure Travis CI error messages:

* rust-lang#40290 (comment)

Original mdbook issue:

* https://github.com/azerupi/mdBook/issues/253

mdbook PR:

* https://github.com/azerupi/mdBook/pull/254
frewsxcv referenced this issue in frewsxcv/rust Apr 27, 2017
@frewsxcv
Rollup merge of rust-lang#41572 - frewsxcv:bump-mdbook, r=steveklabnik
6fe2c24 
Bump mdbook dep to pick up new 'create missing' toggle feature.

This will avoid obscure Travis CI error messages:

* rust-lang#40290 (comment)

Original mdbook issue:

* https://github.com/azerupi/mdBook/issues/253

mdbook PR:

* https://github.com/azerupi/mdBook/pull/254
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@steveklabnik @frewsxcv @azerupi