From ae900c902501137fdae03a28d7f95440fe29f414 Mon Sep 17 00:00:00 2001 From: lcawley Date: Tue, 21 Nov 2017 12:56:06 -0800 Subject: [PATCH 1/3] [DOCS] Added --nolinkcheck parameter --- build_docs.pl | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/build_docs.pl b/build_docs.pl index abe0d938ac682..73fc914a63b2e 100755 --- a/build_docs.pl +++ b/build_docs.pl @@ -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', 'lenient', 'verbose', 'reload_template', 'resource=s@' ) || exit usage(); @@ -191,12 +191,19 @@ sub build_all { write_html_redirect( $build_dir->subdir( $_->{prefix} ), $_->{redirect} ); } - - say "Checking links"; - check_links($build_dir); - - push_changes($build_dir) - if $Opts->{push}; + if ( $Opts->{nolinkcheck} ) { + say "Skipped Checking links"; + + push_changes($build_dir) + if $Opts->{push}; + } + else { + say "Checking links"; + check_links($build_dir); + + push_changes($build_dir) + if $Opts->{push}; + } } #=================================== @@ -625,6 +632,7 @@ sub usage { --lenient Ignore linking errors --lang Defaults to 'en' --resource Path to image dir - may be repeated + --nolinkcheck Omit the step that checks for broken links WARNING: Anything in the `out` dir will be deleted! From 49e7c01f6c810b1c2861b1a87e3397afedec6d37 Mon Sep 17 00:00:00 2001 From: lcawley Date: Tue, 21 Nov 2017 14:22:33 -0800 Subject: [PATCH 2/3] [DOCS] Addressed feedback about -nolinkcheck option --- build_docs.pl | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/build_docs.pl b/build_docs.pl index 73fc914a63b2e..cf62dbd4d028a 100755 --- a/build_docs.pl +++ b/build_docs.pl @@ -193,17 +193,13 @@ sub build_all { } if ( $Opts->{nolinkcheck} ) { say "Skipped Checking links"; - - push_changes($build_dir) - if $Opts->{push}; } else { say "Checking links"; check_links($build_dir); - - push_changes($build_dir) - if $Opts->{push}; } + push_changes($build_dir) + if $Opts->{push}; } #=================================== From bd755f7213b50c887f5cc25614216741dd4d0f61 Mon Sep 17 00:00:00 2001 From: lcawley Date: Wed, 22 Nov 2017 08:53:15 -0800 Subject: [PATCH 3/3] [DOCS] Changed nolinkcheck to skiplinkcheck --- build_docs.pl | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/build_docs.pl b/build_docs.pl index cf62dbd4d028a..9481444dfc215 100755 --- a/build_docs.pl +++ b/build_docs.pl @@ -51,7 +51,7 @@ BEGIN $Opts, # 'all', 'push', 'update!', # 'single', 'pdf', 'doc=s', 'out=s', 'toc', 'chunk=i', - 'open', 'nolinkcheck', 'staging', 'procs=i', 'user=s', 'lang=s', + 'open', 'skiplinkcheck', 'staging', 'procs=i', 'user=s', 'lang=s', 'lenient', 'verbose', 'reload_template', 'resource=s@' ) || exit usage(); @@ -191,7 +191,7 @@ sub build_all { write_html_redirect( $build_dir->subdir( $_->{prefix} ), $_->{redirect} ); } - if ( $Opts->{nolinkcheck} ) { + if ( $Opts->{skiplinkcheck} ) { say "Skipped Checking links"; } else { @@ -199,7 +199,7 @@ sub build_all { check_links($build_dir); } push_changes($build_dir) - if $Opts->{push}; + if $Opts->{push}; } #=================================== @@ -628,7 +628,7 @@ sub usage { --lenient Ignore linking errors --lang Defaults to 'en' --resource Path to image dir - may be repeated - --nolinkcheck Omit the step that checks for broken links + --skiplinkcheck Omit the step that checks for broken links WARNING: Anything in the `out` dir will be deleted!