<div dir="ltr"><div>Hi Dan, please revert this.<br><br>More comments inline:<br></div><div class="gmail_extra"><br><br><div class="gmail_quote">On Tue, Jul 22, 2014 at 9:07 AM, 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:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Author: delcypher<br>
Date: Tue Jul 22 10:07:35 2014<br>
New Revision: 213661<br>
<br>
URL: <a href="http://llvm.org/viewvc/llvm-project?rev=213661&view=rev" target="_blank">http://llvm.org/viewvc/llvm-project?rev=213661&view=rev</a><br>
Log:<br>
Treat warnings in Sphinx as errors. The reasons for doing this are...<br>
<br>
- When CMake builds the documentation with sphinx-build it treats<br>
  warnings as errors. We should be consistent with what we do in<br>
  CMake.<br></blockquote><div><br>CMake is not the primary way that the Sphinx docs get built. If you want these two to be consistent I would suggest that you change CMake to be consistent with Makefile.sphinx and not the other way around.<br>
 </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
- Having warnings treated as errors will hopefully encourage<br>
  developers to write documentation correctly.<br></blockquote><div><br>This is completely backwards. Good documentation has nothing to do with proper markup. Someone with zero knowledge of the thing being documented can fix markup errors.<br>
<br>Good documentation is about good content. Notice how many times <<a href="http://llvm.org/docs/SphinxQuickstartTemplate.html">http://llvm.org/docs/SphinxQuickstartTemplate.html</a>> says to focus on content! Having to worry about markup can only hamper the creation of good content.<br>
<br></div><div>-- Sean Silva<br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
Modified:<br>
    llvm/trunk/docs/Makefile.sphinx<br>
<br>
Modified: llvm/trunk/docs/Makefile.sphinx<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/Makefile.sphinx?rev=213661&r1=213660&r2=213661&view=diff" target="_blank">http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/Makefile.sphinx?rev=213661&r1=213660&r2=213661&view=diff</a><br>

==============================================================================<br>
--- llvm/trunk/docs/Makefile.sphinx (original)<br>
+++ llvm/trunk/docs/Makefile.sphinx Tue Jul 22 10:07:35 2014<br>
@@ -10,7 +10,7 @@ BUILDDIR      = _build<br>
 # Internal variables.<br>
 PAPEROPT_a4     = -D latex_paper_size=a4<br>
 PAPEROPT_letter = -D latex_paper_size=letter<br>
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .<br>
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) -W .<br>
 # the i18n builder cannot share the environment and doctrees with the others<br>
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .<br>
<br>
<br>
<br>
_______________________________________________<br>
llvm-commits mailing list<br>
<a href="mailto:llvm-commits@cs.uiuc.edu">llvm-commits@cs.uiuc.edu</a><br>
<a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits" target="_blank">http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits</a><br>
</blockquote></div><br></div></div>