Skip to content

Commit 5933e44

Browse files
zhangskzcopybara-github
authored andcommitted
Update documentation for generic service options.
The descriptions for `cc_generic_services`, `java_generic_services`, and `py_generic_services` have been updated to reflect that these options are now disabled by default and that generic services are being phased out. PiperOrigin-RevId: 913850489
1 parent 9a9fbe2 commit 5933e44

3 files changed

Lines changed: 24 additions & 48 deletions

File tree

content/programming-guides/editions.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1866,23 +1866,15 @@ Here are a few of the most commonly used options:
18661866
option optimize_for = CODE_SIZE;
18671867
```
18681868
1869-
* `cc_generic_services`, `java_generic_services`, `py_generic_services` (file
1870-
options): **Generic services are deprecated.** Whether or not the protocol
1871-
buffer compiler should generate abstract service code based on
1872-
[services definitions](#services) in C++, Java, and Python, respectively.
1873-
For legacy reasons, these default to `true`. However, as of version 2.3.0
1874-
(January 2010), it is considered preferable for RPC implementations to
1875-
provide
1869+
* **Generic services are deprecated.** `cc_generic_services`,
1870+
`java_generic_services`, `py_generic_services` (file options): If true, the
1871+
C++, Java, or Python code generators generate deprecated abstract service
1872+
code based on [service definitions](#services). This has been deprecated
1873+
since version 2.3.0 (January 2010) and is disabled by default. RPC
1874+
implementations should provide
18761875
[code generator plugins](/reference/cpp/api-docs/google.protobuf.compiler.plugin.pb)
1877-
to generate code more specific to each system, rather than rely on the
1878-
"abstract" services.
1879-
1880-
```proto
1881-
// This file relies on plugins to generate service code.
1882-
option cc_generic_services = false;
1883-
option java_generic_services = false;
1884-
option py_generic_services = false;
1885-
```
1876+
to generate code specific to their system instead of relying on "abstract"
1877+
services that will eventually be removed.
18861878
18871879
* `cc_enable_arenas` (file option): Enables
18881880
[arena allocation](/reference/cpp/arenas) for C++

content/programming-guides/proto2.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2005,23 +2005,15 @@ Here are a few of the most commonly used options:
20052005
option optimize_for = CODE_SIZE;
20062006
```
20072007
2008-
* `cc_generic_services`, `java_generic_services`, `py_generic_services` (file
2009-
options): **Generic services are deprecated.** Whether or not the protocol
2010-
buffer compiler should generate abstract service code based on
2011-
[services definitions](#services) in C++, Java, and Python, respectively.
2012-
For legacy reasons, these default to `true`. However, as of version 2.3.0
2013-
(January 2010), it is considered preferable for RPC implementations to
2014-
provide
2008+
* **Generic services are deprecated.** `cc_generic_services`,
2009+
`java_generic_services`, `py_generic_services` (file options): If true, the
2010+
C++, Java, or Python code generators generate deprecated abstract service
2011+
code based on [service definitions](#services). This has been deprecated
2012+
since version 2.3.0 (January 2010) and is disabled by default. RPC
2013+
implementations should provide
20152014
[code generator plugins](/reference/cpp/api-docs/google.protobuf.compiler.plugin.pb)
2016-
to generate code more specific to each system, rather than rely on the
2017-
"abstract" services.
2018-
2019-
```proto
2020-
// This file relies on plugins to generate service code.
2021-
option cc_generic_services = false;
2022-
option java_generic_services = false;
2023-
option py_generic_services = false;
2024-
```
2015+
to generate code specific to their system instead rather than rely on
2016+
"abstract" services which will eventually be removed.
20252017
20262018
* `cc_enable_arenas` (file option): Enables
20272019
[arena allocation](/reference/cpp/arenas) for C++

content/programming-guides/proto3.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1580,23 +1580,15 @@ Here are a few of the most commonly used options:
15801580
option optimize_for = CODE_SIZE;
15811581
```
15821582
1583-
* `cc_generic_services`, `java_generic_services`, `py_generic_services` (file
1584-
options): **Generic services are deprecated.** Whether or not the protocol
1585-
buffer compiler should generate abstract service code based on
1586-
[services definitions](#services) in C++, Java, and Python, respectively.
1587-
For legacy reasons, these default to `true`. However, as of version 2.3.0
1588-
(January 2010), it is considered preferable for RPC implementations to
1589-
provide
1583+
* **Generic services are deprecated.** `cc_generic_services`,
1584+
`java_generic_services`, `py_generic_services` (file options): If true, the
1585+
C++, Java, or Python code generators generate deprecated abstract service
1586+
code based on [service definitions](#services). This has been deprecated
1587+
since version 2.3.0 (January 2010) and is disabled by default. RPC
1588+
implementations should provide
15901589
[code generator plugins](/reference/cpp/api-docs/google.protobuf.compiler.plugin.pb)
1591-
to generate code more specific to each system, rather than rely on the
1592-
"abstract" services.
1593-
1594-
```proto
1595-
// This file relies on plugins to generate service code.
1596-
option cc_generic_services = false;
1597-
option java_generic_services = false;
1598-
option py_generic_services = false;
1599-
```
1590+
to generate code specific to their system instead rather than rely on
1591+
"abstract" services which will eventually be removed.
16001592
16011593
* `cc_enable_arenas` (file option): Enables
16021594
[arena allocation](/reference/cpp/arenas) for C++

0 commit comments

Comments
 (0)