From nobody Mon Apr 29 05:54:05 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1571438243; cv=none; d=zoho.com; s=zohoarc; b=G6+x0q1N8tULKVdqxSm1vwQZaO1atJJMBpDiUFgPY9ENb98qd+Y0U0vnJQUxYS3r2Darv2SoSeu3Yd9PBHrbOgVa272eHgq84gewUC2jh3YGxE6xHo2M99jVFTHM0NFXYGQPgvVTPRQJcoZLNweE4r5AACAhgviWPgR3zKLsPXE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1571438243; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=ir4+Iy3t9uBFXhQrybN1qWqX7elJAlJISbd0AD7MY2g=; b=VccY8IBQBJAuH8bd9SNiXGZIPxmfyVr7JN3ug3lbKfFCrFsxkjOJgB/Dw3wyEZq+zi/yFZQLmotLzSOxSgXYztzPNYiZ6MRTkuZwhdYsn4d5RqYgjwzsEIeb9w14Q7RrzAZU5DJmBO2Nkvc/4w50OEPK7saI5eODCyYHE/vkZ/M= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1571438243465439.1503952793238; Fri, 18 Oct 2019 15:37:23 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 789357BDA6; Fri, 18 Oct 2019 22:37:21 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 50667600D1; Fri, 18 Oct 2019 22:37:21 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id DB6374EE68; Fri, 18 Oct 2019 22:37:20 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x9IMa6Ia025008 for ; Fri, 18 Oct 2019 18:36:07 -0400 Received: by smtp.corp.redhat.com (Postfix) id F10EF5C21A; Fri, 18 Oct 2019 22:36:06 +0000 (UTC) Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21]) by smtp.corp.redhat.com (Postfix) with ESMTP id 370925C1B5 for ; Fri, 18 Oct 2019 22:36:03 +0000 (UTC) From: =?UTF-8?q?J=C3=A1n=20Tomko?= To: libvir-list@redhat.com Date: Sat, 19 Oct 2019 00:36:35 +0200 Message-Id: <261f1cff5bae8f37fa6d3d53c21f48e67b53b971.1571438015.git.jtomko@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 01/16] docs: hacking: remove note about rename detection X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.26]); Fri, 18 Oct 2019 22:37:21 +0000 (UTC) It has been enabled by default for over three years now: commit 5d2a30d7d8777319c745804f040fa405d02169ce Author: Junio C Hamano CommitDate: 2016-04-03 10:29:22 -0700 Merge branch 'mm/diff-renames-default' https://github.com/git/git/commit/5d2a30d7d8777319c745804f040fa405d02169ce Signed-off-by: J=C3=A1n Tomko Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/hacking.html.in | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 981b782d31..1da2cbbd9f 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -29,11 +29,7 @@ file from zanata.

=20 -

  • Post patches using git send-email, with git - rename detection enabled. You need a one-time setup of:

    -
    -  git config diff.renames true
