<div dir="ltr"><div class="gmail_default" style="font-size:small">Where should I put the additional instructions for creating and sending patches?</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">I will try to send a patch most probably by tomorrow evening.</div><div class="gmail_default" style="font-size:small">Meanwhile, can you have a look at the patch that I have sent?</div><div class="gmail_default" style="font-size:small"><a href="https://lists.rtems.org/pipermail/devel/2020-March/058716.html">https://lists.rtems.org/pipermail/devel/2020-March/058716.html</a><br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">Thanks,</div><div class="gmail_default" style="font-size:small">Niteesh</div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Mon, Mar 30, 2020 at 9:40 PM Gedare Bloom <<a href="mailto:gedare@rtems.org" target="_blank">gedare@rtems.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">On Sun, Mar 29, 2020 at 11:47 PM Sebastian Huber<br>
<<a href="mailto:sebastian.huber@embedded-brains.de" target="_blank">sebastian.huber@embedded-brains.de</a>> wrote:<br>
><br>
> On 28/03/2020 19:47, Niteesh G. S. wrote:<br>
><br>
> We have an Installation chapter under the User manual <a href="https://docs.rtems.org/branches/master/user/installation/index.html" rel="noreferrer" target="_blank">https://docs.rtems.org/branches/master/user/installation/index.html</a><br>
> But it isn't detailed enough like the quick start guide. IMO it is the right place to add detailed instructions. It already has important<br>
> information for a good setup like sandboxing, differences between a release and dev. version, host toolchain setup and more.<br>
> Should we move all the details from quick-start chapter to the installation chapter and make the quick start guide simple enough for a<br>
> student to begin with.<br>
> We could add a subsection about GSoC under quick-start and ask the students to refer to the quick-start chapter.<br>
><br>
> We should really try to consolidate the documentation. Having mostly the same stuff in different places is a maintenance problem. The intention of the Quick Start chapter is to get started quickly step by step on a simulator platform which is able to run the RTEMS test suite properly. You should be able to use it as a template for your desired target system. Getting started on a simulator platform should be the right thing for a GSoC student?<br>
<br>
The concern is that the Quick Start includes a lot of extra material<br>
that makes it not so "Quick" to use. There are also many decisions<br>
that need to be made when following the quick start that makes it not<br>
exactly a linear set of directions.<br>
<br>
That said, I agree that consolidation is important. Niteesh, would you<br>
be willing to draft a subsection in the Quick Start (maybe near the<br>
beginning) that provides a set of instructions to walk-through the<br>
remainder of the quick start oriented toward GSoC students, pointing<br>
out the decision to make at each "decision point" -- such as, In<br>
Section 2.3 use the "Git" instructions; in Section 2.6 use the "Manual<br>
BSP Build", etc. These should be written as linked references to those<br>
sections/subsection names.<br>
<br>
Gedare<br>
</blockquote></div>