[libvirt PATCH v2 0/2] docs: Point to pkg.go.dev instead of godoc.org

Changes from [v1]: * fix a few instances where we were still using github.com instead of libvirt.org for Go imports; * replace all uses of godoc.org, not just a subset. [v1] https://www.redhat.com/archives/libvir-list/2020-July/msg00270.html Andrea Bolognani (2): docs: Use libvirt.org namespace for Go bindings docs: Point to pkg.go.dev instead of godoc.org docs/bindings.html.in | 2 +- docs/docs.html.in | 2 +- docs/downloads.html.in | 4 ++-- docs/libvirt-go-xml.rst | 2 +- docs/libvirt-go.rst | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) -- 2.25.4

Fixes: 193ad364062407c3fcd3267f0f135d8960b53020 Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/bindings.html.in | 2 +- docs/docs.html.in | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/bindings.html.in b/docs/bindings.html.in index 8a482015b9..081af25ebb 100644 --- a/docs/bindings.html.in +++ b/docs/bindings.html.in @@ -16,7 +16,7 @@ </li> <li> <strong>Go</strong>: Daniel Berrange develops - <a href="https://godoc.org/github.com/libvirt/libvirt-go">Go bindings</a>. + <a href="https://godoc.org/libvirt.org/libvirt-go">Go bindings</a>. </li> <li> <strong>Java</strong>: Daniel Veillard develops diff --git a/docs/docs.html.in b/docs/docs.html.in index f1d44fadc0..559910a2d0 100644 --- a/docs/docs.html.in +++ b/docs/docs.html.in @@ -82,7 +82,7 @@ <dt><a href="bindings.html">Language bindings and API modules</a></dt> <dd>Bindings of the libvirt API for <a href="csharp.html">c#</a>, - <a href="https://godoc.org/github.com/libvirt/libvirt-go">go</a>, + <a href="https://godoc.org/libvirt.org/libvirt-go">go</a>, <a href="java.html">java</a>, <a href="https://libvirt.org/ocaml/">ocaml</a>, <a href="http://search.cpan.org/dist/Sys-Virt/">perl</a>, -- 2.25.4

The former is the new recommended frontend for browsing Go API documentation online. Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/bindings.html.in | 2 +- docs/docs.html.in | 2 +- docs/downloads.html.in | 4 ++-- docs/libvirt-go-xml.rst | 2 +- docs/libvirt-go.rst | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/bindings.html.in b/docs/bindings.html.in index 081af25ebb..692390c843 100644 --- a/docs/bindings.html.in +++ b/docs/bindings.html.in @@ -16,7 +16,7 @@ </li> <li> <strong>Go</strong>: Daniel Berrange develops - <a href="https://godoc.org/libvirt.org/libvirt-go">Go bindings</a>. + <a href="https://pkg.go.dev/libvirt.org/libvirt-go">Go bindings</a>. </li> <li> <strong>Java</strong>: Daniel Veillard develops diff --git a/docs/docs.html.in b/docs/docs.html.in index 559910a2d0..ceb95a4f17 100644 --- a/docs/docs.html.in +++ b/docs/docs.html.in @@ -82,7 +82,7 @@ <dt><a href="bindings.html">Language bindings and API modules</a></dt> <dd>Bindings of the libvirt API for <a href="csharp.html">c#</a>, - <a href="https://godoc.org/libvirt.org/libvirt-go">go</a>, + <a href="https://pkg.go.dev/libvirt.org/libvirt-go">go</a>, <a href="java.html">java</a>, <a href="https://libvirt.org/ocaml/">ocaml</a>, <a href="http://search.cpan.org/dist/Sys-Virt/">perl</a>, diff --git a/docs/downloads.html.in b/docs/downloads.html.in index 24ee27cc5c..33a49d9c1f 100644 --- a/docs/downloads.html.in +++ b/docs/downloads.html.in @@ -81,7 +81,7 @@ <a href="https://github.com/libvirt/libvirt-go">github</a> </td> <td> - <a href="https://godoc.org/libvirt.org/libvirt-go">api ref</a> + <a href="https://pkg.go.dev/libvirt.org/libvirt-go">api ref</a> </td> </tr> <tr> @@ -245,7 +245,7 @@ <a href="https://github.com/libvirt/libvirt-go-xml">github</a> </td> <td> - <a href="https://godoc.org/libvirt.org/libvirt-go-xml">api ref</a> + <a href="https://pkg.go.dev/libvirt.org/libvirt-go-xml">api ref</a> </td> </tr> <tr> diff --git a/docs/libvirt-go-xml.rst b/docs/libvirt-go-xml.rst index ee3b878068..995fdd2b07 100644 --- a/docs/libvirt-go-xml.rst +++ b/docs/libvirt-go-xml.rst @@ -7,4 +7,4 @@ 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 <https://godoc.org/libvirt.org/libvirt-go-xml>`__ +`Go package documentation <https://pkg.go.dev/libvirt.org/libvirt-go-xml>`__. diff --git a/docs/libvirt-go.rst b/docs/libvirt-go.rst index 6ec5c0c123..f2d3f80fb2 100644 --- a/docs/libvirt-go.rst +++ b/docs/libvirt-go.rst @@ -10,4 +10,4 @@ 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 <https://godoc.org/libvirt.org/libvirt-go>`__ +`Go package documentation <https://pkg.go.dev/libvirt.org/libvirt-go>`__. -- 2.25.4

On Tue, Jul 07, 2020 at 12:48:35PM +0200, Andrea Bolognani wrote:
Changes from [v1]:
* fix a few instances where we were still using github.com instead of libvirt.org for Go imports;
* replace all uses of godoc.org, not just a subset.
[v1] https://www.redhat.com/archives/libvir-list/2020-July/msg00270.html
Andrea Bolognani (2): docs: Use libvirt.org namespace for Go bindings docs: Point to pkg.go.dev instead of godoc.org
docs/bindings.html.in | 2 +- docs/docs.html.in | 2 +- docs/downloads.html.in | 4 ++-- docs/libvirt-go-xml.rst | 2 +- docs/libvirt-go.rst | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-)
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
participants (2)
-
Andrea Bolognani
-
Daniel P. Berrangé