Received: from eggs.gnu.org ([209.51.188.92]:44421) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ggV8s-0004hH-5N for qemu-devel@nongnu.org; Mon, 07 Jan 2019 08:40:34 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ggV8r-0007JU-BN for qemu-devel@nongnu.org; Mon, 07 Jan 2019 08:40:34 -0500 From: Markus Armbruster References: <20190104181208.7809-1-philmd@redhat.com> <20190104181208.7809-4-philmd@redhat.com> <349cd87b-0526-30b8-d9cd-0eee537ab5a4@redhat.com> Date: Mon, 07 Jan 2019 14:40:01 +0100 In-Reply-To: <349cd87b-0526-30b8-d9cd-0eee537ab5a4@redhat.com> (Eric Blake's message of "Fri, 4 Jan 2019 14:17:14 -0600") Message-ID: <874lakk2mm.fsf@dusky.pond.sub.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Subject: Re: [Qemu-devel] [PATCH v2 3/3] util/cutils: Move function documentations to the header List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Eric Blake Cc: Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , qemu-devel@nongnu.org, Fam Zheng , Thomas Huth , David Hildenbrand , qemu-trivial@nongnu.org, Richard Henderson , Cornelia Huck , Michael Roth , Halil Pasic , Christian Borntraeger , qemu-s390x@nongnu.org, qemu-ppc@nongnu.org, Gerd Hoffmann , Paolo Bonzini , Stefano Garzarella , David Gibson Eric Blake writes: > On 1/4/19 12:12 PM, Philippe Mathieu-Daud=C3=A9 wrote: >> Many functions have documentation before the implementation in >> cutils.c. Since we expect documentation around the prototype >> declaration in headers, move the comments in cutils.h. >>=20 >> Signed-off-by: Philippe Mathieu-Daud=C3=A9 >> --- >> include/qemu/cutils.h | 224 ++++++++++++++++++++++++++++++++++++++++++ >> util/cutils.c | 185 ---------------------------------- >> 2 files changed, 224 insertions(+), 185 deletions(-) > > I find documentation in .c files slightly easier to use (you can then > read the code right below to see if the documentation is still > accurate); This is the kicker for me. I try to cultivate a healthy suspicion of comments in general, x10 for comments acting at a distance. > but as we had an inconsistent mix, I'm also okay with your > patch consolidating all the documentation to one of the two files, > rather than the bad mix of half-and-half. Concur.