[DOCS] Added --skiplinkcheck parameter #261
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lcawl
added
the
docs
|
I'd pull the push out of the nolinkcheck if/else, other than that LGTM. |
|
Good suggestion, @debadair, done! |
clintongormley
approved these changes
Nov 22, 2017
build_docs.pl
Outdated
| check_links($build_dir); | ||
| } | ||
| push_changes($build_dir) | ||
| if $Opts->{push}; |
There was a problem hiding this comment.
niggle - indent the if line
build_docs.pl
Outdated
| @@ -51,7 +51,7 @@ BEGIN | |||
| $Opts, # | |||
| 'all', 'push', 'update!', # | |||
| 'single', 'pdf', 'doc=s', 'out=s', 'toc', 'chunk=i', | |||
| 'open', 'staging', 'procs=i', 'user=s', 'lang=s', | |||
| 'open', 'nolinkcheck', 'staging', 'procs=i', 'user=s', 'lang=s', | |||
There was a problem hiding this comment.
let's call it skiplinkcheck instead of nolinkcheck
lcawl
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #249
This PR adds the --nolinkcheck parameter, which skips the step that checks links at the end of a --all build. For example, you can use it as follows:
This is required for when a broken link is preventing us from successfully publishing the documentation in a time-critical situation.
The expectation is that any broken links would be fixed as soon as possible and link checking would be resumed immediately thereafter.