From nobody Mon Feb 9 04:59:58 2026 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=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1662732387; cv=none; d=zohomail.com; s=zohoarc; b=W44jzg57aQ15HDxkbG5JmCU0g3KQ8Wxz24NqMxx5Oe+nm5SZ67jthzC0LMGS0x8aak/gHaSmI8YB+f+JWYYptjPVAuT0PDQcSVguSKrwHFTYNU5zpkoucw2zWiMUKD06h+1OtXODrJiuhr9pD9qo63o7mEe91zX0FgnbCU2E1fM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1662732387; 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=AKxlZy4HfZBbPIvKOJ4Gus2sh1aexMPPp9iXwm23Gp0=; b=cporsvkxyZb2bVCRKr+4hZY4fPjEN7tHv4KfOo+nkHWyBS0bXRzf+x0eqNjw/eF6gGnPW3itL57VAMELIllwAOxfZJiQk4NdLHSGr4q539NXBxFH0Y+Wd/cbUHClWJ7bBBGPP14x5uh/DQSprM9vkPc+iCaKzpvGUNAX/SuxF58= 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=pass header.from= (p=none dis=none) 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 1662732387068278.7322730325128; Fri, 9 Sep 2022 07:06:27 -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-578-ILQufEOfNR2DY9SWJyUMFg-1; Fri, 09 Sep 2022 10:06:21 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 9C2E880A0C2; Fri, 9 Sep 2022 14:06:18 +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 77285C15BB3; Fri, 9 Sep 2022 14:06:18 +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 585791946A48; Fri, 9 Sep 2022 14:06:18 +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 5858B1946A53 for ; Fri, 9 Sep 2022 14:06:17 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 4B5E1112131E; Fri, 9 Sep 2022 14:06:17 +0000 (UTC) Received: from speedmetal.lan (unknown [10.40.208.30]) by smtp.corp.redhat.com (Postfix) with ESMTP id B7E091121315 for ; Fri, 9 Sep 2022 14:06:16 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1662732385; 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=AKxlZy4HfZBbPIvKOJ4Gus2sh1aexMPPp9iXwm23Gp0=; b=SHmvEkU0JeqcI/lpD++IgEXVR7d660d0+m1w5GGmc7Qgcg7hupv+aRCvvx8qiBY9z9DOlK 4F9Pw6x8SAvJRI0GOy7yeJD7vYhPEHv2d+XFuXOGewaCqIDdYV7frqB9I7mXxr4MqUC/CL Lccp4MNEVCHXNGpXAGxr8+i/zUjXo7I= X-MC-Unique: ILQufEOfNR2DY9SWJyUMFg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 3/6] docs: compiling: Separate information on how to install libvirt and add disclaimer Date: Fri, 9 Sep 2022 16:06:09 +0200 Message-Id: <475a1713ce86c5784b9d4130dcd2031341322bae.1662732168.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 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: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.85 on 10.11.54.8 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1662732388762100003 Content-Type: text/plain; charset="utf-8" Create a section for instructions on how to install the built binaries rather than mentioning it multiple times. Add a note that installing over your distro-provided packages will most likely break your instalation. Signed-off-by: Peter Krempa Reviewed-by: Jonathon Jongsma --- docs/compiling.rst | 44 +++++++++++++++++++++++++++++++------------- 1 file changed, 31 insertions(+), 13 deletions(-) diff --git a/docs/compiling.rst b/docs/compiling.rst index fc5556738d..c167fd238f 100644 --- a/docs/compiling.rst +++ b/docs/compiling.rst @@ -52,23 +52,12 @@ To get the complete list of the options run the followi= ng command: When you have determined which options you want to use (if any), continue the process. -Note the use of **sudo** with the *ninja install* command below. Using -sudo is only required when installing to a location your user does not -have write access to. Installing to a system location is a good example -of this. - -If you are installing to a location that your user *does* have write -access to, then you can instead run the *ninja install* command without -putting **sudo** before it. - :: $ meson build [possible options] $ ninja -C build - $ sudo ninja -C build install -At this point you **may** have to run ldconfig or a similar utility to -update your list of installed shared libs. +The ``build`` directory now contains the built binaries. Building from a GIT checkout ---------------------------- @@ -85,7 +74,6 @@ can be run: $ meson build --prefix=3D$HOME/usr $ ninja -C build - $ sudo ninja -C build install Be aware though, that binaries built with a custom prefix will not interoperate with OS vendor provided binaries, since the UNIX socket @@ -97,6 +85,7 @@ normal OS vendor prefixes, use $ meson build -Dsystem=3Dtrue $ ninja -C build +The ``build`` directory now contains the built binaries. Running compiled binaries from build directory ---------------------------------------------- @@ -120,3 +109,32 @@ It is also possible to run virsh directly from the bui= ld tree using the $ pwd /home/to/your/checkout/build $ ./run ./tools/virsh .... + +Installing compiled binaries +---------------------------- + +**Important:** Manual installation of libvirt is generally not recommended= and +you should prefer installation from package repository or from manually bu= ild +packages which are then installed using the package manager. Overwriting an +installation of libvirt from the package manager by a manually compilled +installation may not work properly. + +Installing of the compiled binaries into the appropriate location (based on +how the build was configured) is done by the following command: + +:: + + $ sudo ninja -C build install + +Note the use of **sudo** with the *ninja install* comman. Using +sudo is only required when installing to a location your user does not +have write access to. Installing to a system location is a good example +of this. + +If you are installing to a location that your user *does* have write +access to, then you can instead run the *ninja install* command without +putting **sudo** before it. + +After installation you you **may** have to run ``ldconfig`` or a similar +utility to update your list of installed shared libs, or adjust the paths = where +the system looks for binaries and shared libraries. --=20 2.37.1