Skip to content

Commit

Permalink
all: update links to Protocol Buffer documentation
Browse files Browse the repository at this point in the history
https://developers.google.com/protocol-buffers/ states that
this site will be deprecated January 2023 and provides
https://protobuf.dev/ as a link to the new location.

Generated .pb.go files are created by generate.bash using Go 1.18,
so leave them unchanged for now.

Fixes golang/protobuf#1520.

Change-Id: I1ddf6f329c96ba05d7c7d8562ad2945f479ee09b
Reviewed-on: https://go-review.googlesource.com/c/protobuf/+/466375
Reviewed-by: Michael Stapelberg <stapelberg@google.com>
Reviewed-by: Lasse Folger <lassefolger@google.com>
  • Loading branch information
alexandear authored and stapelberg committed Feb 8, 2023
1 parent e831c33 commit 49eaa78
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 18 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
[![Build Status](https://travis-ci.org/protocolbuffers/protobuf-go.svg?branch=master)](https://travis-ci.org/protocolbuffers/protobuf-go)

This project hosts the Go implementation for
[protocol buffers](https://developers.google.com/protocol-buffers), which is a
[protocol buffers](https://protobuf.dev), which is a
language-neutral, platform-neutral, extensible mechanism for serializing
structured data. The protocol buffer language is a language for specifying the
schema for structured data. This schema is compiled into language specific
bindings. This project provides both a tool to generate Go code for the
protocol buffer language, and also the runtime implementation to handle
serialization of messages in Go. See the
[protocol buffer developer guide](https://developers.google.com/protocol-buffers/docs/overview)
[protocol buffer developer guide](https://protobuf.dev/overview)
for more information about protocol buffers themselves.

This project is comprised of two components:
Expand All @@ -20,7 +20,7 @@ This project is comprised of two components:
[`protoc-gen-go`](https://pkg.go.dev/google.golang.org/protobuf/cmd/protoc-gen-go)
tool is a compiler plugin to `protoc`, the protocol buffer compiler. It
augments the `protoc` compiler so that it knows how to
[generate Go specific code for a given `.proto` file](https://developers.google.com/protocol-buffers/docs/reference/go-generated).
[generate Go specific code for a given `.proto` file](https://protobuf.dev/reference/go/go-generated).

* Runtime library: The
[`protobuf`](https://pkg.go.dev/mod/google.golang.org/protobuf) module
Expand All @@ -34,7 +34,7 @@ This project is comprised of two components:
[text](https://pkg.go.dev/google.golang.org/protobuf/encoding/prototext)).

See the
[developer guide for protocol buffers in Go](https://developers.google.com/protocol-buffers/docs/gotutorial)
[developer guide for protocol buffers in Go](https://protobuf.dev/getting-started/gotutorial)
for a general guide for how to get started using protobufs in Go.

This project is the second major revision of the Go protocol buffer API
Expand Down
5 changes: 2 additions & 3 deletions cmd/protoc-gen-go/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@
// both proto2 and proto3 versions of the protocol buffer language.
//
// For more information about the usage of this plugin, see:
//
// https://developers.google.com/protocol-buffers/docs/reference/go-generated
// https://protobuf.dev/reference/go/go-generated.
package main

import (
Expand All @@ -22,7 +21,7 @@ import (
"google.golang.org/protobuf/internal/version"
)

const genGoDocURL = "https://developers.google.com/protocol-buffers/docs/reference/go-generated"
const genGoDocURL = "https://protobuf.dev/reference/go/go-generated"
const grpcDocURL = "https://grpc.io/docs/languages/go/quickstart/#regenerate-grpc-code"

func main() {
Expand Down
2 changes: 1 addition & 1 deletion compiler/protogen/protogen.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import (
"google.golang.org/protobuf/types/pluginpb"
)

const goPackageDocURL = "https://developers.google.com/protocol-buffers/docs/reference/go-generated#package"
const goPackageDocURL = "https://protobuf.dev/reference/go/go-generated#package"

// Run executes a function as a protoc plugin.
//
Expand Down
2 changes: 1 addition & 1 deletion encoding/protojson/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

// Package protojson marshals and unmarshals protocol buffer messages as JSON
// format. It follows the guide at
// https://developers.google.com/protocol-buffers/docs/proto3#json.
// https://protobuf.dev/programming-guides/proto3#json.
//
// This package produces a different output than the standard "encoding/json"
// package, which does not operate correctly on protocol buffer messages.
Expand Down
2 changes: 1 addition & 1 deletion encoding/protowire/wire.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// license that can be found in the LICENSE file.

// Package protowire parses and formats the raw wire encoding.
// See https://developers.google.com/protocol-buffers/docs/encoding.
// See https://protobuf.dev/programming-guides/encoding.
//
// For marshaling and unmarshaling entire protobuf messages,
// use the "google.golang.org/protobuf/proto" package instead.
Expand Down
9 changes: 3 additions & 6 deletions proto/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,13 @@
// Package proto provides functions operating on protocol buffer messages.
//
// For documentation on protocol buffers in general, see:
//
// https://developers.google.com/protocol-buffers
// https://protobuf.dev.
//
// For a tutorial on using protocol buffers with Go, see:
//
// https://developers.google.com/protocol-buffers/docs/gotutorial
// https://protobuf.dev/getting-started/gotutorial.
//
// For a guide to generated Go protocol buffer code, see:
//
// https://developers.google.com/protocol-buffers/docs/reference/go-generated
// https://protobuf.dev/reference/go/go-generated.
//
// # Binary serialization
//
Expand Down
2 changes: 1 addition & 1 deletion reflect/protoregistry/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ var conflictPolicy = "panic" // "panic" | "warn" | "ignore"
// It is a variable so that the behavior is easily overridden in another file.
var ignoreConflict = func(d protoreflect.Descriptor, err error) bool {
const env = "GOLANG_PROTOBUF_REGISTRATION_CONFLICT"
const faq = "https://developers.google.com/protocol-buffers/docs/reference/go/faq#namespace-conflict"
const faq = "https://protobuf.dev/reference/go/faq#namespace-conflict"
policy := conflictPolicy
if v := os.Getenv(env); v != "" {
policy = v
Expand Down
2 changes: 1 addition & 1 deletion testing/protopack/pack.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
// This package is intended for use in debugging and/or creation of test data.
// Proper usage of this package requires knowledge of the wire format.
//
// See https://developers.google.com/protocol-buffers/docs/encoding.
// See https://protobuf.dev/programming-guides/encoding.
package protopack

import (
Expand Down

0 comments on commit 49eaa78

Please sign in to comment.