From: Sean Silva <chisophugis@gmail.com>
Date: Tue, 22 Apr 2014 21:47:53 +0000 (+0000)
Subject: [docs] Add a note to docs/README.txt
X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=423575405d250b5e95d8118226ca67b36c644cc5;p=oota-llvm.git

[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!

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@206924 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/docs/README.txt b/docs/README.txt
index 22cf9307795..3d634292980 100644
--- a/docs/README.txt
+++ b/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