[PATCH 0/1] [GSoC - x86_64] User documentation for BSP

[Gedare Bloom]

Hello Amaan,


On Fri, Jul 13, 2018 at 3:32 AM, Amaan Cheval <amaan.cheval at gmail.com> wrote:
> The built documentation can more easily be viewed here:
> http://whatthedude.com/rtems/user/html/bsps/bsps-x86_64.html
>
> It feels a bit convoluted to me at the moment. I'd appreciate feedback on how
> the documentation may be made more understandable, and on whether the current
> approach even seems sustainable - specifically, using FreeBSD's bootloader ties
> us into using the UFS filesystem and can slow down the iterative-development
> process.
>
I agree. It looks like you have to build FreeBSD at least one time to
use this? Alternatives should be again considered for iterative
improvement.

> In my opinion, this system is good _enough_ for now - we can explore other
> options later if time permits, but I'd love to hear differing opinions.
>
> P.S. - Joel asked earlier if the QEMU that the RSB builds will suffice - for me,
> it didn't because in it "SDL support is disabled" (and so are all other graphics
> options). It's likely possible to install FreeBSD without graphics, it may not
> be worth the effort of setting up - it's likely easier to update the RSB's QEMU
> to also build graphics support.
>
I was going to recommend this. You can make it an option of the qemu
configuration in RSB to enable the support needed. I suggest you talk
to Vijay as he has some experience now with RSB, and also this will
require Chris Johns approval.

Relatedly, does it make sense for you to look at creating an RSB
"recipe" for building the UEFI firmware?

> P.P.S. - Some of the documentation is double-spaced, but this patch isn't. Let me
> know if it ought to be (the README didn't say anything of the sort, and it isn't
> consistent throughout).
>

Stick to one consistent approach within your chapters. If consistency
needs to be dealt with across chapters in a manual or across the set
of manuals, that can be done later and simpler if each chapter is
internally consistent.

> Amaan Cheval (1):
>   user: Add x86_64 BSP chapter
>
>  user/bsps/bsps-x86_64.rst | 143 +++++++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 142 insertions(+), 1 deletion(-)
>
> --
> 2.16.0.rc0
>