Re: [Qemu-devel] [PATCH v2] docs: describe the QEMU build system structure / design

[John Snow]

On 09/23/2015 11:46 AM, Laszlo Ersek wrote:
> I diffed this version against v1. Thank you for addressing my comments
> too; however I found some newly introduced typos:
> 
> On 09/23/15 11:59, Daniel P. Berrange wrote:
> 
>> +The utility code that is used by all binaries is built into a
>> +static archive called libqemuutil.a, which is then linked to all the
>> +binaries. In order to provides hooks that are only needed by some of the
> 
> to provide[]
> 
>> +binaries, code in libqemuutil.a may depend on other functions that are
>> +not fully implementd by all QEMU binaries. To deal with this there is a
> 
> implement[e]d
> 
> To deal with this[,]
> 
>> +second library called libqemustub.a which provide dummy stubs for all
> 
> [,] which provide[s]
> 
>> +these functions. These will get lazy linked into the binary if the real
>> +implementation is not present. In this way, the libqemustub.a static
>> +library can be thought of as a portable implementation of the weak
>> +symbols concept. All binaries should link to both libqemuutil.a and
>> +libqemustub.a. e.g.
> 
> [,] e.g.[:] -- but I don't feel strongly about this :)
> 
>> +
>> + qemu-img$(EXESUF): qemu-img.o ..snip.. libqemuutil.a libqemustub.a
>> +
>> +
>> +Windows platform portability
>> +----------------------------
>> +
>> +On Windows all binaries have a 'exe' suffix, so all the Makefile rules
> 
> This was
> 
>   "a .exe suffix"
> 
> before, and Jon commented that you probably pronounced it as "a dot-exe
> suffix".
> 
> Now you've removed the dot, but haven't changed "a" into "an". :)
> 

Ah, I didn't realize he changed this -- I wasn't actually recommending
that you change it, it was supposed to just be an observation.

"a .exe" or "an exe" are both correct in my mind and you can use
whichever you find reads easiest.

>> +If there are any rules defined in the Makefile.objs file, they should
>> +all use $(obj) as a prefix to the target e.g.
> 
> target[,] e.g.[:] -- not very necessary though
> 
>> +Dynamically created files
>> +-------------------------
>> +
>> +The following files are generated dynamically by configure in order to
>> +control the behaviour of the statically defined makefiles. This avoids
>> +the need for QEMU makefiles to go through any pre-processing as seen
>> +with autotools, where Makefile.am generates Makefile.in which generates
>> +Makefile.
>> +
> 
> I suggest to insert another empty line here, with consistency for the
> other entries below. (This is not new in v2, so sorry about pointing it
> out now.)
> 
> For the next version (v3):
> 
> Acked-by: Laszlo Ersek <address@hidden>
> 
> Thanks
> Laszlo
> 

That's what I get for skimming. Thanks Laszlo.