One more check added: If the line is too long. Let me know if there's anything else that can reasonably be checked. Perhaps if lists are indented or not<br><br><div class="gmail_quote">2012/6/16 Mikael Lyngvig <span dir="ltr"><<a href="mailto:mikael@lyngvig.org" target="_blank">mikael@lyngvig.org</a>></span><br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Thank you again! <div><br></div><div>All issues fixed. Here is the file so that you may check it out again, if you so wish, before I waste more bandwidth on half-baked patches.</div>
<div><br></div><div>The AWK script didn't work; probably because of the way Windows handles ' characters: </div>
<div><br></div><div> awk: 'BEGIN</div><div> awk: ^ invalid char ''' in expression</div><div><br></div><div>If you are up to it and have the time for it, you could perhaps some day make a small Python script that performs the checks you want of the rst files? I can also do it, if you so prefer.</div>
<div><div>
<div><br></div><div><div class="gmail_quote">2012/6/16 Sean Silva <span dir="ltr"><<a href="mailto:silvas@purdue.edu" target="_blank">silvas@purdue.edu</a>></span><br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
1. I'm seeing lots of trailing whitespace. If you have sed available you can fix it quickly with<div>sed -i -e 's/\s\+$//' FAQ.rst</div><div><br></div><div>2. There are still 2 (non-header) lines that are going past 80-columns. They are the paragraph text under the first and last subheading under the "License" heading.<br>
<div><br></div><div>3. Your underline for the subheading "What is this ``llvm.global_ctors`` and ``_GLOBAL__I_a...`` stuff that happens when I ``#include <iostream>``?"</div><div>is too long. If you have cygwin installed or otherwise have access to unix tools you can run:</div>
<div><br></div><div>cat FAQ.rst | awk 'BEGIN { RS=""; FS="\n" } $2 ~ /[-=][-=]+/ && length($1) != length($2) { print NR, $1 }'</div><div><br></div><div>to proactively catch these mismatches in the future. It prints out the line-number and the offending heading of any mismatched headers.</div>
<div><br></div><div>4. Sphinx is emitting warnings because FAQ.rst is not linked into any toctree. You can find documentation about sphinx doctrees at <<a href="http://sphinx.pocoo.org/concepts.html" target="_blank">http://sphinx.pocoo.org/concepts.html</a>></div>
<div><br></div><div>5. I wouldn't add the FAQ to index.rst in the same patch. This patch should focus solely on replacing FAQ.html with FAQ.rst. By doing it this way, we can focus on reST-style things for this patch. A future patch can then move it to the front page, and will naturally serve as a forum for discussion for the decision to do that.</div>
<div><br></div><div>--Sean Silva</div><div><br><div class="gmail_quote"><div><div>On Fri, Jun 15, 2012 at 3:28 PM, Mikael Lyngvig <span dir="ltr"><<a href="mailto:mikael@lyngvig.org" target="_blank">mikael@lyngvig.org</a>></span> wrote:<br>
</div></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div><div><div>Author: Mikael Lyngvig</div><div>Subject: FAQ.html converted into reStructured Text for use with Sphinx (it looks so good now!)</div>
<div><br></div>New patch (this is an actual "svn diff" instead of just a loose file) including all requested changes:<div>
<br></div><div> 1. Lines are now only 80 chars long.</div><div> 2. Incorrect links have been repaired (missing _ at end of cross-reference).</div><div> 3. FAQ.html is dead and has been deleted.</div>
<div> 4. FAQ.rst has been added.</div><div> 5. The FAQ has been added as the very first item on the documentation page (so that everybody sees it). This may not be what you want so let me know if I should move it to the User Guides section instead.</div>
<div><br></div><div>Cheers,</div><div>Mikael</div><div><br></div>
<br></div></div>_______________________________________________<br>
llvm-commits mailing list<br>
<a href="mailto:llvm-commits@cs.uiuc.edu" target="_blank">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>
<br></blockquote></div><br></div></div>
</blockquote></div><br></div>
</div></div></blockquote></div><br>