-
    +

  • Post patches using git send-email.

    Also, for code motion patches, you may find that git diff --patience provides an easier-to-read patch. However, the usual workflow of libvirt developer is:

    --=20 2.21.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Mon Apr 29 05:54:05 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1571438247; cv=none; d=zoho.com; s=zohoarc; b=DUI1ktUxHtgLnubPZ//IgTjXtyzLc/u4254op3uk+fjfa9zYkB5gAYEUxrtTCKWg6WzhC+hcjx0T52/oyjG1IGN0oXMVByt0ig/7DLqn/P02owf5IR+1CRHVRb09+nsolFZ3YbGuQXXegbvEdQ2sDAseuDLI2cMSsZjDXtzqeLs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1571438247; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=+q2Y19GEFZiFa6AED+73lWtx+pXUVkZ/95xzwUjA62g=; b=BdRTfp54OULftLqjNBNQgIMNxZtd4919zHXRlrOPsuEvUBISC59HemPyu21V5rbfMKzkk2BCfjbZ+FvGbFs0agBKVStxgVObOWa2JaXYxARj0Npg81GIoCQluQLZvOtQpUNYOHLh5XHxdAhpVCEr8S5/YZcx9ikeSZeaGpF3KgU= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1571438247044447.75146844799565; Fri, 18 Oct 2019 15:37:27 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 2C877307C65A; Fri, 18 Oct 2019 22:37:25 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 08D6D5D70E; Fri, 18 Oct 2019 22:37:25 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id BA89E180B536; Fri, 18 Oct 2019 22:37:24 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x9IMa8rK025016 for ; Fri, 18 Oct 2019 18:36:08 -0400 Received: by smtp.corp.redhat.com (Postfix) id 346665C21A; Fri, 18 Oct 2019 22:36:08 +0000 (UTC) Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21]) by smtp.corp.redhat.com (Postfix) with ESMTP id 65CB15C1B5 for ; Fri, 18 Oct 2019 22:36:07 +0000 (UTC) From: =?UTF-8?q?J=C3=A1n=20Tomko?= To: libvir-list@redhat.com Date: Sat, 19 Oct 2019 00:36:36 +0200 Message-Id: <6a78c910d2a2373a493e9cc68de41895ff22eb24.1571438015.git.jtomko@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 02/16] docs: hacking: mention git-publish prominently X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.42]); Fri, 18 Oct 2019 22:37:25 +0000 (UTC) This tool takes care of many of the tedious parts of submitting a patch. Mention it first, above the "manual" way using git send-email. Signed-off-by: J=C3=A1n Tomko Cc: Stefan Hajnoczi Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/hacking.html.in | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 1da2cbbd9f..42c8596abe 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -29,7 +29,11 @@ file from zanata.

    • =20 -

  • Post patches using git send-email.

    +

  • The simplest way to send patches is to use the + git-publ= ish + tool. All libvirt-related repositories contain a config file that + tells git-publish to use the correct mailing list and subject pref= ix.

    +

    Alternatively, you may send patches using git send-email<= /code>.

    Also, for code motion patches, you may find that git diff --patience provides an easier-to-read patch. However, the usual workflow of libvirt developer is:

    --=20 2.21.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Mon Apr 29 05:54:05 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1571438320; cv=none; d=zoho.com; s=zohoarc; b=M+LFSs6nR79BwFFZhyLR5yZbsTvFMPK2hNVIcQNUKcf7RdZebeMxad8VewnlTjxiy3226YhT3/np2qKfYmd3A9W7kon08bq3s3l1TO6Eddq+Fr4CeA3zmGtHQvbdjaPLsmBW1jdEc9RdUXA88c9iJBPPYwnuD+Jmaoio38U4flM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1571438320; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=QS+0ANxQLUtWI6iXHQ72mgfhh78jcPU5B72NRFLvMww=; b=ccRTyOKfRwMvTGiAuYvTaeEubib9fUigYDzy26spIjbZfS2lOl/mDoBcuDuCltwp5sqIhEsVyvun1ltPUyRbTrze3TgFdBnsVUnc1iiPt2qWtgtRDbRll9h4N48keUs+irwposrqLb+fpzqqkkrN1H/udHPoh/J/UqDuZYH8QOY= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1571438320759500.2953724102059; Fri, 18 Oct 2019 15:38:40 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id DD95C2B8C; Fri, 18 Oct 2019 22:38:36 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id B1CF87E33; Fri, 18 Oct 2019 22:38:36 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 75F29180085A; Fri, 18 Oct 2019 22:38:36 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x9IMa9TA025024 for ; Fri, 18 Oct 2019 18:36:09 -0400 Received: by smtp.corp.redhat.com (Postfix) id 91A965C21A; Fri, 18 Oct 2019 22:36:09 +0000 (UTC) Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21]) by smtp.corp.redhat.com (Postfix) with ESMTP id DDBA15C1B5 for ; Fri, 18 Oct 2019 22:36:08 +0000 (UTC) From: =?UTF-8?q?J=C3=A1n=20Tomko?= To: libvir-list@redhat.com Date: Sat, 19 Oct 2019 00:36:37 +0200 Message-Id: <9a19335222aeec4cd13f4f37e3c9964ccae91214.1571438015.git.jtomko@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 03/16] docs: hacking: emphasize some sections X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.6.2 (mx1.redhat.com [10.5.110.71]); Fri, 18 Oct 2019 22:38:37 +0000 (UTC) Namely: * holding up the first-time patch submissions for moderation, which might cause first-time submitters to question the process * not CC-ing individual developers Signed-off-by: J=C3=A1n Tomko Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/hacking.html.in | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 42c8596abe..71a6ccc18b 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -72,8 +72,8 @@

    As a rule, patches should be sent to the mailing list only: all developers are subscribed to libvir-list and read it regularly, so - please don't CC individual developers unless they've explicitly - asked you to.

    + please don't CC individual developers unless + they've explicitly asked you to.

    Avoid using mail clients for sending patches, as most of them will mangle the messages in some way, making them unusable for our purposes. Gmail and other Web-based mail clients are particularly @@ -81,9 +81,10 @@

    If everything went well, your patch should show up on the libvir-li= st archives in a matter of minutes; if you still can't find it on - there after an hour or so, you should double-check your setup. No= te - that your very first post to the mailing list will be subject to - moderation, and it's not uncommon for that to take around a day. + there after an hour or so, you should double-check your setup. + Note that your very first post to the mailing list will be + subject to moderation, and it's not uncommon for that to + take around a day.

    Please follow this as close as you can, especially the rebase a= nd git send-email part, as it makes life easier for other developers to review your patch set.

    --=20 2.21.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Mon Apr 29 05:54:05 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1571438321; cv=none; d=zoho.com; s=zohoarc; b=L7u0+28TwIZqZjpbc8lCTzkT82FuUG4wffBJ3aU2xnqx7aYHlCpwn1VWXUTdNfM5Tn68ZDUSI+eRYB25/VF28lA+TeyH3Mh/5ZZPh7z8MO+fnYRN5FER6TH8lSIMYo9NUhQ0QpPlq75LId4nJQzv6ZkePLWHwtUmSkakKfzmYzg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1571438321; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=0HPM29tHsyTDc0BccE6ifVHbBxJV1YFeAo/qy3x8ijM=; b=CipthKY7AFXBpj+MwTp5fFiQyhTkXKWjmiNfJ+HXYmC28nit7CcQWxPzDnEDQoOuejgPDPYQg5Ea8hk0z2z7lfwYN0cKESAwkt3F3Q7NyoDwVxcAuHpr63QhflRpTAQJzLK/48u2kgBLeDUbPab64vnHj/Rb9ofb97mEiZW+lyQ= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1571438321816756.592617128965; Fri, 18 Oct 2019 15:38:41 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 11C8EC03D478; Fri, 18 Oct 2019 22:38:40 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id DDAE17E36; Fri, 18 Oct 2019 22:38:39 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id A17BD3FB42; Fri, 18 Oct 2019 22:38:39 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x9IMaAGS025038 for ; Fri, 18 Oct 2019 18:36:11 -0400 Received: by smtp.corp.redhat.com (Postfix) id EED525C21A; Fri, 18 Oct 2019 22:36:10 +0000 (UTC) Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21]) by smtp.corp.redhat.com (Postfix) with ESMTP id 16F0E5C1B5 for ; Fri, 18 Oct 2019 22:36:09 +0000 (UTC) From: =?UTF-8?q?J=C3=A1n=20Tomko?= To: libvir-list@redhat.com Date: Sat, 19 Oct 2019 00:36:38 +0200 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 04/16] docs: hacking: remove notes about -Werror X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Fri, 18 Oct 2019 22:38:40 +0000 (UTC) Our HACKING file is clear about requiring submission from a git checkout, which automatically enables -Werror. Remove the mentions of explicitly enabling it to alleviate the collective cognitive encumbrance. Signed-off-by: J=C3=A1n Tomko Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/hacking.html.in | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 71a6ccc18b..d8f748626e 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -140,14 +140,7 @@
    • =20

  • Run the automated tests on your code before submitting any ch= anges. - In particular, configure with compile warnings set to - -Werror. This is done automatically for a git checkout; from a - tarball, use:

    -
    -  ./configure --enable-werror
-
    -

    - and run the tests: + That is: 

       make check
@@ -1473,14 +1466,7 @@ int foo()
       how things work, it's better
       to wait for a more authoritative feedback though. Before committing,=
 please
       also rebuild locally, run 'make check syntax-check', and make sure y=
ou
-      don't raise errors. Try to look for warnings too; for example,
-      configure with
-    
    
-
    -  --enable-compile-warnings=3Derror
-
    
-    
    
-      which adds -Werror to compile flags, so no warnings get missed
+      don't raise errors.
     
    
=20
     
    
--=20
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Mon Apr 29 05:54:05 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1571438250; cv=none;
	d=zoho.com; s=zohoarc;
	b=QoxO/KvLQKm6j9ehW6slPoQNuTm6j858xd6IiawS33IMeF4KpR1RrlldaeO95HNbqRc2w8YUSV68ObQmC24m2XPlDsx8p6/+8bZ2axocawpYJttyt+4HZbJLVtmOrWPYkbiJn3VEYrhHgNDV4mS3ZbzDoK7BS9qveU8We/ph0ts=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
 s=zohoarc;
	t=1571438250;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=xwpNedlz/AAsZTOeJAmBOi0UjZQRtdN2p8BXdKGfwyw=;
	b=UNsH1pUkm4tHFW2m+wC/tm2ueOL41O/7rducKI7BuRQxuiyT0aRm/kDwsLc7qYTeuJcZ2siBSzEtu4pNuhxinrxwMEX9b20ZlzPFCoy9JA5JcMnBEpeRMX1xbalIjrFc07zyGJ2kKGdktiSawMtZ7hZXsJuouHNEswjW+fb/XTk=
ARC-Authentication-Results: i=1; mx.zoho.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from= (p=none dis=none)
 header.from=
Return-Path: 
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1571438250433972.6538389873293;
 Fri, 18 Oct 2019 15:37:30 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com
 [10.5.11.15])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id 88CDD30833CB;
	Fri, 18 Oct 2019 22:37:28 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id 5F0DD5D71C;
	Fri, 18 Oct 2019 22:37:28 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id 25E914EE6A;
	Fri, 18 Oct 2019 22:37:28 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
	[10.5.11.16])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id x9IMaEQL025058 for ;
	Fri, 18 Oct 2019 18:36:14 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id 3867E5C1B5; Fri, 18 Oct 2019 22:36:14 +0000 (UTC)
Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 5BCF05C21A
	for ; Fri, 18 Oct 2019 22:36:11 +0000 (UTC)
