diff options
| author | Sean Silva <chisophugis@gmail.com> | 2014-04-22 21:47:53 +0000 |
|---|---|---|
| committer | Sean Silva <chisophugis@gmail.com> | 2014-04-22 21:47:53 +0000 |
| commit | 3feb690f76dec261ae79fc09b3603522e91e6ed6 (patch) | |
| tree | b81e7f542fdf2cb824f8ff908f9bbce3fbe2a589 /llvm | |
| parent | 7ee97cebfc411f3731edaa220837711d0fc65355 (diff) | |
| download | bcm5719-llvm-3feb690f76dec261ae79fc09b3603522e91e6ed6.tar.gz bcm5719-llvm-3feb690f76dec261ae79fc09b3603522e91e6ed6.zip | |
[docs] Add a note to docs/README.txt
Added note to docs/README.txt on how to check the reachibility of
external links in the documentation.
Patch by Dan Liew!
llvm-svn: 206924
Diffstat (limited to 'llvm')
| -rw-r--r-- | llvm/docs/README.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/llvm/docs/README.txt b/llvm/docs/README.txt index 22cf9307795..3d634292980 100644 --- a/llvm/docs/README.txt +++ b/llvm/docs/README.txt @@ -40,3 +40,12 @@ The correspondence between .rst files and man pages is These .rst files are also included during HTML generation so they are also viewable online (as noted above) at e.g. `http://llvm.org/docs/CommandGuide/Foo.html`. + +Checking links +============== + +The reachibility of external links in the documentation can be checked by +running: + + cd docs/ + make -f Makefile.sphinx linkcheck |
