Skip to content

Commit 3516034

Browse files
Use 'Protobuf' as the proper noun of our project.
The name 'Protocol Buffers' is relegated to a parenthetical on the landing page. Words like 'Protobufs', 'Protobuffs', 'Protobuffers' are excised. PiperOrigin-RevId: 993761593
1 parent 689caf3 commit 3516034

175 files changed

Lines changed: 1681 additions & 1719 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/_index.md‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
11
+++
2-
title = "Protocol Buffers"
2+
title = "Protobuf"
33
weight = 5
44
toc_hide = "true"
5-
description = "Protocol Buffers are language-neutral, platform-neutral extensible mechanisms for serializing structured data."
5+
description = "Protobuf is a language-neutral, platform-neutral extensible mechanism for serializing structured data."
66
type = "docs"
77
no_list = "true"
88
+++
99

10-
## What Are Protocol Buffers?
10+
## What Is Protobuf?
1111

12-
Protocol buffers are Google's language-neutral, platform-neutral, extensible
13-
mechanism for serializing structured data – think XML, but smaller, faster, and
14-
simpler. You define how you want your data to be structured once, then you can
15-
use special generated source code to easily write and read your structured data
16-
to and from a variety of data streams and using a variety of languages.
12+
Protobuf ("Protocol Buffers") is Google's language-neutral, platform-neutral,
13+
extensible mechanism for serializing structured data – think XML, but smaller,
14+
faster, and simpler. You define how you want your data to be structured once,
15+
then you can use special generated source code to easily write and read your
16+
structured data to and from a variety of data streams and using a variety of
17+
languages.
1718

1819
## Pick Your Favorite Language
1920

20-
Protocol buffers support generated code in C++, C#, Dart, Go, Java,
21-
Kotlin,
22-
Objective-C, Python, Rust, and Ruby. With proto3, you can also work with PHP.
21+
Protobuf supports generated code in C++, C#, Dart, Go,
22+
Java, Kotlin, Objective-C, Python, Rust, and Ruby. With proto3,
23+
you can also work with PHP.
2324

2425
## Example Implementation
2526

@@ -67,7 +68,7 @@ email = john.email();
6768
6869
<li>
6970
<a href="https://github.com/protocolbuffers/protobuf#protobuf-compiler-installation">Download
70-
and install</a> the protocol buffer compiler.
71+
and install</a> the Protobuf compiler.
7172
</li>
7273
7374
<li>

‎content/best-practices/1-1-1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ for when to diverge from the guideline.
4444

4545
## Symbol Visibility in Edition 2024 and Later {#2024-later}
4646

47-
Starting in `edition = "2024"`, Protocol Buffers introduces
47+
Starting in `edition = "2024"`, Protobuf introduces
4848
[Symbol Visibility](/programming-guides/symbol_visibility)
4949
with `export` and `local` keywords
5050
and the `features.default_symbol_visibility` option.

