From nobody Sat May 18 02:17:08 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=quarantine dis=quarantine) header.from=seoss.co.uk ARC-Seal: i=1; a=rsa-sha256; t=1689257901; cv=none; d=zohomail.com; s=zohoarc; b=XQWeosQSEKsuCKjal9cNbRqCFF3R60YRKjnEKGOa5sXPKAqSfSCRDDp6DuXq5zE9K59qxKq9HW4/jx2y7hSpjvWKr6a/xpyBWKCwG2oMNhxywU0O/mDtwefJV9mH0N1RpocgiQlnji2BTnCnOUHVhAAS9Xprj2I3jmvKj8D/uiw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689257901; h=Content-Type:Content-Transfer-Encoding:Cc: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=mucvUN4fwvAWn1ANGN1eOeZfpwzSuMnqMqCO12wZX4s=; b=gK1XcUlb1mC7jT4Riyx5gbZFGa2ft8igbUzKqkUDIj7PPwIvsDtzBsNpdUaioqd0Vq4Mbe8r9u51l7mLARP5Td6POnDVGMPoWsFjX1nejoYddQ7m3RDNxpMCV0bBN11OR9EemL57njZbread/ywcnXpMEngzaoCQ3zYf4p8jX+Y= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=quarantine dis=quarantine) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1689257901791177.21915420689618; Thu, 13 Jul 2023 07:18:21 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-381-g48DsJ4EOtmpjciGIg9Lag-1; Thu, 13 Jul 2023 10:16:23 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 93EDD8C982F; Thu, 13 Jul 2023 14:08:51 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 79B111454C20; Thu, 13 Jul 2023 14:08:51 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id A1FD019376C0; Thu, 13 Jul 2023 14:06:42 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id D382C1946589 for ; Thu, 13 Jul 2023 11:43:47 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id B5B29C1ED97; Thu, 13 Jul 2023 11:43:47 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast05.extmail.prod.ext.rdu2.redhat.com [10.11.55.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id AEAA2C1ED96 for ; Thu, 13 Jul 2023 11:43:47 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-2.mimecast.com [207.211.31.81]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 91E2788D1A0 for ; Thu, 13 Jul 2023 11:43:47 +0000 (UTC) Received: from relay0.allsecuredomains.com (relay0.allsecuredomains.com [51.68.204.196]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-383-K377soUeOFGSGekINmBx1A-1; Thu, 13 Jul 2023 07:43:44 -0400 Received: from [81.174.144.187] (helo=custard.lan) by relay0.allsecuredomains.com with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qJu3W-0006s8-16; Thu, 13 Jul 2023 11:00:18 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689257900; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=mucvUN4fwvAWn1ANGN1eOeZfpwzSuMnqMqCO12wZX4s=; b=DM+8EagE36D7TMN7dDNv5Kizwg942jLtgetvVQgNWHWo5R/L1j1WyNWzRUShTjk2Rm2ksE dxvSzO3JP4PnNQzranF6geJpUdoJ3MvCOWqwhL1TiyGCjwscDLVIy2ocalKlZR3gPI7o6I lRQPkUIIt/T6aMkCF3uBoCxpMuveBak= X-MC-Unique: g48DsJ4EOtmpjciGIg9Lag-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: K377soUeOFGSGekINmBx1A-1 From: Tim Small To: libvir-list@redhat.com Subject: [libvirt PATCH 01/10] docs: Link to main docs directory from Quick Links Date: Thu, 13 Jul 2023 11:59:55 +0100 Message-Id: <20230713110004.1878682-2-tim@seoss.co.uk> In-Reply-To: <20230713110004.1878682-1-tim@seoss.co.uk> References: <20230713110004.1878682-1-tim@seoss.co.uk> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 3.1 on 10.11.54.8 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tim Small Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.7 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: seoss.co.uk Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689257902478100003 Content-Type: text/plain; charset="utf-8"; x-default="true" Whilst the "docs" documentation map is linked in the navigation bar, users may scroll down and lose sight of this, so also place at the bottom of the "Quick Links" section. Signed-off-by: Tim Small Reviewed-by: Michal Privoznik --- docs/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index d55c4bb94d..0782034e02 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,6 +54,8 @@ Quick Links Read further community contributed content `Knowledge base `__ Learn more about libvirt through knowledge base +`Documentation `__ + Comprehensive documentation map =20 Blog Planet ----------- --=20 2.39.2 From nobody Sat May 18 02:17:08 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=quarantine dis=quarantine) header.from=seoss.co.uk ARC-Seal: i=1; a=rsa-sha256; t=1689257579; cv=none; d=zohomail.com; s=zohoarc; b=CtUPf+hRKtHAULXpSLBUbJkChG2LHDL+e0tcIKM1kKv/O7Dzd6Xo1Qn+hqG+h9yOXhvJqcDU8c0/R8s1QvRpSBJ5CL43zmW4eYseVdDXI1Mqs55aXiNn3Ycpam+ILM3FdLFYx0oDZSGR+QrG6Sca62Pr+cBArVUjsDwb/0aoYUI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689257579; h=Content-Type:Content-Transfer-Encoding:Cc: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=fHCh+pXwMZy4/QrLyPXl3dp3aK+kmnTLinKZYqgSe5A=; b=aqTsEqCFbCoIB6BE9lN0RhSFRTMLEa8EObkgPBK1Btk9SKylwi/UkY0eagCgDSBOHg80RCps8ZhXlXcPELUbBBLzJz4EOpftpK2EK8PmCgPyVO3w+5wFERuDi9sme71zim2xRDopFeU2LVnmlBvsRxonvTW4fUJccXX7n90S3Ig= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=quarantine dis=quarantine) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1689257579091431.67988193669476; Thu, 13 Jul 2023 07:12:59 -0700 (PDT) Received: from mimecast-mx02.redhat.com (66.187.233.73 [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-342-mfKVZy1_NlKOhD-XxihiMQ-1; Thu, 13 Jul 2023 10:11:12 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id E2B142800182; Thu, 13 Jul 2023 14:05:21 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id CD06C492B01; Thu, 13 Jul 2023 14:05:21 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 2E1051940375; Thu, 13 Jul 2023 14:04:33 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 9C0B91946589 for ; Thu, 13 Jul 2023 11:43:28 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 8D9931454145; Thu, 13 Jul 2023 11:43:28 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast10.extmail.prod.ext.rdu2.redhat.com [10.11.55.26]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 858E11454142 for ; Thu, 13 Jul 2023 11:43:28 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 5D77C1C0513E for ; Thu, 13 Jul 2023 11:43:28 +0000 (UTC) Received: from relay0.allsecuredomains.com (relay0.allsecuredomains.com [51.68.204.196]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-614-gVHdNuumOb-Dc6Wpt5zj8A-1; Thu, 13 Jul 2023 07:43:26 -0400 Received: from [81.174.144.187] (helo=custard.lan) by relay0.allsecuredomains.com with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qJu3W-0006s8-6R; Thu, 13 Jul 2023 11:00:18 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689257578; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=fHCh+pXwMZy4/QrLyPXl3dp3aK+kmnTLinKZYqgSe5A=; b=GuAHng2PD2JBDuT4Sq+hxxl6GoHdoF/6UYTFQdz2I2tf6xG3BomKPO7o/mtA3TF835iocR y+c9et+TUYraKIqZo1dtWXSMTLNQxNP85JZkFaB/s2vC0q2pwE9O7CxwhNuppN1OcsP44X r0ELyvWOY8tsfCGFSF39mtDBSSCsYPc= X-MC-Unique: mfKVZy1_NlKOhD-XxihiMQ-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: gVHdNuumOb-Dc6Wpt5zj8A-1 From: Tim Small To: libvir-list@redhat.com Subject: [libvirt PATCH 02/10] docs: Missing "full-stop"/"period" on some bullet items Date: Thu, 13 Jul 2023 11:59:56 +0100 Message-Id: <20230713110004.1878682-3-tim@seoss.co.uk> In-Reply-To: <20230713110004.1878682-1-tim@seoss.co.uk> References: <20230713110004.1878682-1-tim@seoss.co.uk> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 3.1 on 10.11.54.7 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tim Small Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.9 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: seoss.co.uk Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689257581599100001 Content-Type: text/plain; charset="utf-8"; x-default="true" Signed-off-by: Tim Small Reviewed-by: Michal Privoznik --- docs/contribute.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contribute.rst b/docs/contribute.rst index 6ed5426b8a..c1d57a8584 100644 --- a/docs/contribute.rst +++ b/docs/contribute.rst @@ -25,19 +25,19 @@ to libvirt. If you have ideas for other contributions f= eel free to follow them. written in Python, Perl, Java, Ruby, Php, OCaml and Go. There are also = higher level wrappers mapping libvirt into other object frameworks, such GLib,= CIM and SNMP. For those interested in working on the core parts of libvirt,= the - `contributor guidelines `__ are mandatory reading + `contributor guidelines `__ are mandatory reading. - **Translation**. All the libvirt modules aim to support translations wh= ere appropriate. All translation is handling outside of the normal libvirt = review process, using the `Fedora instance = `__ of the Weblate tool. Thus people wishing to contribute to translation shou= ld - join the Fedora translation team + join the Fedora translation team. - **Documentation**. There are docbook guides on various aspects of libvi= rt, particularly application development guides for the C library and Pytho= n, and a virsh command reference. There is thus scope for work by people who a= re familiar with using or developing against libvirt, to write further con= tent for these guides. There is also a need for people to review existing co= ntent - for copy editing and identifying gaps in the docs + for copy editing and identifying gaps in the docs. - **Website / wiki curation**. The bulk of the website is maintained in t= he primary GIT repository, while the wiki site uses mediawiki. In both cas= es there is a need for people to both write new content and curate existing --=20 2.39.2 From nobody Sat May 18 02:17:08 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=quarantine dis=quarantine) header.from=seoss.co.uk ARC-Seal: i=1; a=rsa-sha256; t=1689258289; cv=none; d=zohomail.com; s=zohoarc; b=Klgc7YgVEB3OT/CbAc2mRn6mO9l0HD9grxVdP72/z6/KIB21T5LYNDO1qWUTlysnZH+bMUH3bO9Ls0ZGoKnI8FMBufBrqniPlUg+2qTu7Jc/MwTUx+QtZX8FXWj/uY1VkABwmlIcdWeINgxotrPwtexoUgQUwOikkqwD/DsQ8i8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689258289; h=Content-Type:Content-Transfer-Encoding:Cc: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=FAA5/dKqKAowzigthRT5MQzDqv0e3tkrLUo+OLmBN+s=; b=QSyK/otCgj4mFsQCxwyJpJ/GIXb+E977bPt38mxh+gfn2vLA24B12ASLVCfdpTKeMweSzuwGa+OEfsroce/Q+OHkvLtfmdFUWvH2MRkRnzEzzo3HuhUPDVNHOVLv8zVG9+910eq0sXEz6aD/AqOL9Vx4Mc5S856FqvvbFKxmOcY= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=quarantine dis=quarantine) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1689258289302652.1707126124994; Thu, 13 Jul 2023 07:24:49 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-112-3et4_dOUNUikpMx3Y25lyA-1; Thu, 13 Jul 2023 10:24:22 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 6965790E426; Thu, 13 Jul 2023 14:16:06 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 548B0111E3EC; Thu, 13 Jul 2023 14:16:06 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 269DF1946A42; Thu, 13 Jul 2023 14:16:00 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 0A3D51946589 for ; Thu, 13 Jul 2023 11:43:45 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id E28094CD0C6; Thu, 13 Jul 2023 11:43:44 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast05.extmail.prod.ext.rdu2.redhat.com [10.11.55.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id DA5C8492C13 for ; Thu, 13 Jul 2023 11:43:44 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id BF22688D1A0 for ; Thu, 13 Jul 2023 11:43:44 +0000 (UTC) Received: from relay0.allsecuredomains.com (relay0.allsecuredomains.com [51.68.204.196]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-2-rhaeif73PS6SQ5kWK__j6Q-1; Thu, 13 Jul 2023 07:43:37 -0400 Received: from [81.174.144.187] (helo=custard.lan) by relay0.allsecuredomains.com with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qJu3W-0006s8-C4; Thu, 13 Jul 2023 11:00:18 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689258288; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=FAA5/dKqKAowzigthRT5MQzDqv0e3tkrLUo+OLmBN+s=; b=Yl/76K9MIPcI0BY8Wrzymkte3obyY9g2ivz7N6sXmrTaPbDDJm+C+1NedY2cyGOVQnCLnz MAzQ1HZMFDubVUfgr58CYSsKZJuEFnir0ualChVn88FRN6dtgx5QJFkDnKPy9rq19/ke6+ +6V0dazRELqPIpYaUg+xwYSEi0Rd0hY= X-MC-Unique: 3et4_dOUNUikpMx3Y25lyA-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: rhaeif73PS6SQ5kWK__j6Q-1 From: Tim Small To: libvir-list@redhat.com Subject: [libvirt PATCH 03/10] docs: Link main "contributing" from programming-specific guide Date: Thu, 13 Jul 2023 11:59:57 +0100 Message-Id: <20230713110004.1878682-4-tim@seoss.co.uk> In-Reply-To: <20230713110004.1878682-1-tim@seoss.co.uk> References: <20230713110004.1878682-1-tim@seoss.co.uk> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 3.1 on 10.11.54.10 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tim Small Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.3 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: seoss.co.uk Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689258291199100001 Content-Type: text/plain; charset="utf-8"; x-default="true" There are two guides to contributing: `hacking.rst` is focused on code contributions, and `contributing.rst` is more general. Clarify scope of `hacking.rst` and link to the general guide in its references. Signed-off-by: Tim Small Reviewed-by: Michal Privoznik --- docs/hacking.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/hacking.rst b/docs/hacking.rst index 1be9daab80..8dc9b37475 100644 --- a/docs/hacking.rst +++ b/docs/hacking.rst @@ -3,7 +3,7 @@ Contributing =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 These are the basics steps you need to follow to contribute to -libvirt. +libvirt software development. =20 Repositories and external resources =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 @@ -75,3 +75,4 @@ you also take a look at the following documents: - `Advanced test suite usage `__ - `Adoption of GLib APIs `__ - `Committer guidelines `__ +- `Contributing to libvirt `__ --=20 2.39.2 From nobody Sat May 18 02:17:08 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=quarantine dis=quarantine) header.from=seoss.co.uk ARC-Seal: i=1; a=rsa-sha256; t=1689257599; cv=none; d=zohomail.com; s=zohoarc; b=g/F/CNEuaCQJ8s70EYbtg2AH7B0tMINfMUwCMOSXGfcB1Fjp15+bfwN7ObCi7i2e/4pPZHl06+JPrdddGfYB7iI9G1bmVan2Id0QN2izvuEuuHvONuXjmoxTC6MNO/KsI1fUafrUnzq5+yHMQMKQi789NJo6n4Wlmz2Xd9wusLo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689257599; h=Content-Type:Content-Transfer-Encoding:Cc: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=IV1aru1OVPznDCTKpmFRVisLz88f2WgzSaq26FUXeUk=; b=QupvDRWIU49G3iARy5RvQZa9BLIKF9w3B4AR2LD3JDFgw5pUD65dxrbtyBEzUXNMjFsphNe6Daq+i7aH5TkDKZlYwoaZIdQLeoMzLTeR5mJq6t3rfbWcPdjJ3407eoOm2GRvFjzmz0/yMX5tKAoXghd5wfyauf4DPDyIxotLdn8= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=quarantine dis=quarantine) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1689257599098591.1232424234131; Thu, 13 Jul 2023 07:13:19 -0700 (PDT) Received: from mimecast-mx02.redhat.com (66.187.233.73 [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-190-3n9j5EoFO-2P9XQLdI_9DQ-1; Thu, 13 Jul 2023 10:12:11 -0400 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 9CFE829ABA2A; Thu, 13 Jul 2023 14:05:44 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 8850F4CD0D1; Thu, 13 Jul 2023 14:05:44 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 7898A1946A51; Thu, 13 Jul 2023 14:04:48 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 7D9E71946589 for ; Thu, 13 Jul 2023 11:43:24 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 6F72FC1ED97; Thu, 13 Jul 2023 11:43:24 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast08.extmail.prod.ext.rdu2.redhat.com [10.11.55.24]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 67AA2C1ED96 for ; Thu, 13 Jul 2023 11:43:24 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-2.mimecast.com [207.211.31.81]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 4AAED3806708 for ; Thu, 13 Jul 2023 11:43:24 +0000 (UTC) Received: from relay0.allsecuredomains.com (relay0.allsecuredomains.com [51.68.204.196]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-451-HmnGqkSxMO6wvAaz1sUDVw-1; Thu, 13 Jul 2023 07:43:18 -0400 Received: from [81.174.144.187] (helo=custard.lan) by relay0.allsecuredomains.com with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qJu3W-0006s8-HX; Thu, 13 Jul 2023 11:00:18 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689257598; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=IV1aru1OVPznDCTKpmFRVisLz88f2WgzSaq26FUXeUk=; b=LkN5wLjaz53mXZCl+yCFJkNVD91vvxBcM9HTEgR0ThWjQUJJOPu6STv+MUSj6K8Gsx7jeF fTHShTBzzkhkujnYFtDMGmjI+JIi+HWioEUZuvCuwIeMv0w7SEs5y17QG8jMHdChrw0AZu j+lCSXPtiIXgv8343XMOz9rNWVgLUog= X-MC-Unique: 3n9j5EoFO-2P9XQLdI_9DQ-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: HmnGqkSxMO6wvAaz1sUDVw-1 From: Tim Small To: libvir-list@redhat.com Subject: [libvirt PATCH 04/10] docs: Point to compiling guide from code contribution guide Date: Thu, 13 Jul 2023 11:59:58 +0100 Message-Id: <20230713110004.1878682-5-tim@seoss.co.uk> In-Reply-To: <20230713110004.1878682-1-tim@seoss.co.uk> References: <20230713110004.1878682-1-tim@seoss.co.uk> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 3.1 on 10.11.54.8 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tim Small Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.10 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: seoss.co.uk Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689257631374100001 Content-Type: text/plain; charset="utf-8"; x-default="true" The "hacking" doc details where to find the code, but not how to compile it - link to the instructions contained in `compiling.rst`. Signed-off-by: Tim Small Reviewed-by: Michal Privoznik --- docs/hacking.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/hacking.rst b/docs/hacking.rst index 8dc9b37475..a04da9cb58 100644 --- a/docs/hacking.rst +++ b/docs/hacking.rst @@ -19,6 +19,15 @@ If you want to contribute to translations of libvirt, jo= in the appropriate language team in Weblate. Translation updates to libvirt will be merged during the feature freeze window. =20 +Working with the code +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +In general you should base your work upon the git master branch. + +The `"Git checkout" section `__ +of the libvirt installation instructions give an overview of the +compilation process. + Preparing patches =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 --=20 2.39.2 From nobody Sat May 18 02:17:08 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=quarantine dis=quarantine) header.from=seoss.co.uk ARC-Seal: i=1; a=rsa-sha256; t=1689257841; cv=none; d=zohomail.com; s=zohoarc; b=WZQEAa01yYEwxW2phaPdQLBvgTucSf+9JKk5SACQuvnyZ5tpYOypRETRhSkSMSK+BMsSyW7aC8Ld+0Dv3x3n3IeE4OLo16Mw3o7oRCdquiwROBwkZrmzThlmGlAN4gwd4TrfI1tzyvaGF9pmTi7q4H1IR3l263nJ1s/3zj5JI/0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689257841; h=Content-Type:Content-Transfer-Encoding:Cc: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=MFUyecVoa1ftM/Q7dfF2wVl6o7oUuF47zmMoo+/pht4=; b=TcjEd1TUlHTwVXXBcnDKuThU803ptFsaOPqgg60mPRfuA6TF3ewVu49/dC7/cFZ9yE4Xk2Wl5//NMypqxxgq9iHOyO/s6M9oKsXBzQeZgo2d+DQarJQp7klrn+IS+mSaTYUl1RLqkOsonRCUNx3cwsvIw4/56No1a/pnpHBhbNA= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=quarantine dis=quarantine) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1689257841024972.5290270748336; Thu, 13 Jul 2023 07:17:21 -0700 (PDT) Received: from mimecast-mx02.redhat.com (66.187.233.73 [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-527-MvYdSRoxMwapeanSBWjyyw-1; Thu, 13 Jul 2023 10:16:20 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 2C5573C1D629; Thu, 13 Jul 2023 14:07:50 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id A6B9140C2063; Thu, 13 Jul 2023 14:07:49 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id C07EC19543A7; Thu, 13 Jul 2023 14:05:51 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 400BA1946589 for ; Thu, 13 Jul 2023 11:43:30 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 20053C1ED96; Thu, 13 Jul 2023 11:43:30 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast10.extmail.prod.ext.rdu2.redhat.com [10.11.55.26]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 18FA1C478DF for ; Thu, 13 Jul 2023 11:43:30 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-inbound-delivery-1.mimecast.com [205.139.110.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id F2BF01C17114 for ; Thu, 13 Jul 2023 11:43:29 +0000 (UTC) Received: from relay0.allsecuredomains.com (relay0.allsecuredomains.com [51.68.204.196]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-222-0TOoyfXvNnqRVe9RjsVnSg-1; Thu, 13 Jul 2023 07:43:28 -0400 Received: from [81.174.144.187] (helo=custard.lan) by relay0.allsecuredomains.com with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qJu3W-0006s8-ND; Thu, 13 Jul 2023 11:00:18 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689257839; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=MFUyecVoa1ftM/Q7dfF2wVl6o7oUuF47zmMoo+/pht4=; b=Bup9XbX1jwZ8bcY/z+qIFDnPZbsPMkdLhQU602CBBy8ENrIRJzAfz820jSMQr2QtWFR8hv eWLUzQvUYCa15KPJ8p/FXKvopf47dnjKwfj6HUgtYfFpFk9bdXL8e20OAytQZiIFxz6zAZ byAXyNtPB/Mo85Rv7OWeTFQJNA+/+QI= X-MC-Unique: MvYdSRoxMwapeanSBWjyyw-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: 0TOoyfXvNnqRVe9RjsVnSg-1 From: Tim Small To: libvir-list@redhat.com Subject: [libvirt PATCH 05/10] docs: Add config instructions for clangd with libvirt Date: Thu, 13 Jul 2023 11:59:59 +0100 Message-Id: <20230713110004.1878682-6-tim@seoss.co.uk> In-Reply-To: <20230713110004.1878682-1-tim@seoss.co.uk> References: <20230713110004.1878682-1-tim@seoss.co.uk> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 3.1 on 10.11.54.8 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tim Small Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.1 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: seoss.co.uk Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689257902142100001 Content-Type: text/plain; charset="utf-8"; x-default="true" In build environments which use gcc as the default compiler, use of the clangd LSP server (for enhanced code editing and navigation etc.) with libvirt requires some additional configuration. Detail this and link from `hacking.rst`. Signed-off-by: Tim Small Reviewed-by: Michal Privoznik --- docs/clangd.rst | 51 ++++++++++++++++++++++++++++++++++++++++++++++++ docs/hacking.rst | 3 +++ docs/meson.build | 1 + 3 files changed, 55 insertions(+) create mode 100644 docs/clangd.rst diff --git a/docs/clangd.rst b/docs/clangd.rst new file mode 100644 index 0000000000..93570ae178 --- /dev/null +++ b/docs/clangd.rst @@ -0,0 +1,51 @@ +=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 +Using Clangd with Libvirt +=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 + +`clangd `__ is an implementation of the +`language server protocol +`__ for C +and C++. + +When paired with an LSP-compatible editor or IDE (e.g. emacs, +vim, vscode), ``clangd`` can helpful when working with libvirt's +C sources e.g. navigating the code base. + +Whilst other C LSPs are available, ``clangd`` should work +correctly with the libvirt because clang is a supported compiler +for libvirt, and ``clangd`` is part of the same code base as +clang. + +If clang is the default compiler on your system, then ``clangd`` +can be used as soon as ``meson setup`` has been run. + +If gcc is your build environment's default compiler, then +additional steps are required to use ``clangd``: + +``clangd`` looks for a ``compile_commands.json`` file in the top +level directory of the project and also in the ``build/`` +subdirectory to discover which include paths, compiler flags etc. +should be used when it parses each source file. + +Meson creates a ``compile_commands.json`` in the build directory. +Meson defaults to the system's default C compiler. When the +default compiler is gcc, its ``compile_commands.json`` output +cannot be used with ``clangd`` due to differences in compiler +invocation flags when building libvirt. + +Create a separate build directory with a ``clangd`` compatible +``compile_commands.json`` as follows: + +:: + + CC=3Dclang CXX=3Dclang++ meson setup build-clang + +Point ``clangd`` (v12 or later) at the correct +``compile_commands.json`` by placing the following into a +``.clangd`` file in the root of the project: + +:: + + --- + CompileFlags: + CompilationDatabase: "build-clang" diff --git a/docs/hacking.rst b/docs/hacking.rst index a04da9cb58..11cd21223a 100644 --- a/docs/hacking.rst +++ b/docs/hacking.rst @@ -28,6 +28,9 @@ The `"Git checkout" section = `__ of the libvirt installation instructions give an overview of the compilation process. =20 +Optionally, `Clangd with libvirt `__ can be used to +navigate the code base etc. within most code editors (and IDEs). + Preparing patches =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 diff --git a/docs/meson.build b/docs/meson.build index 201fd4c984..70d271ec6e 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -32,6 +32,7 @@ docs_rst_files =3D [ 'ci', 'ci-dashboard', 'ci-runners', + 'clangd', 'coding-style', 'committer-guidelines', 'compiling', --=20 2.39.2 From nobody Sat May 18 02:17:08 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=quarantine dis=quarantine) header.from=seoss.co.uk ARC-Seal: i=1; a=rsa-sha256; t=1689257592; cv=none; d=zohomail.com; s=zohoarc; b=dxeEfVXjNRI0V/aeutrb4tyec7/FQrUYXwLQn6isgsoyUzlNL8B/IOYB0jZCkOyYXueCESSGPyF/vRrAV8acuWkPMgx/bbFNvXH+mllqmNRWFygnpI5HV8Nr9T8WYfFwF7EunzqBPwUanZQEBts1mJ77Eo0mTIGC1y+hzAq2wWs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689257592; h=Content-Type:Content-Transfer-Encoding:Cc: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=4VDDv4wB2FoxMnzEMFAgcz9WhIk6WUQA9mkSF9zOLbs=; b=dPsDd5D7R9mm+XKtkx3ga65mY0gu0Fh32FQg0WA5HUL0Sqs3ZprnInahhS3rnFMgYcUOqXOv1AmT2eSLQ30qp1co0P929hfU2De1lFzBh/4vgBy4I7CpmC7fNY+qN7SNa6mDpmT9YOTHA3mCCO3k108XkZPhxPyYOA4d5g1NFGw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=quarantine dis=quarantine) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1689257592673496.21795118043383; Thu, 13 Jul 2023 07:13:12 -0700 (PDT) Received: from mimecast-mx02.redhat.com (66.187.233.73 [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-376-LFE67alzP9y_2M1Z_hWYcw-1; Thu, 13 Jul 2023 10:11:55 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 40AA51C06938; Thu, 13 Jul 2023 14:05:50 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 2C35B4087C69; Thu, 13 Jul 2023 14:05:50 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id BD32B1937754; Thu, 13 Jul 2023 14:04:48 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 6E3061946589 for ; Thu, 13 Jul 2023 11:43:35 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 4856E492B02; Thu, 13 Jul 2023 11:43:35 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast01.extmail.prod.ext.rdu2.redhat.com [10.11.55.17]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 3D9ED492B01 for ; Thu, 13 Jul 2023 11:43:35 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 1F3FD85A58A for ; Thu, 13 Jul 2023 11:43:35 +0000 (UTC) Received: from relay0.allsecuredomains.com (relay0.allsecuredomains.com [51.68.204.196]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-210-oJaN7G8LMoOKYZxqaf4TDA-1; Thu, 13 Jul 2023 07:43:33 -0400 Received: from [81.174.144.187] (helo=custard.lan) by relay0.allsecuredomains.com with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qJu3W-0006s8-Sv; Thu, 13 Jul 2023 11:00:18 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689257591; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=4VDDv4wB2FoxMnzEMFAgcz9WhIk6WUQA9mkSF9zOLbs=; b=izXlHWw3B1e81MzY4A667PNnD7vMuNXVyBgWB5qg2d1Z2KtAWUkVLsFFv2LHVKSPuUnHMg xwPD/zcbrF0+G6mQ2of9ZMEfCd5KbZ2XIXD5fwU6pkRBbR+5b8ribe7hRM4mO5UN6DXzn4 PZNdDL/yoXFXKRbsz2PNkXsaBAeodac= X-MC-Unique: LFE67alzP9y_2M1Z_hWYcw-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: oJaN7G8LMoOKYZxqaf4TDA-1 From: Tim Small To: libvir-list@redhat.com Subject: [libvirt PATCH 06/10] docs: Reword "Preparing Patches" to clarify Date: Thu, 13 Jul 2023 12:00:00 +0100 Message-Id: <20230713110004.1878682-7-tim@seoss.co.uk> In-Reply-To: <20230713110004.1878682-1-tim@seoss.co.uk> References: <20230713110004.1878682-1-tim@seoss.co.uk> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 3.1 on 10.11.54.9 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tim Small Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.2 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: seoss.co.uk Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689257622989100001 Content-Type: text/plain; charset="utf-8"; x-default="true" Clarify that patches should apply cleanly to the master branch. Give guidance for typical bug fix process for existing releases. Signed-off-by: Tim Small Reviewed-by: Michal Privoznik --- docs/hacking.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/hacking.rst b/docs/hacking.rst index 11cd21223a..85918c9176 100644 --- a/docs/hacking.rst +++ b/docs/hacking.rst @@ -34,8 +34,10 @@ navigate the code base etc. within most code editors (an= d IDEs). Preparing patches =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -Make sure your patches apply against libvirt git. Developers -only follow git and don't care much about released versions. +Make sure your patches apply against the libvirt git master +branch. The backporting of changes to existing releases is +typically carried out by downstream users at their discretion +after code is merged into the upstream git. =20 Run the automated tests on your code before submitting any changes. That is: --=20 2.39.2 From nobody Sat May 18 02:17:08 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=quarantine dis=quarantine) header.from=seoss.co.uk ARC-Seal: i=1; a=rsa-sha256; t=1689257556; cv=none; d=zohomail.com; s=zohoarc; b=eQYZC+ME1r1LBQ/thn6fpqq+ql7LUST9z5fEIekyakWPmHZuzLgBLBmyu2NuE1QOxkJphWrgPDqgs7blZOa/e39BlDzUEm2PzcOqnjcUjXx7j7ax9z11sRm7Fr8/cQDVyqbFtz+Lc4adREfbgekEyoxrd7yFhnBdupQyp8oEZh4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689257556; h=Content-Type:Content-Transfer-Encoding:Cc: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=iLcBHLx6g6neEheUw+ssYcdZrmbheYny4BBCUUaiYz8=; b=khgBVCRAjZADRL4eg8tUeAVnUZEpJ1UR122ehg8PI99gJeiS9sjyA7b7vBcOKuxynfuxb4xZKjJT8WZTatLfArNbknvP6tU1r61R3913VA03CN63APZZQr+uMTSnoVuHE3ybOg8DLqD4as3Xanj8g2pciX6hsAAyguZTBuw1OHU= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=quarantine dis=quarantine) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1689257556894295.8982338223591; Thu, 13 Jul 2023 07:12:36 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-79-ZYjRlXMeMjGwv-Q24wvuOQ-1; Thu, 13 Jul 2023 10:11:33 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 810B989F72D; Thu, 13 Jul 2023 14:05:38 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 663A1145414B; Thu, 13 Jul 2023 14:05:38 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 0585C194E110; Thu, 13 Jul 2023 14:04:39 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 694C71946589 for ; Thu, 13 Jul 2023 11:46:59 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 59F39F66D1; Thu, 13 Jul 2023 11:46:59 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast07.extmail.prod.ext.rdu2.redhat.com [10.11.55.23]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 5203BF66A1 for ; Thu, 13 Jul 2023 11:46:59 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [207.211.31.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 318DA3C025C0 for ; Thu, 13 Jul 2023 11:46:59 +0000 (UTC) Received: from relay0.allsecuredomains.com (relay0.allsecuredomains.com [51.68.204.196]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-595-57jchXjlM5KYq_Vjairqpg-1; Thu, 13 Jul 2023 07:43:30 -0400 Received: from [81.174.144.187] (helo=custard.lan) by relay0.allsecuredomains.com with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qJu3X-0006s8-1n; Thu, 13 Jul 2023 11:00:19 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689257555; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=iLcBHLx6g6neEheUw+ssYcdZrmbheYny4BBCUUaiYz8=; b=XbXIikvjMuNMJHEoaOnjP37Xwcn8WjRDYfIWnYefYwBQFdV8QUk0Z8jIsL0OCsQ3ytUoGt VwyqApIWZAYvhg6pR5GW9gjZLAjbqBQ6hHv5+fCVr0rUJ2r39u0hxcajDQzuMC/AJ1Vt9W qEZ6I3DnMadiCodpPmOMWGP3g0Pwm7k= X-MC-Unique: ZYjRlXMeMjGwv-Q24wvuOQ-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: 57jchXjlM5KYq_Vjairqpg-1 From: Tim Small To: libvir-list@redhat.com Subject: [libvirt PATCH 07/10] docs: Advise running CI tests prior to submission Date: Thu, 13 Jul 2023 12:00:01 +0100 Message-Id: <20230713110004.1878682-8-tim@seoss.co.uk> In-Reply-To: <20230713110004.1878682-1-tim@seoss.co.uk> References: <20230713110004.1878682-1-tim@seoss.co.uk> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 3.1 on 10.11.54.5 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tim Small Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.7 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: seoss.co.uk Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689257600204100001 Content-Type: text/plain; charset="utf-8"; x-default="true" In the preparing patches section, note that it is possible to run CI tests via gitlab prior to submitting patches. Signed-off-by: Tim Small Reviewed-by: Michal Privoznik --- docs/hacking.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/hacking.rst b/docs/hacking.rst index 85918c9176..c2e79e4501 100644 --- a/docs/hacking.rst +++ b/docs/hacking.rst @@ -58,6 +58,14 @@ adding a new feature or changing the output of a program= , and don't forget to update the `release notes `__ if your changes are significant and user-visible. =20 +To test across a variety of build platforms prior to submitting +your changes, you may create your own fork of the project on +gitlab. This will give you access to (a subset of) libvirt's +`continuous integration `__ test suite. + +Please note that you should still follow the instructions below, +rather than following gitlab's prompts to open a "merge request". + Submitting patches =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 --=20 2.39.2 From nobody Sat May 18 02:17:08 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=quarantine dis=quarantine) header.from=seoss.co.uk ARC-Seal: i=1; a=rsa-sha256; t=1689257513; cv=none; d=zohomail.com; s=zohoarc; b=WacQrFWMNiSXEWufudcjIK1ZU7Rj5/Tz4R7MkReMumouG9bYnTGDxQmGy7puAuoNtMl8KuJF5Kls6sauwNqCKo0n3FtZMVeqaZGBOsr2LijLGlcnQHOcDxFBc+rKheWtVh/xKTYA1ZQA2ydpgni3FtqCG6HB+/6BLg9H/lz5CJc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689257513; h=Content-Type:Content-Transfer-Encoding:Cc: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=ZUad8B8S2I2fRqRX3Ayuw7RFh1zzXIDP1oD5lNIyE3Y=; b=NmMHieitUI+ZN6LfhFOhacd98+5czigdmnLcRKLrcCdLm4Re1WFL73SoJA0bOMVzPErQXWtOX25lKsoq8BcCTxpYGoS8z31p00xD3+w069so28Hbp6rBYbpDCE94FJ+e85bsMKyPU1gLE9UtzGqU4ud2hkohV6SL1/3e9DiSLH8= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=quarantine dis=quarantine) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1689257513035722.1898353581313; Thu, 13 Jul 2023 07:11:53 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-374-IrBi3MmCN7uqWc6iBZiHRA-1; Thu, 13 Jul 2023 10:10:58 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 2A5A58A512B; Thu, 13 Jul 2023 14:05:44 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0EC6E1454143; Thu, 13 Jul 2023 14:05:44 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 2AE1D19543B2; Thu, 13 Jul 2023 14:04:43 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 8A5CB1946589 for ; Thu, 13 Jul 2023 11:43:23 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 6C7D2C1ED97; Thu, 13 Jul 2023 11:43:23 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast08.extmail.prod.ext.rdu2.redhat.com [10.11.55.24]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 65080C1ED96 for ; Thu, 13 Jul 2023 11:43:23 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-inbound-delivery-1.mimecast.com [205.139.110.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 44BA73806708 for ; Thu, 13 Jul 2023 11:43:23 +0000 (UTC) Received: from relay0.allsecuredomains.com (relay0.allsecuredomains.com [51.68.204.196]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-508-hBv0JUwfOzigXuWkfQURew-1; Thu, 13 Jul 2023 07:43:21 -0400 Received: from [81.174.144.187] (helo=custard.lan) by relay0.allsecuredomains.com with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qJu3X-0006s8-6x; Thu, 13 Jul 2023 11:00:19 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689257511; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=ZUad8B8S2I2fRqRX3Ayuw7RFh1zzXIDP1oD5lNIyE3Y=; b=dCk8RUq1NG6FR/zR9b1SdfKL2CKxJLC4KMkht6pUKiRXX2a7umsS96wEK2f2M5Fk4wqDnl kB/IZFw466Iwn+BLVTwlHVFo/r6+bpZn4CNttrfM/m6HuzzcqaS7dbChmOBau7GkukUS7u CCQfP3T+22CygGtHU0k2DbsRgiSnamM= X-MC-Unique: IrBi3MmCN7uqWc6iBZiHRA-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: hBv0JUwfOzigXuWkfQURew-1 From: Tim Small To: libvir-list@redhat.com Subject: [libvirt PATCH 08/10] docs: Point to mailing list archives from submitting-patches Date: Thu, 13 Jul 2023 12:00:02 +0100 Message-Id: <20230713110004.1878682-9-tim@seoss.co.uk> In-Reply-To: <20230713110004.1878682-1-tim@seoss.co.uk> References: <20230713110004.1878682-1-tim@seoss.co.uk> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 3.1 on 10.11.54.8 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tim Small Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.7 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: seoss.co.uk Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689257613870100001 Content-Type: text/plain; charset="utf-8"; x-default="true" Suggest that new contributors should review past patch submissions for typical style, feedback etc. prior to submitting. Link to archives. Signed-off-by: Tim Small Reviewed-by: Michal Privoznik --- docs/submitting-patches.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/submitting-patches.rst b/docs/submitting-patches.rst index 7a8743b8d0..5b857f9111 100644 --- a/docs/submitting-patches.rst +++ b/docs/submitting-patches.rst @@ -8,6 +8,11 @@ tool. All libvirt-related repositories contain a config fi= le that tells git-publish to use the correct mailing list and subject prefix. =20 +If you are a first-time contributor, you may wish to read some +patch submission threads from the `mailing list archive +`__ of the mailing list from the +``.gitpublish`` file. + Alternatively, you may send patches using ``git send-email``. =20 The usual workflow of libvirt developer is: --=20 2.39.2 From nobody Sat May 18 02:17:08 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=quarantine dis=quarantine) header.from=seoss.co.uk ARC-Seal: i=1; a=rsa-sha256; t=1689257777; cv=none; d=zohomail.com; s=zohoarc; b=QsgUiRCuiZrrG+1m7kaN74LNWQD/2EuHjn4CX2YYbrCl1SD4VEqudprdTlCwpqsz1S9sOmHVtmqps0fQsqr3zvv9zGja9XxwF6uHaVNeylmj4rB0bCCVJM9j6UkwnAIyB0hVP3WmNO4gvwbMXF+IOBRBLgU0Mfn6DQk3HXLPKTc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689257777; h=Content-Type:Content-Transfer-Encoding:Cc: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=x3Mp+xlgNAuaBWhFYpz9EUxZ9w9g74Q3n/wYUH9S5Mw=; b=dNmi0lYa5BfxAwdGcu7Tbkf3fP6gqkpEjD9VGSB8ZyTZwMubsG3JuD6ARbmD54ZsGtSSHfbL+9GS1rom1hPeiAUHI4iHTN2PhR8xZLyfFaOShHzsdPEUbo65F0tEFBDNq8qLvvrRjZJ7gpBFfgD/L/pfKSGB7nLkR/c3rWm9ioQ= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=quarantine dis=quarantine) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 168925777700264.55505374996517; Thu, 13 Jul 2023 07:16:17 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-170-QiuvZMXTOr2vSbCYS4uuIA-1; Thu, 13 Jul 2023 10:15:11 -0400 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 6345B8B0371; Thu, 13 Jul 2023 14:07:40 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 4B4B44CD0D3; Thu, 13 Jul 2023 14:07:40 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 76E91194E123; Thu, 13 Jul 2023 14:05:51 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 81E6D1946589 for ; Thu, 13 Jul 2023 11:43:25 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 725CBF66CF; Thu, 13 Jul 2023 11:43:25 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast03.extmail.prod.ext.rdu2.redhat.com [10.11.55.19]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 6A81FF66A1 for ; Thu, 13 Jul 2023 11:43:25 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [207.211.31.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 466ED8F2982 for ; Thu, 13 Jul 2023 11:43:25 +0000 (UTC) Received: from relay0.allsecuredomains.com (relay0.allsecuredomains.com [51.68.204.196]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-335-s6htbKjaP-m7VmsDZehSmw-1; Thu, 13 Jul 2023 07:43:23 -0400 Received: from [81.174.144.187] (helo=custard.lan) by relay0.allsecuredomains.com with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qJu3X-0006s8-Bx; Thu, 13 Jul 2023 11:00:19 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689257775; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=x3Mp+xlgNAuaBWhFYpz9EUxZ9w9g74Q3n/wYUH9S5Mw=; b=SL7y9Z9yFCxFfWZ13ey8DpgleFtjLY33HVxolUYKFLLMloxv81ksOkvAuqWvChyCzTYapG Oz3YlJX/VX/AmKMf4U+c4dBX0N2sxGOJDYlx+1WVBw2kjdnM6MZm3oY10WWiSA4OlqoOJC YlSkEQlEfo0zklc06b+v7Ez5kc+P/HA= X-MC-Unique: QiuvZMXTOr2vSbCYS4uuIA-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: s6htbKjaP-m7VmsDZehSmw-1 From: Tim Small To: libvir-list@redhat.com Subject: [libvirt PATCH 09/10] docs: Fix deprecated use of implicit meson "setup" command Date: Thu, 13 Jul 2023 12:00:03 +0100 Message-Id: <20230713110004.1878682-10-tim@seoss.co.uk> In-Reply-To: <20230713110004.1878682-1-tim@seoss.co.uk> References: <20230713110004.1878682-1-tim@seoss.co.uk> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 3.1 on 10.11.54.5 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tim Small Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.10 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: seoss.co.uk Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689257849265100001 Content-Type: text/plain; charset="utf-8"; x-default="true" Use the explicit meson "setup" command instead of the deprecated implicit invocation. The implied setup usage generates a warning with meson version 1.0.1: WARNING: Running the setup command as `meson [options]` instead of `meson setup [options]` is ambiguous and deprecated. Additionally the implicit command is likely to be confusing to those unfamiliar with Meson - the `build` argument in `meson build` resembles an action rather than an arbitrary path. Signed-off-by: Tim Small Reviewed-by: Michal Privoznik --- docs/compiling.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/compiling.rst b/docs/compiling.rst index 2a740ad76e..c03238b114 100644 --- a/docs/compiling.rst +++ b/docs/compiling.rst @@ -68,7 +68,7 @@ of the build directory which will be created. =20 :: =20 - $ meson build [options] + $ meson setup build [options] =20 To get the complete list of the options run the following command: =20 @@ -83,7 +83,7 @@ normal OS vendor prefixes, use =20 :: =20 - $ meson build -Dsystem=3Dtrue + $ meson setup build -Dsystem=3Dtrue =20 Explicitly enabling required functionality ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -99,7 +99,7 @@ libvirt project with support for the **qemu** driver use = the following options: =20 :: =20 - $ meson build -Dsystem=3Dtrue -Ddriver_qemu=3Denabled + $ meson setup build -Dsystem=3Dtrue -Ddriver_qemu=3Denabled =20 Notes: ~~~~~~ --=20 2.39.2 From nobody Sat May 18 02:17:08 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=quarantine dis=quarantine) header.from=seoss.co.uk ARC-Seal: i=1; a=rsa-sha256; t=1689257931; cv=none; d=zohomail.com; s=zohoarc; b=j0SSCjBvQGNKdejDjbVrQ2UjqWbU2JCRXDAj9truAguCtA9ibzLBQbg7Td2x05CeTYw/QIjUge2/7CVZjd4LNcqMvCRsY8BK8ABIawOKseobKLrDBGNAPv4XnRPIXtE4kmhHcpIpfcAnSMMC9m1SVxnzNcyIADeoL7CX30rFU1I= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689257931; h=Content-Type:Content-Transfer-Encoding:Cc: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=Ovfn74Gtk6OafMkmiKVQMTKBDApRt4cIYj08Foo1gyo=; b=SeR/E2AZD/pKhlAAYh5eXWwLDxnbPyGwLUHhFmKxtE+Q4Dpt2HOSHDvZaBz4CJELRhq6fBdSUjMrIWzM3g18NBuxuWyTvsh3Iis2SnyL4mKs04APLl4ObyTCTYOgigTKyZuugLYoSus8NfBA9tZgU2IUXlAqsGpHXIT8nqOZZlc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=quarantine dis=quarantine) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1689257931208623.2277845591374; Thu, 13 Jul 2023 07:18:51 -0700 (PDT) Received: from mimecast-mx02.redhat.com (66.187.233.73 [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-10-Nz-WiDL7Pr6JTsFXnGdrtA-1; Thu, 13 Jul 2023 10:17:49 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id E6BF529324B0; Thu, 13 Jul 2023 14:08:58 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id D20ED200AD6E; Thu, 13 Jul 2023 14:08:58 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 9D48419376EC; Thu, 13 Jul 2023 14:06:57 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 54CA71946589 for ; Thu, 13 Jul 2023 11:43:19 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id F3B34111E3EB; Thu, 13 Jul 2023 11:43:18 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast09.extmail.prod.ext.rdu2.redhat.com [10.11.55.25]) by smtp.corp.redhat.com (Postfix) with ESMTPS id EC53D111E3EA for ; Thu, 13 Jul 2023 11:43:18 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 8545928EA6E6 for ; Thu, 13 Jul 2023 11:43:18 +0000 (UTC) Received: from relay0.allsecuredomains.com (relay0.allsecuredomains.com [51.68.204.196]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-296-j09XH_9qNgC_2OBJDCxl6g-1; Thu, 13 Jul 2023 07:43:16 -0400 Received: from [81.174.144.187] (helo=custard.lan) by relay0.allsecuredomains.com with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qJu3X-0006s8-Ir; Thu, 13 Jul 2023 11:00:19 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689257930; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc: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=Ovfn74Gtk6OafMkmiKVQMTKBDApRt4cIYj08Foo1gyo=; b=SR4PjQ7VH2r2COaeiTnLcQgwQUBLn/C1q/pgGGQD6IyPCCby56klFeDP12yft3kdQ2gzZa SWVYZPDJBK/Uggjf8bI9dwBYWDv7pp5BFilunzj2QbiQOPs74JOMjKf6lwhOZMHRgz7Zba 3Pns2EMOgkIPvi53Z4akukucjx3DW98= X-MC-Unique: Nz-WiDL7Pr6JTsFXnGdrtA-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: j09XH_9qNgC_2OBJDCxl6g-1 From: Tim Small To: libvir-list@redhat.com Subject: [libvirt PATCH 10/10] docs: Reword ninja invocation note to clarify build directory Date: Thu, 13 Jul 2023 12:00:04 +0100 Message-Id: <20230713110004.1878682-11-tim@seoss.co.uk> In-Reply-To: <20230713110004.1878682-1-tim@seoss.co.uk> References: <20230713110004.1878682-1-tim@seoss.co.uk> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 3.1 on 10.11.54.3 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tim Small Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.4 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: seoss.co.uk Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689257932236100001 Content-Type: text/plain; charset="utf-8"; x-default="true" Minor rewording to clarify purpose of the -C flag in the ninja invocation, whilst retaining previous meaning. Signed-off-by: Tim Small Reviewed-by: Michal Privoznik --- docs/compiling.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/compiling.rst b/docs/compiling.rst index c03238b114..800264d2f9 100644 --- a/docs/compiling.rst +++ b/docs/compiling.rst @@ -116,14 +116,16 @@ checked in the top level ``meson.build`` file in the = ``meson_version`` field. Compiling the sources --------------------- =20 -To build the configured project run (note that ``-C build`` is a path to t= he -build directory): +Compilation can be carried out by ``ninja``: =20 :: =20 $ ninja -C build =20 -The ``build`` directory now contains the built binaries. +"``build``" is the path to a directory which must match a path previously = given +to ``meson setup``. + +Binaries and other resulting files can be found within the build directory. =20 Additionally you can also run the test suite: =20 --=20 2.39.2