From nobody Tue Feb 10 00:58:35 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) client-ip=205.139.110.120; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 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=1588872937; cv=none; d=zohomail.com; s=zohoarc; b=m0dF4O2M2oa4vWs/hefoMstLpIcVNUjAa3RnO3dT/n9XhX0apbMjiLn5LXiBysdAdwGrbjSK7yoUEk9kmk0kPPHD8OJ4LOT4YJnCbG8uMJqIHDipQerokAiy2DFfCAs5sjFVA+TQUgcmMNH+3JQw1BQL48kjcNViKXcwnXUQsXY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1588872937; 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=OVxR+EJsP/lTwKZ7s+J1rJpB/KYiRU91SwTZiOZUaLM=; b=EuHJEiZLLzbgtloHQPi+bpL/HLjndttxRsKLX4RsOrslM2oD+mPqqdM++VQLskr638jNvVQQCjuIwhFhw6hItwU4uARzUiyywEuSAEv+PZf6ivdhXF2AdYhlYRnwKPWYH6zgmssRWPfWVXNcgILFhMrws4q9QFyAEV0Cz0E8jcc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) by mx.zohomail.com with SMTPS id 1588872937797590.3872498560668; Thu, 7 May 2020 10:35:37 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-408-mjgn0jiBN6GZr8R-zide-g-1; Thu, 07 May 2020 13:35:33 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 79C7C835B44; Thu, 7 May 2020 17:35: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 494025C1B0; Thu, 7 May 2020 17:35: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 CE2ED4E565; Thu, 7 May 2020 17:35:27 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 047HZQmw011490 for ; Thu, 7 May 2020 13:35:26 -0400 Received: by smtp.corp.redhat.com (Postfix) id D0DD9707A5; Thu, 7 May 2020 17:35:26 +0000 (UTC) Received: from kinshicho.usersys.redhat.com (unknown [10.40.194.140]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 491EC7055D for ; Thu, 7 May 2020 17:35:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1588872936; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=OVxR+EJsP/lTwKZ7s+J1rJpB/KYiRU91SwTZiOZUaLM=; b=fnfuEU7GLL65CDJYCNYRi1m2Yg+tppUenErYtg0K+x43/EGl4n5Ll82OpCrMJG4u1I0ZJb IvbyNRghNmyUt/+h9XF3OANNgXxiuRmJrYFq3GnNYAhtROteoX7PqBy1fqkHoAKLY7//gC EMaP3cLiRbN6gLA9nE+6XI1trReim5A= X-MC-Unique: mjgn0jiBN6GZr8R-zide-g-1 From: Andrea Bolognani To: libvir-list@redhat.com Subject: [libvirt PATCH v2 2/3] docs: Use definition list instead of table in coding style Date: Thu, 7 May 2020 19:35:16 +0200 Message-Id: <20200507173517.934216-3-abologna@redhat.com> In-Reply-To: <20200507173517.934216-1-abologna@redhat.com> References: <20200507173517.934216-1-abologna@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-loop: libvir-list@redhat.com 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: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" This format is much easier to tweak and update. Signed-off-by: Andrea Bolognani --- docs/coding-style.rst | 47 ++++++++++++++++++++++++------------------- 1 file changed, 26 insertions(+), 21 deletions(-) diff --git a/docs/coding-style.rst b/docs/coding-style.rst index 151ea87b6a..03b89c86e5 100644 --- a/docs/coding-style.rst +++ b/docs/coding-style.rst @@ -547,27 +547,32 @@ Attribute annotations Use the following annotations to help the compiler and/or static analysis tools understand the code better: =20 -+-------------------------------+-----------------------------------------= -------------------+ -| Macro | Meaning = | -+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+ -| ``ATTRIBUTE_NONNULL`` | passing NULL for this parameter is not a= llowed | -+-------------------------------+-----------------------------------------= -------------------+ -| ``ATTRIBUTE_PACKED`` | force a structure to be packed = | -+-------------------------------+-----------------------------------------= -------------------+ -| ``G_GNUC_FALLTHROUGH`` | allow code reuse by multiple switch case= s | -+-------------------------------+-----------------------------------------= -------------------+ -| ``G_GNUC_NO_INLINE`` | the function is mocked in the test suite= | -+-------------------------------+-----------------------------------------= -------------------+ -| ``G_GNUC_NORETURN`` | the function never returns = | -+-------------------------------+-----------------------------------------= -------------------+ -| ``G_GNUC_NULL_TERMINATED`` | last parameter must be NULL = | -+-------------------------------+-----------------------------------------= -------------------+ -| ``G_GNUC_PRINTF`` | validate that the formatting string matc= hes parameters | -+-------------------------------+-----------------------------------------= -------------------+ -| ``G_GNUC_UNUSED`` | parameter is unused in this implementati= on of the function | -+-------------------------------+-----------------------------------------= -------------------+ -| ``G_GNUC_WARN_UNUSED_RESULT`` | the return value must be checked = | -+-------------------------------+-----------------------------------------= -------------------+ +``ATTRIBUTE_NONNULL`` + passing NULL for this parameter is not allowed + +``ATTRIBUTE_PACKED`` + force a structure to be packed + +``G_GNUC_FALLTHROUGH`` + allow code reuse by multiple switch cases + +``G_GNUC_NO_INLINE`` + the function is mocked in the test suite + +``G_GNUC_NORETURN`` + the function never returns + +``G_GNUC_NULL_TERMINATED`` + last parameter must be NULL + +``G_GNUC_PRINTF`` + validate that the formatting string matches parameters + +``G_GNUC_UNUSED`` + parameter is unused in this implementation of the function + +``G_GNUC_WARN_UNUSED_RESULT`` + the return value must be checked =20 File handling ------------- --=20 2.25.4