<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Wed, Feb 22, 2017 at 3:51 PM, Chris Johns <span dir="ltr"><<a href="mailto:chrisj@rtems.org" target="_blank">chrisj@rtems.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><span class="">On 23/02/2017 01:16, Joel Sherrill wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
I have been concerned that there is no easy way to know that<br>
the host has the complete toolset to build the rtems documentation.<br>
I know we are trying to catch things with waf but I was wondering<br>
about a short document that just does things that can be quickly<br>
checked for correctness.  Examples of:<br>
<br>
+ math formula<br>
+ citation<br>
+ code example<br>
+ ???<br>
<br>
Otherwise, to be confident, I have to know where to look in the<br>
various documents to find examples of things that can break.<br>
</blockquote>
<br></span>
Have you looked in the top level README.txt and the Documentation Standard section? I documented a number of the features I used. It may need updating.<br>
<br></blockquote><div><br></div><div>I admit to not checking that but that would be the input to what I am talking about.</div><div>If README.txt has an example of using math, citations, and our prominent patterns,</div><div>then README.pdf as generated by the user's tools could be visually checked</div><div>easily for correct output.</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
There is no template for a directive and more could be added. That document is actually in ReST format or is close to it.<span class=""><br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
This way we can provide a short document and a pre-formatted<br>
PDF as a reference.<br></blockquote></span></blockquote><div><br></div><div>The above sentence is the critical part to me. We should provide a pre-formatted</div><div>version so the user knows what to expect. Either what they generate looks correct</div><div>or a specific piece of the README looks incorrect and it is easy to track down</div><div>what piece of the source code isn't able to be processed correctly.</div><div><br></div><div>--joel<br></div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><span class=""><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
</blockquote>
<br></span>
Chris<br>
______________________________<wbr>_________________<br>
devel mailing list<br>
<a href="mailto:devel@rtems.org" target="_blank">devel@rtems.org</a><br>
<a href="http://lists.rtems.org/mailman/listinfo/devel" rel="noreferrer" target="_blank">http://lists.rtems.org/mailman<wbr>/listinfo/devel</a><br>
</blockquote></div><br></div></div>