From: =?UTF-8?q?J=C3=A1n=20Tomko?= 
To: libvir-list@redhat.com
Date: Sat, 19 Oct 2019 00:36:39 +0200
Message-Id: 
 <1220ea75acbba314ef05e05c27718eeb291e6cf2.1571438015.git.jtomko@redhat.com>
In-Reply-To: 
References: 
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH 05/16] docs: hacking: demonstrate the powers of
	VIR_TEST_RANGE
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	
List-Unsubscribe: ,
	
List-Archive: 
List-Post: 
List-Help: 
List-Subscribe: ,
	
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.44]);
 Fri, 18 Oct 2019 22:37:29 +0000 (UTC)

Mention a more complex example.

Invoke the test without 'make' since the mentioned example
does not seem to be working anymore.

Signed-off-by: J=C3=A1n Tomko 
Reviewed-by: Daniel P. Berrang=C3=A9 
---
 docs/hacking.html.in | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index d8f748626e..1e16813868 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -178,12 +178,13 @@
=20
         
    
           When debugging failures during development, it is possible
-          to focus in on just the failing subtests by using TESTS and
-          VIR_TEST_RANGE:
+          to focus in on just the failing subtests by using
+          VIR_TEST_RANGE. I.e. to run all tests from 3 to 20 with the
+          exception of tests 6 and 16, use:
         
    
=20
 
    -  make check VIR_TEST_DEBUG=3D1 VIR_TEST_RANGE=3D3-5 TESTS=3Dqemuxml2argvt=
est
+  VIR_TEST_DEBUG=3D1 VIR_TEST_RANGE=3D3-5,7-20,^16 ./run tests/qemuxml2arg=
vtest
 
    
=20
         
    
--=20
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Mon Apr 29 05:54:05 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1571438253; cv=none;
	d=zoho.com; s=zohoarc;
	b=CGo3Yp/dymv3I3+toc6bo0Ahxe6c1Jcsq4nWFYWRysBWF4Bb1d4jtohcLxG1bEZK3WAkBzaYDZDkLkxhKgS8Z1TuGR9RYy/UAzbqd5PuMaWm3OVfcfVkZ4RQWp3yBhGrh4lcOGXC0AhcOYM3pNspz3kiJOcBWB+29dN1Bp4Lmxc=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
 s=zohoarc;
	t=1571438253;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=MSCVpyMM2T1LHDJWZgzCB174T8pqu9Ra4bNdRuXaPwM=;
	b=mWDW1aSZDhNNUYGWnkJdBGH3IG0jSzB+z5NmesS4WhgWyTqIVwUGhxrHwvFLCsLBTnOkW4rHkNRL2Qw1p3IxG827DJhnWdpq37js+cf3VkN98xflbcm6gYWMZ+wr8F9ST5vDsQCzmsTR5TTeiIbpHwDTOiTM8l6bhFbY74ZJuSQ=
ARC-Authentication-Results: i=1; mx.zoho.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from= (p=none dis=none)
 header.from=
Return-Path: 
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1571438253867518.058557082549;
 Fri, 18 Oct 2019 15:37:33 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com
 [10.5.11.22])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id 176AC308A9E0;
	Fri, 18 Oct 2019 22:37:32 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id E5712100EBD5;
	Fri, 18 Oct 2019 22:37:31 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id A014B18037C9;
	Fri, 18 Oct 2019 22:37:31 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
	[10.5.11.16])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id x9IMaFro025067 for ;
	Fri, 18 Oct 2019 18:36:15 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id A6BF15C21A; Fri, 18 Oct 2019 22:36:15 +0000 (UTC)
Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21])
	by smtp.corp.redhat.com (Postfix) with ESMTP id CD2BF5C1B5
	for ; Fri, 18 Oct 2019 22:36:14 +0000 (UTC)
From: =?UTF-8?q?J=C3=A1n=20Tomko?= 
To: libvir-list@redhat.com
Date: Sat, 19 Oct 2019 00:36:40 +0200
Message-Id: 
 
In-Reply-To: 
References: 
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH 06/16] docs: hacking: extend the table of removed
	libvirt macros
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	
List-Unsubscribe: ,
	
List-Archive: 
List-Post: 
List-Help: 
List-Subscribe: ,
	
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.41]);
 Fri, 18 Oct 2019 22:37:32 +0000 (UTC)

Mention the various ATTRIBUTE* macros and ARRAY_CARDINALITY
that were removed earlier.

Signed-off-by: J=C3=A1n Tomko 
Reviewed-by: Daniel P. Berrang=C3=A9 
---
 docs/hacking.html.in | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 1e16813868..b270aa69e3 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -1072,6 +1072,14 @@ BAD:
         VIR_STEAL_PTRg_steal_pointer
             a =3D f(&b) instead of f(a, b)
         VIR_RETURN_PTRreturn g_steal_p=
ointer
+        ARRAY_CARDINALITYG_N_ELEMENTS<=
/code>
+        ATTRIBUTE_FALLTHROUGHG_GNUC_FA=
LLTHROUGH
+        ATTRIBUTE_FMT_PRINTFG_GNUC_PRI=
NTF
+        ATTRIBUTE_NOINLINEG_GNUC_NO_IN=
LINE
+        ATTRIBUTE_NORETURNG_GNUC_NORET=
URN
+        ATTRIBUTE_RETURN_CHECKG_GNUC_W=
ARN_UNUSED_RESULT
+        ATTRIBUTE_SENTINELG_GNUC_NULL_=
TERMINATED
+        ATTRIBUTE_UNUSEDG_GNUC_UNUSED<=
/code>
     
=20
=20
--=20
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Mon Apr 29 05:54:05 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1571438325; cv=none;
	d=zoho.com; s=zohoarc;
	b=NP58+xOrGqLXa09f8Ai3aTkxzsOvirwQ4vVl241mIat4x9UGu5qov6VkrDuYmkfp9xx1bzyY4ataONbYjYldijWFa8MyoeeoJCBLGCPnmjh8Y/J9ddDHS1x+s9G+qq8nH6kM+Wwv6JHBaOBpcGvAYficBb1AeJcTOLYUjVV+pNI=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
 s=zohoarc;
	t=1571438325;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=buYqjQClzHoUTKmjxALbS+25vBDemKEMCQDGPS4T1/c=;
	b=oU4ShxPAoA3UuxO7aky9tWuRwxArhFTyDyVKrwI/7nK3C9THEpkK3PHtDfDQF2QykUZKrUNmBHROmPG8oK/NFLQbt5uQjibnrayQ2DcBxjeJmnGRtXiRk2U5n73LwJENMFPBwKaIiNlzAp6gcoU7pOqCv8yF8lFQZi0BTrUZ1pQ=
ARC-Authentication-Results: i=1; mx.zoho.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from= (p=none dis=none)
 header.from=
Return-Path: 
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1571438325225545.2730533045021;
 Fri, 18 Oct 2019 15:38:45 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com
 [10.5.11.22])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id B5644307BD26;
	Fri, 18 Oct 2019 22:38:43 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id 90FCE100164D;
	Fri, 18 Oct 2019 22:38:43 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id 4B9BB3FB48;
	Fri, 18 Oct 2019 22:38:43 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
	[10.5.11.16])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id x9IMaHuT025079 for ;
	Fri, 18 Oct 2019 18:36:17 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id 36C665C21A; Fri, 18 Oct 2019 22:36:17 +0000 (UTC)
Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 4EC0B5C1B5
	for ; Fri, 18 Oct 2019 22:36:16 +0000 (UTC)
