<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Thu, Apr 17, 2014 at 5:58 PM, Dan Liew <span dir="ltr"><<a href="mailto:dan@su-root.co.uk" target="_blank">dan@su-root.co.uk</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="">> This is looking really good. I would like to remove the linkcheck target<br>
> just on the principle that the build should not go accessing external<br>
> websites.<br>
<br>
</div>Sure. I feel as if users should still be made aware of this feature (I<br>
certainly didn't know about it before I started this work).<br></blockquote><div><br></div><div>I didn't know about it either and it does seem like it would be useful in some situations. However, I don't consider it that important. Even in the category of "lots of by-hand mechanical work" it isn't a top priority (a much bigger thing in that category is fixing up internal HTML links to be :ref: or :doc: links so that Sphinx knows about them).</div>
<div><br></div><div>That's not to say that I wouldn't be glad to accept patches fixing broken links (especially any in CompilerWriterInfo). But if you have a nontrivial amount of experience with LLVM it is much preferred if you contributed actual content to the documentation based on your knowledge.</div>
<div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
Would it be okay to add information about how to check links manually<br>
to <a href="http://llvm.org/docs/SphinxQuickstartTemplate.html" target="_blank">http://llvm.org/docs/SphinxQuickstartTemplate.html</a> as a separate<br>
patch?<br></blockquote><div><br></div><div>SphinxQuickstartTemplate is not the right place for that kind of information: one of its goals is getting people to write quality content with "as little nonsense as possible". Worrying about a broken link is nonsense compared to writing quality content. I would probably be fine with a note at the bottom of docs/README.txt.</div>
<div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
Since I'm going to rework the patch again I'd like to ask people's<br>
opinions on a few things before I start<br>
<br>
- Are the names of the targets okay?<br>
<br>
* docs-llvm-html<br>
* docs-llvm-man<br>
<br>
i.e. if you build with LLVM_ENABLE_SPHINX you can type ``make<br>
docs-llvm-html`` and ``make docs-llvm-man`` to build documentation.<br></blockquote><div><br></div><div>Seems fine to me.</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">

<br>
- I've assumed the add_sphinx_target() function is reusable by other<br>
projects like Clang and lldb. This might not be the case depending on<br>
how these projects interact with LLVM's CMake build system. I've only<br>
ever built Clang inside the LLVM tree (a case where reusing<br>
add_sphinx_target should work) but I'm sure I remember reading<br>
somewhere that Clang can be built out of tree and in that case I have<br>
doubts about reusing add_sphinx_target() working. I've never even<br>
built lldb but the instructions seem to say I should build in tree.<br>
<br>
 Would it be worth trying to apply the add_sphinx_target() functin to<br>
Clang and lldb as well?<br></blockquote><div><br></div><div>Give it a spin on clang as a sanity check (and if you have spare cycles, lld too). I don't think lldb uses sphinx. Since this is gated behind an option, I wouldn't worry about out-of-tree builds.</div>
<div><br></div><div>Oh, btw, when I applied your patch last time git gave me some trailing whitespace warnings. Please try to avoid trailing whitespace.</div><div><br></div><div>-- Sean Silva</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">

<div class=""><br>
<br>
> You should send 0002 in a separate patch thread. I don't really have the<br>
> knowledge to sign off on it. I think you'll want to CC chapuni or chandler.<br>
<br>
</div>Sure I'll do that.<br>
<br>
Thanks,<br>
<div class="HOEnZb"><div class="h5">--<br>
Dan Liew<br>
PhD Student - Imperial College London<br>
</div></div></blockquote></div><br></div></div>