Re: [PATCH 12/12] docs: add information on how to setup build environments

[Pierrick Bouvier <pierrick.bouvier@linaro.org>]

On 11/4/24 07:58, Peter Maydell wrote:
> On Thu, 31 Oct 2024 at 04:07, Pierrick Bouvier
> <pierrick.bouvier@linaro.org> wrote:
>>
>> MacOS and Linux are straightforward, but Windows needs a bit more
>> details.
>>
>> Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
> 
> We have documentation on the wiki currently about how to
> build on various platforms:
> 
> https://wiki.qemu.org/Hosts/Linux
> https://wiki.qemu.org/Hosts/Mac
> https://wiki.qemu.org/Hosts/W32
> 
> I agree that we ought to move this into the main documentation.
> Some of the information in those wiki pages is probably
> out of date, but some of it looks like useful extra detail
> that we could incorporate here.
> 

I noticed that. Is the QEMU wiki considered as "deprecated" (no new 
information there), or more seen as a complement to current manual?

My goal adding this to the documentation was to have a simple (and 
single) "how-to" per platform, instead of trying to cover all the 
possible details and configuration.

Would that be acceptable to add links to the wiki instead of adding all 
information in our documentation?

>> ---
>>   docs/about/build-platforms.rst |   4 +-
>>   docs/devel/build-system.rst    | 100 +++++++++++++++++++++++++++++++++
> 
> I don't think this is the best place to put this information.
> "How do I build from source?" is a question that most beginning
> developers and some end users will have. The information in
> build-system.rst is mostly about the internals of our
> build system and how to modify it, which is a more niche topic.
> 
> I would be inclined to put this in a new file, maybe even
> in docs/about/ rather than docs/devel.
> 

I was not sure, and adding a new file for new developers seems to be the 
best solution. I'll do it.

> thanks
> -- PMM

Thanks