From: =?UTF-8?q?J=C3=A1n=20Tomko?= 
To: libvir-list@redhat.com
Date: Sat, 19 Oct 2019 00:36:41 +0200
Message-Id: 
 
In-Reply-To: 
References: 
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH 07/16] docs: hacking: mention compiler annotations
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	
List-Unsubscribe: ,
	
List-Archive: 
List-Post: 
List-Help: 
List-Subscribe: ,
	
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.49]);
 Fri, 18 Oct 2019 22:38:44 +0000 (UTC)

Mention all the __atribute__ annotations we use to make the compiler
and/or the static analysis tools understand the code better.

Signed-off-by: J=C3=A1n Tomko 
Reviewed-by: Daniel P. Berrang=C3=A9 
---
 docs/hacking.html.in | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index b270aa69e3..ad0f595897 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -984,6 +984,25 @@ BAD:
       it points to, or it is aliased to another pointer that is.
     
    
=20
+    
    Attribute annotations
    
+    
    
+      Use the following annotations to help the compiler and/or static
+      analysis tools understand the code better:
+    
    
+
+    
+        
+        
+        
+        
+        
+        
+        
+        
+        
+        
+    
    MacroMeaning
    ATTRIBUTE_NONNULLpassing NULL for th=
is parameter is not allowed
    ATTRIBUTE_PACKEDforce a structure to=
 be packed
    G_GNUC_FALLTHROUGHallow code reuse b=
y multiple switch cases
    G_GNUC_NO_INLINEthe function is mock=
ed in the test suite
    G_GNUC_NORETURNthe function never re=
turns
    G_GNUC_NULL_TERMINATEDlast parameter=
 must be NULL
    G_GNUC_PRINTFvalidate that the forma=
tting string matches parameters
    G_GNUC_UNUSEDparameter is unused in =
this implementation of the function
    G_GNUC_WARN_UNUSED_RESULTthe return =
value must be checked
    
+
     
    Adoption of GLib APIs
    
=20
     
    
--=20
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Mon Apr 29 05:54:05 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1571438257; cv=none;
	d=zoho.com; s=zohoarc;
	b=MYKejWmch/z4dTVx0X3U96W04MkgMv4P+I3RdHYvNr5QMXm2CmJ01aezZwKbD6cSiDqxN1jq52zlgA933sjvDF2KhNUj1BG8InbTGM6/PDOlVydRvVrEA6O5NoK7V8q8LDBp7/12CR9Rx/U5wrR9hliq3BBl7xrWdHGmO3c2VSY=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
 s=zohoarc;
	t=1571438257;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=1nRchqpX5a7KyFjqwoaqHi3P0CMKAkArjQJz280ODuw=;
	b=kW8Ek+9t8dHozfg0Yd6XYyl3l1/3MMNlXT6ZdaJ6N0qBa26QQEU26d+/E3FoYQ81JpcQ9kNdEogrc+BohRSNYqCxPJ1CUWNa1blHfa517wWi8SPOv2V4CsNDsUmY1kPTWgxlVxDoUogASBydUJyBVpQxm3ss1YsRQI7w4uzCojM=
ARC-Authentication-Results: i=1; mx.zoho.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from= (p=none dis=none)
 header.from=
Return-Path: 
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1571438257546606.47624643977;
 Fri, 18 Oct 2019 15:37:37 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com
 [10.5.11.15])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id 661E32DA981;
	Fri, 18 Oct 2019 22:37:35 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id 3D38E5D713;
	Fri, 18 Oct 2019 22:37:35 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id E9B984EE6D;
	Fri, 18 Oct 2019 22:37:34 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
	[10.5.11.16])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id x9IMaIC7025092 for ;
	Fri, 18 Oct 2019 18:36:18 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id B94E55C21A; Fri, 18 Oct 2019 22:36:18 +0000 (UTC)
Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21])
	by smtp.corp.redhat.com (Postfix) with ESMTP id DBE645C1B5
	for ; Fri, 18 Oct 2019 22:36:17 +0000 (UTC)
From: =?UTF-8?q?J=C3=A1n=20Tomko?= 
To: libvir-list@redhat.com
Date: Sat, 19 Oct 2019 00:36:42 +0200
Message-Id: 
 
In-Reply-To: 
References: 
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH 08/16] docs: hacking: mention GLib alternatives of
	libvirt allocation macros
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	
List-Unsubscribe: ,
	
List-Archive: 
List-Post: 
List-Help: 
List-Subscribe: ,
	
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.29]);
 Fri, 18 Oct 2019 22:37:35 +0000 (UTC)

Document the preferred alternatives to existing libvirt macros for
memory allocation. These cannot be deleted just yet because
converting them will require a lot of work.

Signed-off-by: J=C3=A1n Tomko 
---
 docs/hacking.html.in | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index ad0f595897..f39f6433d4 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -1050,6 +1050,27 @@ BAD:
       
    virStrerror
    
       
    The GLib g_strerror() function should be used inste=
ad,
         which has a simpler calling convention as an added benefit.
    
+
+    
+        =

+        
+            
+        
+        
+            
+        
+            
+        
+            
+        
+            
+        
+            
+        
+            
+        
+            
+    
    deprecated versionGLib versionNotes
    VIR_ALLOC(var)g_new(var_t, 1)<=
/code>yes, you need to tell it the type explicitly
    VIR_ALLOC_Ng_new0(var_t, n)
    VIR_REALLOC_Ng_renew(var_t, pt=
r, n)the newly added memory is not zeroed
    VIR_EXPAND_Ng_renew(var_t, ptr=
, n)zero the new memory manually or use an array type
    VIR_SHRINK_Nno alternative
    VIR_APPEND_ELEMENTg_array_appe=
nd_valg_ptr_array_add or g_byte_array_append<=
/code>
    VIR_INSERT_ELEMENTg_array_inse=
rt_valg_ptr_array_insert
    VIR_DELETE_ELEMENTg_array_remo=
ve_indexg_ptr_array_remove_index or g_byte_arra=
y_remove_index
    VIR_FREEg_freeg_free does not zero the pointer
    
     
=20
     
    
--=20
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Mon Apr 29 05:54:05 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1571438328; cv=none;
	d=zoho.com; s=zohoarc;
	b=Qwb+9MbJ6Sr3wInpqoF8YjLAGxELmJn7N+ZLuwF5awLbtDaZxGHkuMNGv29beTvNeo+3Lg3/NRLfhsQiiFlksVNMvclgiRm7dhAH2HT4AqIOLYvC4sozkpr9spcjMCvGYWGxz25VWN6Pvdliuop/7HrwccH7aYlqu/1JaViZp5I=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
 s=zohoarc;
	t=1571438328;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=dyvJH17TGVC2dfprF29HbOArujqaPMXcU0jqTuIFA1c=;
	b=Cw9Nd0qehz3IUuYQ/zy5jwz/HNxszzlqYTSopsMvWlfniZXkGZGfqOWpm1epW/pW7v1oeVJgew/RtPfyrNNrhQ9NW+6n3R9asqS2nbIpRaZTT+dJ1c5sXu11hYUpfYqp4vPdF6m7Z8yC2LhFBSzQ7CPtbZHiFo/25Ev2WFhyINU=
