<div dir="ltr"><br><div class="gmail_extra"><div class="gmail_quote">On Thu, Jun 6, 2013 at 10:15 AM, Vane, Edwin <span dir="ltr"><<a href="mailto:edwin.vane@intel.com" target="_blank">edwin.vane@intel.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div class="im"><br>
<br>
> -----Original Message-----<br>
> From: Sean Silva [mailto:<a href="mailto:silvas@purdue.edu">silvas@purdue.edu</a>]<br>
> Sent: Thursday, June 06, 2013 12:46 PM<br>
> To: Vane, Edwin<br>
> Cc: <a href="mailto:cfe-commits@cs.uiuc.edu">cfe-commits@cs.uiuc.edu</a><br>
> Subject: Re: [clang-tools-extra] r183417 - cpp11-migrate: Docs refresh<br>
><br>
> Sorry I didn't get to this while it was still in Phabricator. In the future, please split<br>
> up logically separate changes into separate patches (this applies even for<br>
> documentation).<br>
<br>
</div>What do you see as logically separate changes in this patch?<br></blockquote><div><br></div><div style>I was able to glean the following independent changes from your patch and your description of the changes; there may be others I missed. Items marked with `*` could have been committed directly without pre-commit review since they are "obvious".</div>
<div style><br></div>1* The change to docs/AddOverrideTransform.rst</div><div class="gmail_quote">2* Changing the title of docs/cpp11-migrate.rst</div><div class="gmail_quote">3* Factoring out the usage to docs/MigratorUsage.rst</div>
<div class="gmail_quote">4* Adding the forgotten link to :doc:`AddOverrideTransform`</div><div class="gmail_quote">5* Changing the header level (from subsection to section) of `Transformations`</div><div class="gmail_quote">
6 Adding the "Getting Started" section</div><div class="gmail_quote">7 Adding the "Getting Involved" section</div><div class="gmail_quote">8* Splitting the options into general and transform-specific options.</div>
<div class="gmail_quote">9* Documenting new command line options (maybe pre-commit review this one for extra feedback on the text).</div><div class="gmail_quote">10* Adding the intro paragraph to the "Transformations" section.</div>
<div class="gmail_quote"><br></div><div class="gmail_quote">If you hadn't mentioned in the commit message that you introduced documentation for new command line options, I wouldn't have noticed since in the same patch you both reorganized the section containing the command line options and moved it to another file. (I still have no idea which new options were documented...)<br>
<div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<div class="im"><br>
> +If you find a bug<br>
> +<br>
> +.. raw:: html<br>
> +<br>
</div>> + <input type="button" id="logbug" value="Log a Bug!" /> <script<br>
> + type="text/javascript"<br>
> + src="<a href="https://cpp11-migrate.atlassian.net/s/en_USpfg3b3-1988229788/6095" target="_blank">https://cpp11-migrate.atlassian.net/s/en_USpfg3b3-1988229788/6095</a><br>
> + /34/1.4.0-m2/_/download/batch/com.atlassian.jira.collector.plugin.jira<br>
> + -issue-collector-plugin:issuecollector/<a href="http://com.atlassian.jira.collector.pl" target="_blank">com.atlassian.jira.collector.pl</a><br>
> + ugin.jira-issue-collector-plugin:issuecollector.js?collectorId=5081387<br>
> + 4"></script> <script type="text/javascript">window.ATL_JQ_PAGE_PROPS<br>
<div class="im">> + = {<br>
> + "triggerFunction": function(showCollectorDialog) {<br>
> + //Requries that jQuery is available!<br>
> + jQuery("#logbug").click(function(e) {<br>
> + e.preventDefault();<br>
> + showCollectorDialog();<br>
> + });<br>
> + }};<br>
> + </script><br>
><br>
><br>
> Could you just link to a "file a new bug" form instead of spewing this raw markup<br>
> and modal dialog into the page?<br>
<br>
</div>I'm afraid that's how the issue collector works. There is no separate page for logging bugs anonymously.</blockquote><div><br></div><div>Please file an issue with Atlassian. This is ridiculous.<br></div><div>
</div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"> I can just disable anonymous bug loggings I just wanted to make it as easy as possible to log bugs.<br>
</blockquote><div><br></div><div style>It's not really clear to me how disabling anonymous bug logging would make it as easy as possible to log bugs. Anyway, generally you want to balance ease of logging bugs (increase fraction of people experience bugs that report them) with the ability to follow up with the person so that the bug can be made actionable (increase fraction of reported bugs that are actionable), hence anonymous bug reports are not necessarily the best choice (they may be adequate in this scenario).</div>
<div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<div class="im"><br>
> Just curious, but why do you guys have a separate bug tracker for cpp11-<br>
> migrate?<br>
<br>
</div><a href="http://Cpp11-migrate.atlassian.net" target="_blank">Cpp11-migrate.atlassian.net</a> is not just a bug tracker. It's our main way of doing project tracking. If people log bugs at <a href="http://llvm.org/bugs" target="_blank">llvm.org/bugs</a> I just manually copy them into the project tracker anyway.<br>
<div class="im"><br>
><br>
><br>
> Transformations<br>
> -===============<br>
> +---------------<br>
><br>
><br>
> Please stick to the standard adornments as laid out in<br>
> llvm/docs/SphinxQuickstartTemplate.rst<br>
<br>
</div>I made this change because Sphinx was getting the section levels wrong. Sphinx has no absolute mapping between the section level and a markup so it tries to infer. I'll see if I can find another workaround.<br>
</blockquote><div><br></div><div style>It seems like you are using ------------ for "section" in this document. Just use ========== to indicate "section".</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<div class="im"><br>
> Tiny nit:<br>
><br>
> +In addition to the compiler arguments you usually build your code with,<br>
</div>> +you must provide the option for enabling C++11 features. For clang and<br>
> +versions of gcc ≥ v4.8 this is ``-std=c++11``.<br>
<br>
I take it Unicode is not allowed then? I wanted U+2265.<br>
<div class=""><div class="h5"><br></div></div></blockquote><div><br></div><div style>We allow unicode. In this case, I would have just done >=, but it's not a big deal.</div><div style><br></div><div style>-- Sean Silva</div>
</div></div></div>