‎content/best-practices/dos-donts.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
22
title = "Proto Best Practices"
33
weight = 90
4-
description = "Shares vetted best practices for authoring Protocol Buffers."
4+
description = "Shares vetted best practices for authoring Protobuf schemas."
55
type = "docs"
66
aliases = "/programming-guides/dos-donts"
77
+++
@@ -71,7 +71,7 @@ To safely remove the original name (if it's being used for interchange, which it
7171

7272
Almost never change the type of a field; it'll mess up deserialization, same as
7373
re-using a tag number. The
74-
[protobuf docs](/programming-guides/editions#updating)
74+
[Protobuf docs](/programming-guides/editions#updating)
7575
outline cases where old binary encoded data may successfully parse under a
7676
different type (for example, going between `int32`, `uint32`, `int64` and
7777
`bool`). However, changing a field's type can be difficult to roll out safely
@@ -191,9 +191,9 @@ when a perfectly suitable common type already exists!
191191
is a color in the RGBA color space.
192192

193193
**Note:** While the "Well-Known Types" (such as `Duration` and `Timestamp`) are
194-
included with the Protocol Buffers compiler, the "Common Types" (such as `Date`
195-
and `Money`) are not. To use the Common Types, you may need to add a dependency
196-
on the [googleapis repository](https://github.com/googleapis/googleapis).
194+
included with the Protobuf compiler, the "Common Types" (such as `Date` and
195+
`Money`) are not. To use the Common Types, you may need to add a dependency on
196+
the [googleapis repository](https://github.com/googleapis/googleapis).
197197

198198
<a id="do-define-widely-used-message-types-in-separate-files"></a>
199199

@@ -279,7 +279,7 @@ For example:
279279

280280
Text-based serialization formats like text format and
281281
JSON represent fields and enum values as strings. As a result, deserialization
282-
of protocol buffers in these formats using old code will fail when a field or
282+
of Protobuf messages in these formats using old code will fail when a field or
283283
enum value is renamed, or when a new field or enum value or extension is added.
284284
Use binary serialization when possible for data interchange, and use text format
285285
for human editing and debugging only.
@@ -341,7 +341,7 @@ overrides are possible.
341341
## Avoid Using Language Keywords for Field Names {#avoid-keywords}
342342

343343
If the name of a message, field, enum, or enum value is a keyword in the
344-
language that reads from/writes to that field, then protobuf may change the
344+
language that reads from/writes to that field, then Protobuf may change the
345345
field name, and may have different ways to access them than normal fields. For
346346
example, see
347347
[this warning about Python](/reference/python/python-generated#keyword-conflicts).

‎content/downloads.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
+++
22
title = "Downloads"
33
weight = 1000
4-
description = "The downloads page for protocol buffers."
4+
description = "The downloads page for Protobuf."
55
type = "docs"
66
+++
77

88
## Release Packages
99

1010
### Latest Version
1111

12-
The latest release of Protocol Buffers can be found on the
12+
The latest release of Protobuf can be found on the
1313
[release page](https://github.com/protocolbuffers/protobuf/releases/latest).
1414

1515
### Old Versions
@@ -21,5 +21,5 @@ Older versions are available in our historical releases
2121

2222
### GitHub Repository
2323

24-
Protocol Buffers source code is hosted on
24+
Protobuf source code is hosted on
2525
[GitHub](https://github.com/protocolbuffers/protobuf).

‎content/editions/features.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
22
title = "Feature Settings for Editions"
33
weight = 43
4-
description = "Protobuf Editions features and how they affect protobuf behavior."
4+
description = "Protobuf Editions features and how they affect Protobuf behavior."
55
type = "docs"
66
+++
77

@@ -388,7 +388,7 @@ enum Foo {
388388
### `features.field_presence` {#field_presence}
389389

390390
This feature sets the behavior for tracking field presence, or the notion of
391-
whether a protobuf field has a value.
391+
whether a Protobuf field has a value.
392392

393393
**Values available:**
394394

@@ -754,10 +754,10 @@ sections show these imports.
754754

755755
**Languages:** Go
756756

757-
The `api_level` feature enables you to select which API version the Go protobuf
757+
The `api_level` feature enables you to select which API version the Go Protobuf
758758
plugin should generate code for. The Opaque API is the latest version of the
759-
Protocol Buffers implementation for the Go programming language. The previous
760-
version is now called Open Struct API. See the
759+
Protobuf implementation for the Go programming language. The previous version is
760+
now called Open Struct API. See the
761761
[Go Protobuf: Releasing the Opaque API](https://go.dev/blog/protobuf-opaque)
762762
blog post for an introduction.
763763

‎content/editions/overview.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ type = "docs"
77
+++
88

99
Protobuf Editions replace the proto2 and proto3 designations that we have used
10-
for Protocol Buffers. Instead of adding `syntax = "proto2"` or `syntax =
11-
"proto3"` at the top of proto definition files, you use an edition number, such
12-
as `edition = "2024"`, to specify the default behaviors your file will have.
13-
Editions enable the language to evolve incrementally over time.
10+
for Protobuf. Instead of adding `syntax = "proto2"` or `syntax = "proto3"` at
11+
the top of proto definition files, you use an edition number, such as `edition =
12+
"2024"`, to specify the default behaviors your file will have. Editions enable
13+
the language to evolve incrementally over time.
1414

1515
Instead of the hardcoded behaviors that older versions have had, editions
1616
represent a collection of [features](/editions/features)
1717
with a default value (behavior) per feature. Features are options on a file,
1818
message, field, enum, and so on, that specify the behavior of protoc, the code
19-
generators, and protobuf runtimes. You can explicitly override a behavior at
19+
generators, and Protobuf runtimes. You can explicitly override a behavior at
2020
those different levels (file, message, field, ...) when your needs don't match
2121
the default behavior for the edition you've selected. You can also override your
2222
overrides. The [section later in this topic on lexical scoping](#scoping) goes
@@ -40,7 +40,7 @@ it. For example:
4040

4141
3. A later edition, such as edition 2033, switches the default of
4242
`feature.amazing_new_feature` from `false` to `true`. This is the desired
43-
behavior for all protos, and the reason that the protobuf team created the
43+
behavior for all protos, and the reason that the Protobuf team created the
4444
feature.
4545

4646
Using the Prototiller tool to migrate earlier versions of proto files to
@@ -413,7 +413,7 @@ proto_library(
413413
```
414414

415415
Option imports and `option_deps` are strongly recommended when importing
416-
protobuf language features and other custom options to avoid generating
416+
Protobuf language features and other custom options to avoid generating
417417
unnecessary code.
418418

419419
This replaces `import weak`, which was removed in Edition 2024.

‎content/getting-started/_index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
+++
44
title = "Tutorials"
55
weight = 200
6-
description = "Each tutorial in this section shows you how to implement a simple application using protocol buffers in your favourite language, introducing you to the language's protocol buffer API as well as showing you the basics of creating and using .proto files."
6+
description = "Each tutorial in this section shows you how to implement a simple application using Protobuf in your favourite language, introducing you to the language's Protobuf API as well as showing you the basics of creating and using .proto files."
77
type = "docs"
88
+++
99

1010
The complete sample code for each application is also provided.
1111

12-
The tutorials don't assume that you know anything about protocol buffers, but do
13-
assume that you are comfortable writing code in your chosen language, including
14-
using file I/O.
12+
The tutorials don't assume that you know anything about Protobuf, but do assume
13+
that you are comfortable writing code in your chosen language, including using
14+
file I/O.

0 commit comments

Comments
 (0)