ARC-Authentication-Results: i=1; mx.zoho.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from= (p=none dis=none)
 header.from=
Return-Path: 
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1571438328615309.5594268495147;
 Fri, 18 Oct 2019 15:38:48 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com
 [10.5.11.22])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id 12CE5307C659;
	Fri, 18 Oct 2019 22:38:47 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id DDEE51001938;
	Fri, 18 Oct 2019 22:38:46 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id A07F9180B76F;
	Fri, 18 Oct 2019 22:38:46 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
	[10.5.11.16])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id x9IMaMfF025109 for ;
	Fri, 18 Oct 2019 18:36:22 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id 6C8FA5C21A; Fri, 18 Oct 2019 22:36:22 +0000 (UTC)
Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 71DCB5C1B5
	for ; Fri, 18 Oct 2019 22:36:19 +0000 (UTC)
From: =?UTF-8?q?J=C3=A1n=20Tomko?= 
To: libvir-list@redhat.com
Date: Sat, 19 Oct 2019 00:36:43 +0200
Message-Id: 
 
In-Reply-To: 
References: 
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH 09/16] docs: hacking: mention GLib alternatives of
	libvirt string allocation macros
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	
List-Unsubscribe: ,
	
List-Archive: 
List-Post: 
List-Help: 
List-Subscribe: ,
	
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.42]);
 Fri, 18 Oct 2019 22:38:47 +0000 (UTC)

Document the preferred alternatives to existing libvirt macros for
allocating strings. These cannot be deleted just yet because
converting them will require a lot of work.

Signed-off-by: J=C3=A1n Tomko 
Reviewed-by: Daniel P. Berrang=C3=A9 
---
 docs/hacking.html.in | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index f39f6433d4..d4f1c2baad 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -1071,6 +1071,18 @@ BAD:
         VIR_FREEg_free
             g_free does not zero the pointer
     
+
+    
    String allocation macros and functions:
    
+    
+        =

+        =

+        
+        
+        
+            
+        
+    
    deprecated versionGLib versionNotes
    VIR_STRDUPg_strdup
    VIR_STRNDUPg_strndup
    virAsprintfg_strdup_printf
    virVasprintfg_strdup_vprintuse g_vasprintf if you really need to know th=
e returned length
    virStrerrorg_strerror
+            the error strings are cached globally so no need to free i=
t
    
     
=20
     
    
--=20
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Mon Apr 29 05:54:05 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1571438260; cv=none;
	d=zoho.com; s=zohoarc;
	b=TbDxDSmnLiHsUgvY5iZ+DnN/2tdADYfBs44hh+Cc287CjW154/y6Gsbf2NgYhoTcFVv4PQRX0EeOw2/03HyJCZf20svSnJth44sI+djmQr8CfFKh27kbj8+DRsSFVMVLYpb77p4tBJ6t3i9l9pNl7HeHVyDXerJpn71Bt/QWGx0=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
 s=zohoarc;
	t=1571438260;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=LHTmLMc0S4TW8TO1zS7ObJaTI4q3EOwcgKJ2oS5NtFE=;
	b=jTmpUGtb2/70/DKf+d0mzWeOo1iwDoK/GQo8NGR4I0vwAZdc6N+r2Iyu3cHGGMnYqPwoO8oBJAemvDWSNDYMcnxGp0FL9z0TAl7QKZicFKpKzx3uijVsntNIXRkKA2GzyX54VFx8SwwPz8iB6KL2w16NPwAHFMSd1Bumqbxnu4E=
ARC-Authentication-Results: i=1; mx.zoho.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from= (p=none dis=none)
 header.from=
Return-Path: 
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1571438260310942.4202956905899;
 Fri, 18 Oct 2019 15:37:40 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com
 [10.5.11.12])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id CD89F302C096;
	Fri, 18 Oct 2019 22:37:38 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id 9E2D860C63;
	Fri, 18 Oct 2019 22:37:38 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id 575114EE71;
	Fri, 18 Oct 2019 22:37:38 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
	[10.5.11.16])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id x9IMaObQ025115 for ;
	Fri, 18 Oct 2019 18:36:24 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id 0741E5C21A; Fri, 18 Oct 2019 22:36:24 +0000 (UTC)
Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 1F1BF5C1B5
	for ; Fri, 18 Oct 2019 22:36:22 +0000 (UTC)
From: =?UTF-8?q?J=C3=A1n=20Tomko?= 
To: libvir-list@redhat.com
Date: Sat, 19 Oct 2019 00:36:44 +0200
Message-Id: 
 
In-Reply-To: 
References: 
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH 10/16] docs: hacking: document preferred strdup
	alternatives
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	
List-Unsubscribe: ,
	
List-Archive: 
List-Post: 
List-Help: 
List-Subscribe: ,
	
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.46]);
 Fri, 18 Oct 2019 22:37:39 +0000 (UTC)

Recommend g_str(n)dup instead of VIR_STRDUP.

Signed-off-by: J=C3=A1n Tomko 
Reviewed-by: Daniel P. Berrang=C3=A9 
---
 docs/hacking.html.in | 16 ++++++----------
 1 file changed, 6 insertions(+), 10 deletions(-)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index d4f1c2baad..d6a4f04ad0 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -1274,18 +1274,14 @@ BAD:
     
    
=20
 
    -  VIR_STRDUP(char *dst, const char *src);
-  VIR_STRNDUP(char *dst, const char *src, size_t n);
+    dst =3D g_strcpy(src);
+    dst =3D g_strncpy(src, n)
 
    
     
    
-      You should avoid using strdup or strndup directly as they do not rep=
ort
-      out-of-memory error, and do not allow a NULL source. Use
-      VIR_STRDUP or VIR_STRNDUP macros instead, which return 0 for
-      NULL source, 1 for successful copy, and -1 for allocation
-      failure with the error already reported. In very
-      specific cases, when you don't want to report the out-of-memory erro=
r, you
-      can use VIR_STRDUP_QUIET or VIR_STRNDUP_QUIET, but such usage is ver=
y rare
-      and usually considered a flaw.
+      You should avoid using strdup or strndup directly as they do not han=
dle
+      out-of-memory errors, and do not allow a NULL source.
+      Use g_strcpy and g_strncpy from GLib which
+      abort on OOM and handle NULL source by returning NULL.
     
    
=20
     
    Variable length string buffer
    
--=20
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Mon Apr 29 05:54:05 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1571438287; cv=none;
	d=zoho.com; s=zohoarc;
	b=RvxzAg7oZ7S7udxNeByaoV1v1V0Ek9u1QwCL5QBqGLKRoj2JK0iCw5ZfKgjwG0NisAeHij9O30OePjbfhH98tlGCskL9/cnfEFBfjOZt7cSZk3XQGgzeUyqfqwNohBvXyBgwQcSIDmeXtC1ASe+unF8MTPCz8otOJoSY0RuevW8=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
 s=zohoarc;
	t=1571438287;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=VZwppaH2MtUeTE9/KwsEDisHx/XWr7KHw6NjXax89iY=;
	b=ZRYqMX516c0tcbu8FJPrl8pfiP0jx3UhbJwplNWoetgv/YyiTE0P4XO13W/xBOcpTlr1FRqctmjGzbFnsrXZi7NX/MdigtCvmMFeNxNUXq8kSbMezF8xq/AQ4SPWXKkkPAZhhdCciMqnaCjSZY02xIpsanqOHGf1VQ63+++GmDY=
