From nobody Sat Feb 7 11:40:46 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1728395106196139.97257455188526; Tue, 8 Oct 2024 06:45:06 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 287D8142C; Tue, 8 Oct 2024 09:45:05 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id CBC0211EE; Tue, 8 Oct 2024 09:44:12 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 67124E98; Tue, 8 Oct 2024 09:44:07 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 3A15DE7C for ; Tue, 8 Oct 2024 09:44:06 -0400 (EDT) Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-34--3kPIrWnPKWeSBYxNI549Q-1; Tue, 08 Oct 2024 09:44:04 -0400 Received: from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.40]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id BF29619560BD for ; Tue, 8 Oct 2024 13:44:03 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.45.242.12]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id E5A4219560AA for ; Tue, 8 Oct 2024 13:44:02 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.5 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1728395045; h=from:from: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; bh=OrHM2HkuN7Q4VQzUOKE6Or7gUZW4KPS0rMOtdjFGdLY=; b=iFiBuKtvix+gQH68MrEkVSI3oao0d8brw8NeUk0FZyY3TYU1zF4EeORJt+chACDQc/OrPO aEQYcfpt7CHJt9Nq+hiIDhv8y7hS8K5LvyyHoJ+9gENpHujEHiak2wpiEgbVYdqZOhEiPp KcKYy3d41mpMLYW2uByYJBeGst5/pvw= X-MC-Unique: -3kPIrWnPKWeSBYxNI549Q-1 From: Peter Krempa To: devel@lists.libvirt.org Subject: [PATCH 1/6] docs: remote: Replace broken link to article about 'ssh-agent' Date: Tue, 8 Oct 2024 15:43:54 +0200 Message-ID: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: HA7DB6FISH2DKVMYCPIZEXHHXJAKVG5O X-Message-ID-Hash: HA7DB6FISH2DKVMYCPIZEXHHXJAKVG5O X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1728395106901116600 Content-Type: text/plain; charset="utf-8" The documentation about remote access to libvirt was pointing to a blog post about usage of the 'ssh-agent' to avoid being asked for passwords. The blog/host is now unfortunately defunct thus the link is dead. Replace the link by the official man page of the 'ssh-agent' program. This convenietnly removes the last non-'https' link on our web. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/remote.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/remote.rst b/docs/remote.rst index ab11405d56..8fb7f1e2ad 100644 --- a/docs/remote.rst +++ b/docs/remote.rst @@ -57,7 +57,7 @@ Remote libvirt supports a range of transports: shell) `__ connection. Requires `Netcat (nc) `__ installed and libvirtd s= hould be running on the remote machine. You should use some sort of ssh key mana= gement - (eg. `ssh-agent `__) otherwise progr= ams + (eg. `ssh-agent `__) otherwise progr= ams which use this transport will stop to ask for a password. ``ext`` Any external program which can make a connection to the remote machine = by --=20 2.46.0 From nobody Sat Feb 7 11:40:46 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1728395126538880.1442704009697; Tue, 8 Oct 2024 06:45:26 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 65FDC161A; Tue, 8 Oct 2024 09:45:25 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 4E4431634; Tue, 8 Oct 2024 09:44:14 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 50DA410A2; Tue, 8 Oct 2024 09:44:08 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id CCB59BD1 for ; Tue, 8 Oct 2024 09:44:07 -0400 (EDT) Received: from mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-265-rPUuC0opMCyyqhySj2jIPA-1; Tue, 08 Oct 2024 09:44:05 -0400 Received: from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.40]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 227001955EEA for ; Tue, 8 Oct 2024 13:44:05 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.45.242.12]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 50DC719560AA for ; Tue, 8 Oct 2024 13:44:04 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.5 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1728395047; h=from:from: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; bh=XW/ux321YYzsDi4Rzxt7nKNUfvE4Pt9FKhXF/lve6AY=; b=VYCR/2aZ7nNfTZHaq1MTpP+tz6uQIypKgTASL5YPMlJ0NHEJvulKnjB7GMSEXD14B8HMMM LewtRMS6Dej75JfODWGMP1xG/1bPcsjTbDt+mKMEBB6Nat792VxZ0RVLOFZwQffPOMddO0 YT+3ok9musttAWjVTKGPNn8u7sEpX+g= X-MC-Unique: rPUuC0opMCyyqhySj2jIPA-1 From: Peter Krempa To: devel@lists.libvirt.org Subject: [PATCH 2/6] docs: Reject non-https external links Date: Tue, 8 Oct 2024 15:43:55 +0200 Message-ID: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: LQHAM6TWMRIX5OSTWRWR6B5KJPNXMYIK X-Message-ID-Hash: LQHAM6TWMRIX5OSTWRWR6B5KJPNXMYIK X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1728395127135116600 Content-Type: text/plain; charset="utf-8" Add a '--require-https' switch to 'check-html-references' helper script which will error out if any non-https external link is used from our web and use it while builidng docs. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/meson.build | 1 + scripts/check-html-references.py | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/docs/meson.build b/docs/meson.build index 53b518f987..a94f481730 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -358,6 +358,7 @@ if tests_enabled[0] python3_prog, args: [ check_html_references_prog.full_path(), + '--require-https', '--webroot', meson.project_build_root() / 'docs' ], diff --git a/scripts/check-html-references.py b/scripts/check-html-referenc= es.py index d15f28bea7..3382d838c5 100755 --- a/scripts/check-html-references.py +++ b/scripts/check-html-references.py @@ -224,6 +224,18 @@ def check_images(usedimages, imagefiles, ignoreimages): return fail +# checks that all links are accessed via https +def check_https(links): + fail =3D False + + for link in links: + if link.startswith('http://'): + print(f'ERROR: URI \'{link}\' uses insecure "http" protocol') + fail =3D True + + return fail + + parser =3D argparse.ArgumentParser(description=3D'HTML reference checker') parser.add_argument('--webroot', required=3DTrue, help=3D'path to the web root') @@ -233,6 +245,8 @@ parser.add_argument('--external', action=3D"store_true", help=3D'print external references instead') parser.add_argument('--ignore-images', action=3D'append', help=3D'paths to images that should be considered as u= sed') +parser.add_argument('--require-https', action=3D"store_true", + help=3D'require secure https for external links') args =3D parser.parse_args() @@ -269,6 +283,13 @@ else: if check_images(usedimages, imagefiles, args.ignore_images): fail =3D True + if args.require_https: + if check_https(externallinks): + fail =3D True + + if check_https(externalimages): + fail =3D True + if fail: sys.exit(1) --=20 2.46.0 From nobody Sat Feb 7 11:40:46 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 172839514376326.394315295145248; Tue, 8 Oct 2024 06:45:43 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 9F1E4165A; Tue, 8 Oct 2024 09:45:42 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 516941616; Tue, 8 Oct 2024 09:44:22 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 40CDF15DE; Tue, 8 Oct 2024 09:44:18 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 0346315B3 for ; Tue, 8 Oct 2024 09:44:09 -0400 (EDT) Received: from mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-553-52EcdgA0NvWiY4P0s2dJKw-1; Tue, 08 Oct 2024 09:44:07 -0400 Received: from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.40]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 745C219560B5 for ; Tue, 8 Oct 2024 13:44:06 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.45.242.12]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id A078D19560AA for ; Tue, 8 Oct 2024 13:44:05 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.5 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1728395049; h=from:from: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; bh=b4GNrrOXC6aws+iYQTDmI8oe9m/Qy84ZrQFLMn9pHcM=; b=QnuEKpFzgL0D66gzI8qee4IRMrgdsIdnbjboGAKs1smqamgFDgaTr5uMQfhhYvj2kKuGwH TjEmStDJo3nhebQL0j/LFmcnmBNLNwCxOZadaxfUh9t07gYS9bdrqyNrMhS26/FDlSULxL AyzTeWJfgo0FG2JZyDBY2PTIauXADIg= X-MC-Unique: 52EcdgA0NvWiY4P0s2dJKw-1 From: Peter Krempa To: devel@lists.libvirt.org Subject: [PATCH 3/6] kbase: Fix link in 'merging_disk_image_chains' article Date: Tue, 8 Oct 2024 15:43:56 +0200 Message-ID: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: URC2YRMI2HOTCTJKMSZDKOWWA2NN5GUS X-Message-ID-Hash: URC2YRMI2HOTCTJKMSZDKOWWA2NN5GUS X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1728395145062116600 Content-Type: text/plain; charset="utf-8" Use the proper rST syntax for an external link. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/kbase/merging_disk_image_chains.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kbase/merging_disk_image_chains.rst b/docs/kbase/merging_= disk_image_chains.rst index 2ff8b7cd76..9bff8da1af 100644 --- a/docs/kbase/merging_disk_image_chains.rst +++ b/docs/kbase/merging_disk_image_chains.rst @@ -20,7 +20,7 @@ accomplish this *without* incurring guest down time. Her= e's how to go about it. The same principles used in the `live full disk backup -` document are +`_ document are used here too. Reducing the disk image chain length --=20 2.46.0 From nobody Sat Feb 7 11:40:46 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1728395183838462.1575216466438; Tue, 8 Oct 2024 06:46:23 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id BD08F15DE; Tue, 8 Oct 2024 09:46:22 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 438B714F0; Tue, 8 Oct 2024 09:44:25 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 8D8401430; Tue, 8 Oct 2024 09:44:19 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 4F89615D9 for ; Tue, 8 Oct 2024 09:44:10 -0400 (EDT) Received: from mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-499-QyVI0rR9MR2ojZVjpREODA-1; Tue, 08 Oct 2024 09:44:08 -0400 Received: from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.40]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id C93B8195608F for ; Tue, 8 Oct 2024 13:44:07 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.45.242.12]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 082A819560AA for ; Tue, 8 Oct 2024 13:44:06 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.5 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1728395050; h=from:from: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; bh=sD5K6Dqw3KrMqlMSKg7fvNuNBURwbpuRui/f7l/YMgU=; b=Z9Uc4O6jxiq8K2o7t7rAflHJFsSHRtADbxfCDWRBmcnStdmrpV12vWZWEA7onsE3i4qhs5 /lhaJr1bf56NMrTpC/s7fcXIcmNxsSS8W+lrPiS4isd8l4bL/bKzSvMzmg4++2i40x9TaI lUIpJQaCqQIZ+YsxRP1WvmlMTpisZ9U= X-MC-Unique: QyVI0rR9MR2ojZVjpREODA-1 From: Peter Krempa To: devel@lists.libvirt.org Subject: [PATCH 4/6] docs: Use relative links within the web page Date: Tue, 8 Oct 2024 15:43:57 +0200 Message-ID: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: WPJP5KO3EPEHDVCP6K5DNHNB34FIPPTF X-Message-ID-Hash: WPJP5KO3EPEHDVCP6K5DNHNB34FIPPTF X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1728395185389116600 Content-Type: text/plain; charset="utf-8" Replace full/external links which point to content within 'https://libvirt.org/' with relative links so that the web page works fully locally. This does not change the links in 'docs/manpages' as we want the installed man page to work from everywhere (even when the local docs are not installed) and the generated API docs which take links from the C source. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/api_extension.rst | 4 +--- docs/issue-handling.rst | 2 +- docs/kbase/backing_chains.rst | 4 ++-- docs/kbase/debuglogs.rst | 4 ++-- docs/kbase/internals/incremental-backup.rst | 6 +++--- docs/kbase/launch_security_sev.rst | 2 +- docs/kbase/live_full_disk_backup.rst | 2 +- docs/kbase/merging_disk_image_chains.rst | 6 ++---- docs/kbase/rpm-deployment.rst | 2 +- docs/kbase/s390_protected_virt.rst | 2 +- docs/kbase/systemtap.rst | 2 +- docs/securityprocess.rst | 2 +- docs/testtck.rst | 2 +- docs/windows.rst | 5 ++--- 14 files changed, 20 insertions(+), 25 deletions(-) diff --git a/docs/api_extension.rst b/docs/api_extension.rst index a42c82daca..b9f701dd11 100644 --- a/docs/api_extension.rst +++ b/docs/api_extension.rst @@ -23,9 +23,7 @@ Adding a new API to libvirt is not difficult, but there a= re quite a few steps. This document assumes that you are familiar with C programming and have checked out the libvirt code from the source code repository and successfully built the existing tree. Instructions on how to check -out and build the code can be found at: - -https://libvirt.org/downloads.html +out and build the code can be found at the `downloads `__ = page. Once you have a working development environment, the steps to create a new API are: diff --git a/docs/issue-handling.rst b/docs/issue-handling.rst index cfde53f876..b4269e01b7 100644 --- a/docs/issue-handling.rst +++ b/docs/issue-handling.rst @@ -178,5 +178,5 @@ community. .. _Untriaged issues: https://gitlab.com/libvirt/libvirt/-/issues/?sort=3D= created_date&state=3Dopened¬%5Blabel_name%5D%5B%5D=3Dstate%3A%3Aunconfir= med¬%5Blabel_name%5D%5B%5D=3Dstate%3A%3Aneedinfo¬%5Blabel_name%5D%5B%= 5D=3Dstate%3A%3Aconfirmed&first_page_size=3D100 .. _Unconfirmed bugs: https://gitlab.com/libvirt/libvirt/-/issues/?sort=3D= created_date&state=3Dopened&label_name%5B%5D=3Dkind%3A%3Abug&label_name%5B%= 5D=3Dstate%3A%3Aunconfirmed&first_page_size=3D100 .. _Unconfirmed features: https://gitlab.com/libvirt/libvirt/-/issues/?sor= t=3Dcreated_date&state=3Dopened&label_name%5B%5D=3Dkind%3A%3Aenhancement&la= bel_name%5B%5D=3Dstate%3A%3Aunconfirmed&first_page_size=3D100 -.. _debug logs: https://libvirt.org/kbase/debuglogs.html +.. _debug logs: kbase/debuglogs.html .. _code of conduct: governance.html#code-of-conduct diff --git a/docs/kbase/backing_chains.rst b/docs/kbase/backing_chains.rst index 38a9a2337b..1c5e231195 100644 --- a/docs/kbase/backing_chains.rst +++ b/docs/kbase/backing_chains.rst @@ -97,8 +97,8 @@ specification can be used: This makes libvirt follow the settings as configured in the XML. Note that= this -is supported only when the https://libvirt.org/formatdomaincaps.html#backi= ngstoreinput -capability is present. +is supported only when the `backingStoreInput +<../formatdomaincaps.html#backingstoreinput>`_ capability is present. An empty ```` element signals the end of the chain. Using t= his will prevent libvirt or qemu from probing the backing chain. diff --git a/docs/kbase/debuglogs.rst b/docs/kbase/debuglogs.rst index dff2cfd144..f8c05b6922 100644 --- a/docs/kbase/debuglogs.rst +++ b/docs/kbase/debuglogs.rst @@ -120,8 +120,8 @@ Libvirt daemons run either in the ``system`` mode or on= ``session`` (user) mode, depending on the configuration of the host and available permission levels. -The `connection URI `__ influences which dae= mon -the client will communicate with. +The `connection URI <../uri.html>`__ influences which daemon the client wi= ll +communicate with. System daemon mode ~~~~~~~~~~~~~~~~~~ diff --git a/docs/kbase/internals/incremental-backup.rst b/docs/kbase/inter= nals/incremental-backup.rst index 29e90092e8..af464e8178 100644 --- a/docs/kbase/internals/incremental-backup.rst +++ b/docs/kbase/internals/incremental-backup.rst @@ -16,9 +16,9 @@ this document will try to summarize them. Glossary =3D=3D=3D=3D=3D=3D=3D=3D -See the knowledge base article on -`domain state capture `= _ for -a deeper explanation of some of the concepts. +See the knowledge base article on `domain state capture +<../domainstatecapture.html>`_ for a deeper explanation of some of the +concepts. Checkpoint diff --git a/docs/kbase/launch_security_sev.rst b/docs/kbase/launch_securit= y_sev.rst index 6a3740d297..cfde2c49dc 100644 --- a/docs/kbase/launch_security_sev.rst +++ b/docs/kbase/launch_security_sev.rst @@ -154,7 +154,7 @@ VM Configuration =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D SEV is enabled in the XML by specifying the -` `= __ +` <../formatdomain.html#launch-security>`__ element. However, specifying ``launchSecurity`` isn't enough to boot an SEV VM. Further configuration requirements are discussed below. diff --git a/docs/kbase/live_full_disk_backup.rst b/docs/kbase/live_full_di= sk_backup.rst index f20169e314..f9dcd2a1bd 100644 --- a/docs/kbase/live_full_disk_backup.rst +++ b/docs/kbase/live_full_disk_backup.rst @@ -10,7 +10,7 @@ Overview Live full disk backups are preferred in many scenarios, *despite* their space requirements. The following outlines an efficient method to do that using libvirt's APIs. This method involves concepts: the notion of -`backing chains `_, +`backing chains `_, `QCOW2 overlays `_, and a special operation called "active block-commit", which allows diff --git a/docs/kbase/merging_disk_image_chains.rst b/docs/kbase/merging_= disk_image_chains.rst index 9bff8da1af..40b565f74b 100644 --- a/docs/kbase/merging_disk_image_chains.rst +++ b/docs/kbase/merging_disk_image_chains.rst @@ -7,8 +7,7 @@ Merging disk image image chains Context =3D=3D=3D=3D=3D=3D=3D -Sometimes a `disk image chain -`_ can get long and +Sometimes a `disk image chain `_ can get long and cumbersome. For the purpose of illustration, consider this smaller disk image chain:: @@ -20,8 +19,7 @@ accomplish this *without* incurring guest down time. Her= e's how to go about it. The same principles used in the `live full disk backup -`_ document are -used here too. +`_ document are used here too. Reducing the disk image chain length =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 diff --git a/docs/kbase/rpm-deployment.rst b/docs/kbase/rpm-deployment.rst index 26fe1be8e6..ae2ed42eb6 100644 --- a/docs/kbase/rpm-deployment.rst +++ b/docs/kbase/rpm-deployment.rst @@ -370,7 +370,7 @@ RPM packages * libvirt-docs - A local copy of the `libvirt website `_ website con= tent + A local copy of the libvirt website website content that matches the deployed version of libvirt. * libvirt-libs diff --git a/docs/kbase/s390_protected_virt.rst b/docs/kbase/s390_protected= _virt.rst index a8c627931b..faacd6fc7a 100644 --- a/docs/kbase/s390_protected_virt.rst +++ b/docs/kbase/s390_protected_virt.rst @@ -128,7 +128,7 @@ As the virtio data structures of secure guests are not = accessible by the host, it is necessary to use shared memory ('bounce buffers'). Since libvirt 7.6.0 the -` `= __ +` <../formatdomain.html#launch-security>`__ element with type ``s390-pv`` should be used on protected virtualization g= uests. Without ``launchSecurity`` you must enable all virtio devices to use shared buffers by configuring them with platform_iommu enabled. diff --git a/docs/kbase/systemtap.rst b/docs/kbase/systemtap.rst index 8a3acabdf7..5d4717b7aa 100644 --- a/docs/kbase/systemtap.rst +++ b/docs/kbase/systemtap.rst @@ -27,7 +27,7 @@ For libvirt before **6.7.0**, it can be configured by: ../configure --with-dtrace For libvirt **6.7.0** or later, configure it by the ``meson`` (seeing -`libvirt compiling `__): +`libvirt compiling <../compiling.html>`__): :: diff --git a/docs/securityprocess.rst b/docs/securityprocess.rst index 1f5176ec75..075679df74 100644 --- a/docs/securityprocess.rst +++ b/docs/securityprocess.rst @@ -35,7 +35,7 @@ format in the `libvirt-security-notice GIT repository `__ and `published online `__ in text, HTML and XML formats. Security notices are published on the `libvirt-announce mailing -list `__ when any embargo = is +list `__ when any embargo is lifted, or as soon as triaged if already public knowledge. Security team diff --git a/docs/testtck.rst b/docs/testtck.rst index 568899dcdd..621dadf0db 100644 --- a/docs/testtck.rst +++ b/docs/testtck.rst @@ -101,7 +101,7 @@ script containing functions describing GitLab job defin= itions it can be utilized to run integration test suite as well. In this case, one needs to get a copy of their libvirt repository containing the changes to be tested inside the VM (either by cloning it manually or sharing the repo e.g. via -`virtiofs `__). Make sure that the +`virtiofs `__). Make sure that the user which is going to execute the following has passwordless "sudo" permi= ssions (lcitool's default "test" user does). Then it's just a matter of running diff --git a/docs/windows.rst b/docs/windows.rst index ee3caef41a..37fd8e02d9 100644 --- a/docs/windows.rst +++ b/docs/windows.rst @@ -54,9 +54,8 @@ Connecting to VMware ESX/vSphere -------------------------------- Details on the capabilities, certificates, and connection string syntax us= ed for -connecting to VMware ESX and vSphere can be found online here: - -https://libvirt.org/drvesx.html +connecting to VMware ESX and vSphere can be found on the +`ESX driver `_ page. TLS Certificates ---------------- --=20 2.46.0 From nobody Sat Feb 7 11:40:46 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1728395203914432.55980989413615; Tue, 8 Oct 2024 06:46:43 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id DCA5715B6; Tue, 8 Oct 2024 09:46:42 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 986251625; Tue, 8 Oct 2024 09:44:27 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 4AC7114B3; Tue, 8 Oct 2024 09:44:21 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id B7FF1161A for ; Tue, 8 Oct 2024 09:44:11 -0400 (EDT) Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-453-4Z1SOlMrMH2yW15vmJwrUQ-1; Tue, 08 Oct 2024 09:44:10 -0400 Received: from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.40]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 2E31719560BD for ; Tue, 8 Oct 2024 13:44:09 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.45.242.12]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 4FF33195605A for ; Tue, 8 Oct 2024 13:44:08 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.5 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1728395051; h=from:from: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; bh=axJkwEtd2MlfYepjFnGoIGpN9xU+83IeWWGO1jqOpr0=; b=ctVUX6XIwt1xhM/k7bsHfI8onbptbDNX3jyMtQ11J8rTMFTLn29tTX+NHu1WJr9nxZMUgu PHDImgz6EOKMdGiQOoKkovf15TJN3ShMVxX+nsfkfYW3dLECELIKiPO4NbnPpECjyK7DW6 RTuJ5YsOb4CkSBgu0EiyF1J0CzxaWgk= X-MC-Unique: 4Z1SOlMrMH2yW15vmJwrUQ-1 From: Peter Krempa To: devel@lists.libvirt.org Subject: [PATCH 5/6] docs: newreposetup: Drop section about 'libvirt project server' Date: Tue, 8 Oct 2024 15:43:58 +0200 Message-ID: <367fa8be6fd757a25a2033b21f946083473cc4b4.1728394993.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: G55EYCMQOMPQLJBRK7XJXRT2YCAFPF7S X-Message-ID-Hash: G55EYCMQOMPQLJBRK7XJXRT2YCAFPF7S X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1728395205722116600 Content-Type: text/plain; charset="utf-8" Now that most things were migrated out of the old server which hosted the 'libvirt.org' web (now handles only 'https://download.libvirt.org') which no longer even hosts the cgit web interface (any link redirects to gitlab) the whole section now is obsolete. Remove it. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/newreposetup.rst | 34 ---------------------------------- 1 file changed, 34 deletions(-) diff --git a/docs/newreposetup.rst b/docs/newreposetup.rst index d5375b23ea..17f74d8659 100644 --- a/docs/newreposetup.rst +++ b/docs/newreposetup.rst @@ -129,37 +129,3 @@ required under the **Settings** page: In the master git repository create a file `.github/lockdown.yml` to restr= ict use of issue tracker and pull requests. - - -libvirt.org -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D - -The `libvirt project server `_ hosts read-only mirror= s of -all the libvirt Git repositories in the directory ``/data/git``. - -When creating a new repository the following steps are required: - -* Create repo with - :: - - $ sudo su - - # cd /data/git - # mkdir $repo.git - # cd $repo.git - # git init --bare - # touch export - # touch git-daemon-export-ok - # cd .. - # chown -R gitmirror.gitmirror $repo.git - # chmod -R g+w $repo.git - # find -type d $repo.git | xargs chmod g+s - -* Set the ``description`` and ``config`` files following other repos' exam= ple - -* Setup mirroring - :: - - $ sudo su - gitmirror - # ./newrepo.sh /data/git/$repo.git - # cd mirrors - # $HOME/sync-one.sh $repo.git --=20 2.46.0 From nobody Sat Feb 7 11:40:46 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1728395243436879.0528559837118; Tue, 8 Oct 2024 06:47:23 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 53CA5A97; Tue, 8 Oct 2024 09:47:22 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 06E001669; Tue, 8 Oct 2024 09:44:30 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id AFA3B1621; Tue, 8 Oct 2024 09:44:24 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 0B8211621 for ; Tue, 8 Oct 2024 09:44:13 -0400 (EDT) Received: from mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-120-kEfZPEziMdyJgEky_5juaQ-1; Tue, 08 Oct 2024 09:44:11 -0400 Received: from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.40]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 6E46A1955D92 for ; Tue, 8 Oct 2024 13:44:10 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.45.242.12]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id A3D8A19560AA for ; Tue, 8 Oct 2024 13:44:09 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.5 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1728395052; h=from:from: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; bh=sd15rMsHPMALyZKIxQzvtHOG8PmjuCV882NlJn0owwE=; b=EbSG4isd0FO+dFByDAca/X5oGnpxC3iO4xVDIXIuEVEfJzC5JmS6PBQKWUuMO9xSw2GTXg ppIydCiBYJYZPfIcYiN8ptyQeX2m7Xh6eGBKFQ/1lEOLcrE+GMET6gnxGUzgb88z3lBBgN 8tq+s60zNUijXSBL9x7AVj/3aguJXQM= X-MC-Unique: kEfZPEziMdyJgEky_5juaQ-1 From: Peter Krempa To: devel@lists.libvirt.org Subject: [PATCH 6/6] docs: Prohibit 'external' links within the webpage Date: Tue, 8 Oct 2024 15:43:59 +0200 Message-ID: <863f62b3af11ca8f4a5bb0ed313a26658d59f531.1728394993.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: UVALUJSUEBAGZPN7NU3JWNG6QOMQXRNO X-Message-ID-Hash: UVALUJSUEBAGZPN7NU3JWNG6QOMQXRNO X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1728395245645116600 Content-Type: text/plain; charset="utf-8" Enforce that relative links are used within the page, so that local installations don't require internet conection and/or don't redirect to the web needlessly. This is done by looking for any local link (barring exceptions) when checking links with 'check-html-references.py'. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/meson.build | 3 +++ scripts/check-html-references.py | 46 +++++++++++++++++++++++++++----- 2 files changed, 43 insertions(+), 6 deletions(-) diff --git a/docs/meson.build b/docs/meson.build index a94f481730..d7343b6665 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -359,6 +359,9 @@ if tests_enabled[0] args: [ check_html_references_prog.full_path(), '--require-https', + '--project-uri', 'https://libvirt.org', + '--project-uri-exceptions', 'docs/manpages/', + '--project-uri-exceptions', 'docs/html/', '--webroot', meson.project_build_root() / 'docs' ], diff --git a/scripts/check-html-references.py b/scripts/check-html-referenc= es.py index 3382d838c5..74299a1958 100755 --- a/scripts/check-html-references.py +++ b/scripts/check-html-references.py @@ -53,7 +53,7 @@ def get_file_list(prefix): # loads an XHTML and extracts all anchors, local and remote links for the = one file -def process_file(filename): +def process_file(filename, project_uri): tree =3D ET.parse(filename) root =3D tree.getroot() docname =3D root.get('data-sourcedoc') @@ -65,6 +65,7 @@ def process_file(filename): anchors =3D [filename] targets =3D [] images =3D [] + projectlinks =3D [] for elem in root.findall('.//html:a', ns): target =3D elem.get('href') @@ -76,6 +77,10 @@ def process_file(filename): if target: if re.search('://', target): externallinks.append(target) + + if project_uri is not None and target.startswith(project_u= ri): + projectlinks.append((target, docname)) + elif target[0] !=3D '#' and 'mailto:' not in target: targetfull =3D os.path.normpath(os.path.join(dirname, targ= et)) @@ -106,22 +111,24 @@ def process_file(filename): imagefull =3D os.path.normpath(os.path.join(dirname, src)) images.append((imagefull, docname)) - return (anchors, targets, images) + return (anchors, targets, images, projectlinks) -def process_all(filelist): +def process_all(filelist, project_uri): anchors =3D [] targets =3D [] images =3D [] + projectlinks =3D [] for file in filelist: - anchor, target, image =3D process_file(file) + anchor, target, image, projectlink =3D process_file(file, project_= uri) targets =3D targets + target anchors =3D anchors + anchor images =3D images + image + projectlinks =3D projectlinks + projectlink - return (targets, anchors, images) + return (targets, anchors, images, projectlinks) def check_targets(targets, anchors): @@ -236,6 +243,26 @@ def check_https(links): return fail +# checks prohibited external links to local files +def check_projectlinks(projectlinks, exceptions): + fail =3D False + + for (link, filename) in projectlinks: + allowed =3D False + + if exceptions is not None: + for exc in exceptions: + if exc in filename: + allowed =3D True + break + + if not allowed: + print(f'ERROR: prohibited external URI \'{link}\' to local pro= ject in \'{filename}\'') + fail =3D True + + return fail + + parser =3D argparse.ArgumentParser(description=3D'HTML reference checker') parser.add_argument('--webroot', required=3DTrue, help=3D'path to the web root') @@ -247,6 +274,10 @@ parser.add_argument('--ignore-images', action=3D'appen= d', help=3D'paths to images that should be considered as u= sed') parser.add_argument('--require-https', action=3D"store_true", help=3D'require secure https for external links') +parser.add_argument('--project-uri', + help=3D'external prefix of the local project (e.g. htt= ps://libvirt.org; external links with that prefix are prohibited') +parser.add_argument('--project-uri-exceptions', action=3D'append', + help=3D'list of path prefixes excluded from the "--pro= ject-uri" checks') args =3D parser.parse_args() @@ -254,7 +285,7 @@ files, imagefiles =3D get_file_list(os.path.abspath(arg= s.webroot)) entrypoint =3D os.path.join(os.path.abspath(args.webroot), args.entrypoint) -targets, anchors, usedimages =3D process_all(files) +targets, anchors, usedimages, projectlinks =3D process_all(files, args.pro= ject_uri) fail =3D False @@ -283,6 +314,9 @@ else: if check_images(usedimages, imagefiles, args.ignore_images): fail =3D True + if check_projectlinks(projectlinks, args.project_uri_exceptions): + fail =3D True + if args.require_https: if check_https(externallinks): fail =3D True --=20 2.46.0