From nobody Fri Apr 19 02:17:10 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) client-ip=205.139.110.61; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 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=1578650623; cv=none; d=zohomail.com; s=zohoarc; b=cHy7alB0wtJi2q3txOU3SqvYH94fD6itgbaH4SzZCfSibd/jIZwOe++0JRRlBpbREYKSeX3k8xmlY0xDuSUku5RgxuF+XRZdD1xTpxB745B0YQct4Q8iuc/sfA99zOMnVyXA2x90lcfBBwJyziUnI9WPASaWgtLHCLWth1bf7cU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1578650623; h=Content-Type:Content-Transfer-Encoding:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=MDNUBjKiPv7EPIMfcYdTSmSCK1ENTUdE1v55rmyGzek=; b=ah0r14MLjY+TOFyvAD6tLYBUZP4ifLoNSHhO0YlWLNAXHVZK/AcojKqX9GFhxmzyKSW9ZaOA6vOgX5rZIstuMrXthxND7hBMFQYHhVHZybdZbSii+culKp6rakxWpywoORcEGUpimG8rDUkbhY4CXWEyn0L8ZG4VNcpTspBPXnI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-1.mimecast.com (us-smtp-2.mimecast.com [205.139.110.61]) by mx.zohomail.com with SMTPS id 1578650623362629.7137203763361; Fri, 10 Jan 2020 02:03:43 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-354-oxRkJbHSPiCGahWqljN82w-1; Fri, 10 Jan 2020 05:03:40 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 5A69CDB20; Fri, 10 Jan 2020 10:03:35 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 290BD8062A; Fri, 10 Jan 2020 10:03:35 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id C3EE718089CD; Fri, 10 Jan 2020 10:03:34 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 00AA3Y4t032690 for ; Fri, 10 Jan 2020 05:03:34 -0500 Received: by smtp.corp.redhat.com (Postfix) id 140E35DA66; Fri, 10 Jan 2020 10:03:34 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-65.ams2.redhat.com [10.36.112.65]) by smtp.corp.redhat.com (Postfix) with ESMTP id D0D605DA2C; Fri, 10 Jan 2020 10:03:30 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1578650622; 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:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=MDNUBjKiPv7EPIMfcYdTSmSCK1ENTUdE1v55rmyGzek=; b=aIbgZkrKkZ0qv0UN3xb/7SU9pzNSJfxwbR8if20vxdqAN+CoTh4YO5biHq4ZNusZfegc95 M6y9D8qz3nNw2ji6vADfw/XuYn/QMjKf6oGklrH/p7U1hNrwj/mq3RyO1uE33U2XraDfMu Wz/ODRisoSrc6LTUvN7XnY9uvuNEr/M= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 10 Jan 2020 10:03:28 +0000 Message-Id: <20200110100328.3426061-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH] docs: add pages to support Go module package resolution X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-MC-Unique: oxRkJbHSPiCGahWqljN82w-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Currently the libvirt Go modules are accessed by applications using their github repository URLs. This is undesirable as we don't want applications to have a direct dependancy on a specific source repo location. We want to enable applications to use the Go packages via the libvirt.org namespace. When you do "go get libvirt.org/libvirt-go", the Go client will do an HTTPS request to that URL, and parse the HTML content to look for a tag which tells it where to the find the GIT repository. https://golang.org/cmd/go/#hdr-Remote_import_paths This adds two pages to support this Go module resolution. They are not linked from anywhere as we don't expect users to actually look at them. If someone does happen upon them, there's some boilerplate text to send them off to godoc.org for API documentation. Since the pages we're adding have a .html extension, we will also use a small apache config tweak on the server RewriteEngine on RewriteRule ^/libvirt-go$ /libvirt-go.html [L] RewriteRule ^/libvirt-go-xml$ /libvirt-go-xml.html [L] Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Jiri Denemark --- docs/libvirt-go-xml.rst | 10 ++++++++++ docs/libvirt-go.rst | 13 +++++++++++++ docs/page.xsl | 6 ++++++ 3 files changed, 29 insertions(+) create mode 100644 docs/libvirt-go-xml.rst create mode 100644 docs/libvirt-go.rst diff --git a/docs/libvirt-go-xml.rst b/docs/libvirt-go-xml.rst new file mode 100644 index 0000000000..ee3b878068 --- /dev/null +++ b/docs/libvirt-go-xml.rst @@ -0,0 +1,10 @@ +=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 +Libvirt Go XML parsing API +=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 + +The `Go `__ package ``libvirt.org/libvirt-go-xml`` pr= ovides +annotated Go struct definitions for parsing (and formatting) XML documents= used +with libvirt APIs. + +For details of Go specific behaviour consult the +`Go package documentation `__ diff --git a/docs/libvirt-go.rst b/docs/libvirt-go.rst new file mode 100644 index 0000000000..6ec5c0c123 --- /dev/null +++ b/docs/libvirt-go.rst @@ -0,0 +1,13 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Libvirt Go Language API +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The `Go `__ package ``libvirt.org/libvirt-go`` provid= es +`CGo `__ binding from the OS native Libvirt A= PI. + +In general the Go representation is a direct 1-1 mapping from native API +concepts to Go, so the native API documentation should serve as a reference +for most behaviour. + +For details of Go specific behaviour consult the +`Go package documentation `__ diff --git a/docs/page.xsl b/docs/page.xsl index f8f7ff8cf9..ddae5ab508 100644 --- a/docs/page.xsl +++ b/docs/page.xsl @@ -99,6 +99,12 @@ libvirt: <xsl:value-of select=3D"html:html/html:body//html:= h1"/> + + + + + + =20