ARC-Authentication-Results: i=1; mx.zoho.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from= (p=none dis=none)
 header.from=
Return-Path: 
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1571438287394658.556996688455;
 Fri, 18 Oct 2019 15:38:07 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com
 [10.5.11.12])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id CDE787575B;
	Fri, 18 Oct 2019 22:38:05 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id A214960BF4;
	Fri, 18 Oct 2019 22:38:05 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id 3B9F84EE96;
	Fri, 18 Oct 2019 22:38:05 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
	[10.5.11.16])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id x9IMaPqg025127 for ;
	Fri, 18 Oct 2019 18:36:25 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id 6810D5C21A; Fri, 18 Oct 2019 22:36:25 +0000 (UTC)
Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 87F3B5C1B5
	for ; Fri, 18 Oct 2019 22:36:24 +0000 (UTC)
From: =?UTF-8?q?J=C3=A1n=20Tomko?= 
To: libvir-list@redhat.com
Date: Sat, 19 Oct 2019 00:36:45 +0200
Message-Id: 
 <61c98f1d93530ed651a72c8dc7c5f9ac85324338.1571438015.git.jtomko@redhat.com>
In-Reply-To: 
References: 
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH 11/16] docs: hacking: document string
	concatenations
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	
List-Unsubscribe: ,
	
List-Archive: 
List-Post: 
List-Help: 
List-Subscribe: ,
	
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.25]);
 Fri, 18 Oct 2019 22:38:06 +0000 (UTC)

Recommend GString for generic strings and virBuffer for strings
that need helpers for other uses, like XML or command line
formatting.

Signed-off-by: J=C3=A1n Tomko 
Reviewed-by: Daniel P. Berrang=C3=A9 
---
 docs/hacking.html.in | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index d6a4f04ad0..384da96d60 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -1289,7 +1289,11 @@ BAD:
     
    
       If there is a need for complex string concatenations, avoid using
       the usual sequence of malloc/strcpy/strcat/snprintf functions and
-      make use of the virBuffer API described in virbuffer.h
+      make use of either the
+      GString
+      type from GLib.
+      If formatting XML or QEMU command line is needed, use the virBuffer
+      API described in virbuffer.h, since it has helper functions for thos=
e.
     
    
=20
     
    Typical usage is as follows:
    
@@ -1298,12 +1302,14 @@ BAD:
   char *
   somefunction(...)
   {
-     virBuffer buf =3D VIR_BUFFER_INITIALIZER;
+     g_auto(virBuffer) buf =3D VIR_BUFFER_INITIALIZER;
=20
      ...
=20
      virBufferAddLit(&buf, "<domain>\n");
      virBufferAsprintf(&buf, "  <memory>%d</memory>\n", me=
mory);
+     if (some_error)
+         return NULL; /* g_auto will free the memory used so far */
      ...
      virBufferAddLit(&buf, "</domain>\n");
=20
@@ -1387,12 +1393,10 @@ BAD:
     
    
=20
     
    
-      When printing to a string, consider using virBuffer for
-      incremental allocations, virAsprintf for a one-shot allocation,
-      and snprintf for fixed-width buffers.  Do not use sprintf, even
-      if you can prove the buffer won't overflow, since gnulib does
-      not provide the same portability guarantees for sprintf as it
-      does for snprintf.
+      When printing to a string, consider using GString or virBuffer for
+      incremental allocations, g_strdup_printf for a one-shot allocation,
+      and g_snprintf for fixed-width buffers.  Only use g_sprintf,
+      if you can prove the buffer won't overflow.
     
    
=20
     
    Error message format
    
--=20
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Mon Apr 29 05:54:05 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1571438290; cv=none;
	d=zoho.com; s=zohoarc;
	b=IiS2U12rekWUZdPTVbQHobtPtuUV0Xcj8FQNTn8EJe482ye+rrBmaevq4aF4oD5ICIpbOmoORBiKeBoJH5xO7QfIgYiBjGjrDkrbYrwPIkVU4YfMdiKryamFpeTFD/lUB/A6V6PdS8+WVFk5P+agd9LGmfWvssF2+dqYOjqgUkI=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
 s=zohoarc;
	t=1571438290;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=wWtKMkD7lSTfMiDB4WiB0DjAByKN0vj7ai72gJ0fUnU=;
	b=QNLFCB/Zb4uJXF+yHD8Tsk5tTqTb4HX5IAYzZzD00YagaYnGhSk5Mc1g14rMvX60aGzIauid8/K/IF2rq/q0f8aA1wZKlUGbuMetuyuxmrgQpnDGOBdkBBdwjUSZtbSJndNQorNcMuYSD/lrFlLIZ4AZtYXPpOIcJ2X568lpxKI=
ARC-Authentication-Results: i=1; mx.zoho.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from= (p=none dis=none)
 header.from=
Return-Path: 
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1571438290952420.2765547333481;
 Fri, 18 Oct 2019 15:38:10 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com
 [10.5.11.11])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id 366A230715F9;
	Fri, 18 Oct 2019 22:38:09 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id 0DBE760166;
	Fri, 18 Oct 2019 22:38:09 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id C38F84EEB8;
	Fri, 18 Oct 2019 22:38:08 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
	[10.5.11.16])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id x9IMaQa2025137 for ;
	Fri, 18 Oct 2019 18:36:26 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id E7F035C21A; Fri, 18 Oct 2019 22:36:26 +0000 (UTC)
Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 16E905C1B5
	for ; Fri, 18 Oct 2019 22:36:25 +0000 (UTC)
From: =?UTF-8?q?J=C3=A1n=20Tomko?= 
To: libvir-list@redhat.com
Date: Sat, 19 Oct 2019 00:36:46 +0200
Message-Id: 
 <6f37f3819e1a3747ee574e43f71628ab9d577b93.1571438015.git.jtomko@redhat.com>
In-Reply-To: 
References: 
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH 12/16] docs: hacking: remove reference to
	ATTRIBUTE_FORMAT
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	
List-Unsubscribe: ,
	
List-Archive: 
List-Post: 
List-Help: 
List-Subscribe: ,
	
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.49]);
 Fri, 18 Oct 2019 22:38:09 +0000 (UTC)

Prefer G_GNUC_PRINTF.

Also, pick another example than virAsprintf since it may get
removed in the future.

Signed-off-by: J=C3=A1n Tomko 
Reviewed-by: Daniel P. Berrang=C3=A9 
---
 docs/hacking.html.in | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 384da96d60..8c68cd1c3c 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -1378,12 +1378,12 @@ BAD:
       Whenever you add a new printf-style function, i.e., one with a format
       string argument and following "..." in its prototype, be sure to use
       gcc's printf attribute directive in the prototype.  For example, her=
e's
-      the one for virAsprintf, in util.h:
+      the one for virCommandAddEnvFormat in vircommand.h:
     
    
=20
 
    -  int virAsprintf(char **strp, const char *fmt, ...)
