[Avocado-devel] Fwd: [Qemu-devel] a suggestion to place *.c hunks last in patches

[Ademar Reis]

Saw this message on qemu-devel and I think it's a nice suggestion
for Avocado developers.

The ordering for a python project should be different, but you
get the idea (replies to this thread with the suggested list are
welcome).

Thanks.
   - Ademar

----- Forwarded message from Laszlo Ersek <lersek at redhat.com> -----

Date: Wed, 30 Nov 2016 11:08:27 +0100
From: Laszlo Ersek <lersek at redhat.com>
Subject: [Qemu-devel] a suggestion to place *.c hunks last in patches
To: qemu devel list <qemu-devel at nongnu.org>

Recent git releases support the diff.orderFile permanent setting. (In
older releases, the -O option had to be specified on the command line,
or in aliases, for the same effect, which was quite inconvenient.) From
git-diff(1):

       -O<orderfile>
           Output the patch in the order specified in the <orderfile>,
           which has one shell glob pattern per line. This overrides
           the diff.orderFile configuration variable (see git-
           config(1)). To cancel diff.orderFile, use -O/dev/null.

In my experience, an order file such as:

configure
*Makefile*
*.json
*.txt
*.h
*.c

that is, a priority order that goes from
descriptive/declarative/abstract to imperative/specific works wonders
for reviewing.

Randomly picked example:

[Qemu-devel] [PATCH] virtio-gpu: track and limit host memory allocations
http://lists.nongnu.org/archive/html/qemu-devel/2016-11/msg05144.html

This patch adds several fields to several structures first, and then it
does things with those new fields. If you think about what the English
verb "to declare" means, it's clear you want to see the declaration
first (same as the compiler), and only then how the field is put to use.

Thanks!
Laszlo


----- End forwarded message -----

-- 
Ademar Reis
Red Hat

^[:wq!