Received: from eggs.gnu.org ([209.51.188.92]:35920) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ggr09-0001tz-Ot for qemu-devel@nongnu.org; Tue, 08 Jan 2019 08:01:03 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ggr07-0007Xb-TN for qemu-devel@nongnu.org; Tue, 08 Jan 2019 08:01:00 -0500 Date: Tue, 8 Jan 2019 14:00:52 +0100 From: Cornelia Huck Message-ID: <20190108140034.28ebd539.cohuck@redhat.com> In-Reply-To: <349cd87b-0526-30b8-d9cd-0eee537ab5a4@redhat.com> References: <20190104181208.7809-1-philmd@redhat.com> <20190104181208.7809-4-philmd@redhat.com> <349cd87b-0526-30b8-d9cd-0eee537ab5a4@redhat.com> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; boundary="Sig_/+Uhys04BsCsXfZWNXaRn1/f"; protocol="application/pgp-signature" 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?B?TWF0aGlldS1EYXVkw6k=?= , qemu-devel@nongnu.org, Fam Zheng , Thomas Huth , David Hildenbrand , qemu-trivial@nongnu.org, Michael Roth , Markus Armbruster , Halil Pasic , Christian Borntraeger , qemu-s390x@nongnu.org, qemu-ppc@nongnu.org, Gerd Hoffmann , David Gibson , Paolo Bonzini , Stefano Garzarella , Richard Henderson --Sig_/+Uhys04BsCsXfZWNXaRn1/f Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable On Fri, 4 Jan 2019 14:17:14 -0600 Eric Blake wrote: > 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(-) =20 >=20 > 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); 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. >=20 Another vote for documentation in .c files: If I use tags, I jump to the implementation, not the declaration. But also +1 for consistency. --Sig_/+Uhys04BsCsXfZWNXaRn1/f Content-Type: application/pgp-signature Content-Description: OpenPGP digital signature -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEEw9DWbcNiT/aowBjO3s9rk8bwL68FAlw0nwQACgkQ3s9rk8bw L682LRAAnS1FGGNn2eLN6CftC5NPxUtYL4Lpuc55zAqltRY9o0dr29cgwCVaO60s Wni+EuAm1reXP60N/9cRgb9FqpFo/jhzppq6JRTnzZUR508U0NFQ53wSqwIKImIw NXhXod6rxKbVQQJsbjLpt0fjRSDbzpZgj8S4UzmblZpJSyIEgrySHmSPuMUmt6zt xcJKNRu3qqDuNAEp0mUywEHFa/as8cy5sf7R4/RxQxhKeK+VlHZjpLZWnTAgy2Op IMpRTiix/yB/5NZ4zyZfx2y1XIJOiv3ZwoxvzVj04fK5mvheMhiGJILHL/G9wXTM 85pPTE90L6o+gG+uulBcd688lWhsNPvAwiWnnwDgdw5qoGdlig4fPM1y/GS/PBtj IpIwKKpt/B6RxPCvZl0O5KmSRU8FUS+5USr0Tqh7PJ5qOUe75ZvQARW39+SLxc24 G9dOu45cEq+RFm93hFwS6h+GmVXWsroB0Bd4MDCQUCFJWstJvoa0EcA0/w5+8jzh eTX3CIGnesqvxgoyPFX4mbWZ1jkveXeJiwMEn4BI+Gq2wLmircV9RInB8aIOdd8s QFvI4bQQJr4mroBlqmRLST/HeOVDJebWS8EKakaU5M1Q6VeUeOVZ2BKhsqCFsUDd YQe1Uv4369xps+PnuMyHMGoUvdKH1eZoDjxtaQMfE0m3B8GC3MM= =G+/d -----END PGP SIGNATURE----- --Sig_/+Uhys04BsCsXfZWNXaRn1/f--