-      ATTRIBUTE_FORMAT(printf, 2, 3);
+  void virCommandAddEnvFormat(virCommandPtr cmd, const char *format, ...)
+      G_GNUC_PRINTF(2, 3);
 
    
=20
     
    
--=20
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Mon Apr 29 05:54:05 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1571438295; cv=none;
	d=zoho.com; s=zohoarc;
	b=Tw6HUsFab8LmVPPRVAJHasJ6Jpk7MewgJTHyWsrWusDXeah1xBm6w8zcC2dQ84JXwcky4q6tkEnaFtzEzOA/6iCq0UTgrJ9F8WNH2nITvLUQmjGwYW5cT+j9d1cNPcbe0zcAIvkjXRHklOGH7gvDoyL5n9jSi/vG11i97xHY7rg=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
 s=zohoarc;
	t=1571438295;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=+zvhrueO/0E0ahpyJgx4tSvbrUIWrgUVAqkQAQgl5Yo=;
	b=kMIqy4/wmWFDmE3Y/89gn/lQb8i68ACAhA5KwTtUMOmQJoTb2u2oob13BgKA1EzeZCoeTds8M0zI2SMJQjx9NYrqqJwvn1tsmHPlviByXbzE7SEyP2KBnGTKCkS/bhgP8j4Q2+VLb4162Lq3eM8udLfv3M5kG30TYia3W9oreN0=
ARC-Authentication-Results: i=1; mx.zoho.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from= (p=none dis=none)
 header.from=
Return-Path: 
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1571438295106566.7884721486421;
 Fri, 18 Oct 2019 15:38:15 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com
 [10.5.11.23])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id 05D25307B197;
	Fri, 18 Oct 2019 22:38:13 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id CE0F079B4;
	Fri, 18 Oct 2019 22:38:12 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id 83EEA180BA99;
	Fri, 18 Oct 2019 22:38:12 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
	[10.5.11.16])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id x9IMaSvf025149 for ;
	Fri, 18 Oct 2019 18:36:28 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id A6D5A5C21A; Fri, 18 Oct 2019 22:36:28 +0000 (UTC)
Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 8ECFF5C1B5
	for ; Fri, 18 Oct 2019 22:36:27 +0000 (UTC)
From: =?UTF-8?q?J=C3=A1n=20Tomko?= 
To: libvir-list@redhat.com
Date: Sat, 19 Oct 2019 00:36:47 +0200
Message-Id: 
 
In-Reply-To: 
References: 
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH 13/16] docs: hacking: extend goto documentation
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	
List-Unsubscribe: ,
	
List-Archive: 
List-Post: 
List-Help: 
List-Subscribe: ,
	
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.45]);
 Fri, 18 Oct 2019 22:38:13 +0000 (UTC)

Replace reference to VIR_FREE with g_free and mention the use
of g_auto cleanup attributes that eliminate most of label use.

Signed-off-by: J=C3=A1n Tomko 
Reviewed-by: Daniel P. Berrang=C3=A9 
---
 docs/hacking.html.in | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 8c68cd1c3c..7f608657b3 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -1446,11 +1446,16 @@ BAD:
       single label at the end of the function.  It's almost always ok
       to use this style.  In particular, if the cleanup code only
       involves free'ing memory, then having multiple labels is
-      overkill.  VIR_FREE() and every function named XXXFree() in
-      libvirt is required to handle NULL as its arg.  Thus you can
+      overkill.  g_free() and most of the functions named XXXFree() in
+      libvirt is required to handle NULL as its arg. This does not
+      apply to libvirt's public APIs. Thus you can
       safely call free on all the variables even if they were not yet
       allocated (yes they have to have been initialized to NULL).
       This is much simpler and clearer than having multiple labels.
+      Note that most of libvirt's type declarations can be marked with
+      either g_autofree or g_autoptr which uses
+      the compiler's __attribute__((cleanup)) that calls
+      the appropriate free function when the variable goes out of scope.
     
    
=20
     
    
--=20
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Mon Apr 29 05:54:05 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1571438331; cv=none;
	d=zoho.com; s=zohoarc;
	b=guy+96fW8NxzehU+vwdBJ75/Lcx0mQrxkfxgt7WpXfT8EbW2UB2Smd27SMm1uu6OFz87CTaHMTM9lrfyTkS+uA9IDKdcm+U6LP4VSRV0xVaTDLUxXOZnXRz1ztOJrHfBvKVNk5zSffdEcfA3aWaMtA4fG2OlVkB0b+vDU7ofbHA=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
 s=zohoarc;
	t=1571438331;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=gYa/qS1I7SqEqevmS38craQLJkDt42E8qfbxebE5U80=;
	b=J9Grm5zHMRptnrflfyGZhNfrPrRtKU8+w99KCN5OdTOlyPDXlkmFQ1lYutDfPShgFKjon9Ng1RGeVCR1hNiQRe/mlxJ+Fx+WQd4HtzHOrp51CQyz46spjVqhPKw/J7LhnlrIMrF5/5q56G7EYNGU5kUabkU2ipZ/9oo2UF/R4Y4=
ARC-Authentication-Results: i=1; mx.zoho.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from= (p=none dis=none)
 header.from=
Return-Path: 
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1571438331996331.3485562726662;
 Fri, 18 Oct 2019 15:38:51 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com
 [10.5.11.11])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id 74F9B69EE1;
	Fri, 18 Oct 2019 22:38:50 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id 3FF1160166;
	Fri, 18 Oct 2019 22:38:50 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id EFA8F180BA9D;
	Fri, 18 Oct 2019 22:38:49 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
	[10.5.11.16])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id x9IMaU54025162 for ;
	Fri, 18 Oct 2019 18:36:30 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id 0569B5C21A; Fri, 18 Oct 2019 22:36:30 +0000 (UTC)
Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 27B455C1B5
	for ; Fri, 18 Oct 2019 22:36:28 +0000 (UTC)
From: =?UTF-8?q?J=C3=A1n=20Tomko?= 
To: libvir-list@redhat.com
Date: Sat, 19 Oct 2019 00:36:48 +0200
Message-Id: 
 <428b1d87001f95e2d2b94e540c53224fbd847ded.1571438015.git.jtomko@redhat.com>
In-Reply-To: 
References: 
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH 14/16] docs: hacking: amend label indenting rules
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	
List-Unsubscribe: ,
	
List-Archive: 
List-Post: 
List-Help: 
List-Subscribe: ,
	
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.25]);
 Fri, 18 Oct 2019 22:38:51 +0000 (UTC)

Mention the possibility of relaxing the rule in the future.

Signed-off-by: J=C3=A1n Tomko 
Reviewed-by: Daniel P. Berrang=C3=A9 
---
 docs/hacking.html.in | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 7f608657b3..20127d6ece 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -1500,8 +1500,10 @@ BAD:
    =20

    - Top-level labels should be indented by one space (putting them on - the beginning of the line confuses function context detection in git): + Top-level labels are indented by one space, since no indentation + used to confuse function context detection in git. This rule may + be re-evaluated in the future since git handles it correctly now + and not all code formatting tools support this setting:

    =20 
    --=20
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
From nobody Mon Apr 29 05:54:05 2024
Delivered-To: importer@patchew.org
Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28
 as permitted sender) client-ip=209.132.183.28;
 envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com;
