Skip to content

Commit cab50cc

Browse files
authored
Fix skiplinkcheck (#638)
`--skiplinkcheck` and `--linkcheckonly` were documented as only working with `--doc` but they are actually only used with `--all`. This fixes the documentation and the preflight checks to reflect that reality.
1 parent 84dbfb8 commit cab50cc

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

build_docs.pl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -709,6 +709,8 @@ sub check_args {
709709
die('--rely_on_ssh_auth not compatible with --doc') if $Opts->{rely_on_ssh_auth};
710710
die('--rebuild not compatible with --doc') if $Opts->{rebuild};
711711
die('--no_fetch not compatible with --doc') if $Opts->{no_fetch};
712+
die('--skiplinkcheck not compatible with --doc') if $Opts->{skiplinkcheck};
713+
die('--linkcheckonly not compatible with --doc') if $Opts->{linkcheckonly};
712714
} else {
713715
die('--single not compatible with --all') if $Opts->{single};
714716
die('--pdf not compatible with --all') if $Opts->{pdf};
@@ -718,8 +720,6 @@ sub check_args {
718720
die('--lenient not compatible with --all') if $Opts->{lenient};
719721
# Lang will be 'en' even if it isn't specified so we don't check it.
720722
die('--resource not compatible with --all') if $Opts->{resource};
721-
die('--skiplinkcheck not compatible with --all') if $Opts->{skiplinkcheck};
722-
die('--linkcheckonly not compatible with --all') if $Opts->{linkcheckonly};
723723
die('--asciidoctor not compatible with --all') if $Opts->{asciidoctor};
724724
}
725725
}
@@ -744,8 +744,6 @@ sub usage {
744744
--lenient Ignore linking errors
745745
--lang Defaults to 'en'
746746
--resource Path to image dir - may be repeated
747-
--skiplinkcheck Omit the step that checks for broken links
748-
--linkcheckonly Skips the documentation builds. Checks links only.
749747
--asciidoctor Use asciidoctor instead of asciidoc.
750748
751749
WARNING: Anything in the `out` dir will be deleted!
@@ -759,6 +757,8 @@ sub usage {
759757
--push Commit the updated docs and push to origin
760758
--user Specify which GitHub user to use, if not your own
761759
--reference Directory of `--mirror` clones to use as a local cache
760+
--skiplinkcheck Omit the step that checks for broken links
761+
--linkcheckonly Skips the documentation builds. Checks links only.
762762
--rely_on_ssh_auth
763763
noop
764764
--rebuild Rebuild all branches of every book regardless of what has changed

0 commit comments

Comments
 (0)