Skip to content

Commit

Permalink
WIP: docs: Document feature flags
Browse files Browse the repository at this point in the history
Open question:
- What is the function of `prost-derive` feature?
  • Loading branch information
caspermeijn committed Mar 15, 2024
1 parent 9f24f38 commit 800f2fa
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,10 @@ The prost project maintains flakes support for local development. Once you have
nix and nix flakes setup you can just run `nix develop` to get a shell
configured with the required dependencies to compile the whole project.

## Feature Flags
- `std`: Enable integration with standard library. Disable this feature for `no_std` support. This feature is enabled by default.
- `prost-derive`: TODO: That does this do? This feature is enabled by default.
- `no-recursion-limit`: Disable the recursion limit. The recursion limit is 100 and cannot be customized.

## FAQ

Expand Down
4 changes: 4 additions & 0 deletions prost-build/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,10 @@
//!
//! // Now compile your proto files via prost-build
//! ```
//!
//! ## Feature Flags
//! - `format`: Format the generated output. This feature is enabled by default.
//! - `cleanup-markdown`: Clean up Markdown in protobuf docs.
//!
//! [`protobuf-src`]: https://docs.rs/protobuf-src
Expand Down
3 changes: 3 additions & 0 deletions prost-types/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
//! definitions, so code examples are not in Rust.
//!
//! See the [Protobuf reference][1] for more information about well-known types.
//!
//! ## Feature Flags
//! - `std`: Enable integration with standard library. Disable this feature for `no_std` support. This feature is enabled by default.
//!
//! [1]: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf
Expand Down

0 comments on commit 800f2fa

Please sign in to comment.