Authentication-Results: mx.zohomail.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass(p=none dis=none)  header.from=redhat.com
ARC-Seal: i=1; a=rsa-sha256; t=1571438335; cv=none;
	d=zoho.com; s=zohoarc;
	b=k5VMyvqkyLujUs1+yKVZSiVnBHvGcypp7UYD1+RGrplWUT5eao12j/Cp4zOQAwISqdag94/uoaVPrhT7sUD39J9wRMDvszDv9jGKuD6aLVYZev7Q2QpF+VNXjHVbDRUElceD8gPGS9lmJu2c0VX/0+d9NLsyxATZD1ZxgTg9ybA=
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com;
 s=zohoarc;
	t=1571438335;
 h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To;
	bh=dUWMhnpjgAYNjhR+YvCs8Ze26LK3k5RhJ37hpnnci2w=;
	b=gkRPPVNiZWaJM/VtkpzX9Dp1RXaH/HQTw/VQj92RpbAA1QAbSTSY2OJQ6G6NtfhNVYlmiVF+DNuB8aTdvcbHol55/75mxNsq107gTNWIDFJS6NmQyGYNBlJaSfybqFHTdspwUTdEMMJdSg+5l459wQ5tacj5T0EcnMtNrRhGsGU=
ARC-Authentication-Results: i=1; mx.zoho.com;
	spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as
 permitted sender)  smtp.mailfrom=libvir-list-bounces@redhat.com;
	dmarc=pass header.from= (p=none dis=none)
 header.from=
Return-Path: 
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by
 mx.zohomail.com
	with SMTPS id 1571438335951478.82124748390527;
 Fri, 18 Oct 2019 15:38:55 -0700 (PDT)
Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com
 [10.5.11.14])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id E8E2C58487;
	Fri, 18 Oct 2019 22:38:53 +0000 (UTC)
Received: from colo-mx.corp.redhat.com
 (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21])
	by smtp.corp.redhat.com (Postfix) with ESMTPS id C58B25D9D5;
	Fri, 18 Oct 2019 22:38:53 +0000 (UTC)
Received: from lists01.pubmisc.prod.ext.phx2.redhat.com
 (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33])
	by colo-mx.corp.redhat.com (Postfix) with ESMTP id 87ECC3FB4A;
	Fri, 18 Oct 2019 22:38:53 +0000 (UTC)
Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com
	[10.5.11.16])
	by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP
	id x9IMaVIN025169 for ;
	Fri, 18 Oct 2019 18:36:31 -0400
Received: by smtp.corp.redhat.com (Postfix)
	id 6EFEE5C21A; Fri, 18 Oct 2019 22:36:31 +0000 (UTC)
Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21])
	by smtp.corp.redhat.com (Postfix) with ESMTP id A0A4F5C1B5
	for ; Fri, 18 Oct 2019 22:36:30 +0000 (UTC)
From: =?UTF-8?q?J=C3=A1n=20Tomko?= 
To: libvir-list@redhat.com
Date: Sat, 19 Oct 2019 00:36:49 +0200
Message-Id: 
 <559207942f385a5b27cc80ba986c6f0721379b47.1571438015.git.jtomko@redhat.com>
In-Reply-To: 
References: 
MIME-Version: 1.0
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16
X-loop: libvir-list@redhat.com
Subject: [libvirt] [PATCH 15/16] docs: hacking: amend push-without-review
	rules
X-BeenThere: libvir-list@redhat.com
X-Mailman-Version: 2.1.12
Precedence: junk
List-Id: Development discussions about the libvirt library & tools
	
List-Unsubscribe: ,
	
List-Archive: 
List-Post: 
List-Help: 
List-Subscribe: ,
	
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Sender: libvir-list-bounces@redhat.com
Errors-To: libvir-list-bounces@redhat.com
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14
X-Greylist: Sender IP whitelisted,
 not delayed by milter-greylist-4.6.2 (mx1.redhat.com [10.5.110.71]);
 Fri, 18 Oct 2019 22:38:55 +0000 (UTC)

Include the 'semi-automatic' updates in the list of patches pushed
at maintainers' discretion to match current practice.

Signed-off-by: J=C3=A1n Tomko 
Reviewed-by: Daniel P. Berrang=C3=A9 
---
 docs/hacking.html.in | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 20127d6ece..3c8cceaec0 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -1554,6 +1554,10 @@ int foo()
         fixes for documentation and code comments can be managed
         in the same way, but still make sure they get reviewed if non-triv=
ial.
    • +
  • (ir)regular pulls from other repositories or automated updates, = such + as the .gnulib submodule updates, pulling in new translations or u= pdating + the container images for the CI system +
    • --=20 2.21.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Mon Apr 29 05:54:05 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1571438297; cv=none; d=zoho.com; s=zohoarc; b=AUmMR91mAK2iUglxDjpwdZlhlbIC/c5uEUpKSmnraxHukDY/FQHMIjkvr+0mJb+602DuJh0YjK4ptfZC6FBRpzeUiAAVlfcijEwPUGxPvu+ZsjUiE2JVYvtl3I+H68fB2SN9Hs74GAuqW92/ZAOiVNxZj9C6Goh/o9CYTd6pCqs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1571438297; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=I4q5SV64fy9G0SOo89rUzLYQCrijDtimhCJEv2Dnfy8=; b=AhDlm2JOnR1OuQkdo2Q+j+91bvtfNWg0agdR5ERtS1CP5XPN7U/68NlUgaEHdxCNzoZpw53lNVSpCLSkGhWahuThLSchs55QCoVal+fFKONWl1Mc27H0moWg5yZuUOwshGzAreSKIYN9Elz2peYcK+LPpsG2AfkVa7gGxGHNtSk= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1571438297983975.9757758545865; Fri, 18 Oct 2019 15:38:17 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 84E5758; Fri, 18 Oct 2019 22:38:16 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 5A42C60167; Fri, 18 Oct 2019 22:38:16 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 15C7F180BA9D; Fri, 18 Oct 2019 22:38:16 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x9IMaWAS025183 for ; Fri, 18 Oct 2019 18:36:32 -0400 Received: by smtp.corp.redhat.com (Postfix) id DDDB85C21A; Fri, 18 Oct 2019 22:36:32 +0000 (UTC) Received: from lpt.redhat.com (ovpn-200-21.brq.redhat.com [10.40.200.21]) by smtp.corp.redhat.com (Postfix) with ESMTP id 246D65C1B5 for ; Fri, 18 Oct 2019 22:36:31 +0000 (UTC) From: =?UTF-8?q?J=C3=A1n=20Tomko?= To: libvir-list@redhat.com Date: Sat, 19 Oct 2019 00:36:50 +0200 Message-Id: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 16/16] docs: hacking: fix typo X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.29]); Fri, 18 Oct 2019 22:38:17 +0000 (UTC) s/verca/versa/ Signed-off-by: J=C3=A1n Tomko Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/hacking.html.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 3c8cceaec0..73d137ab1d 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -1105,7 +1105,7 @@ BAD: new code. Existing code should be converted to the new macros where relevant. It is permissible to use g_autoptr, g_auto on an object whose cle= anup function - is declared with the libvirt macros and vice-verca. + is declared with the libvirt macros and vice-versa. =20
    VIR_AUTOUNREF
    --=20 2.21.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list