Skip to content

Commit

Permalink
doc: clarify usage of mix task generate
Browse files Browse the repository at this point in the history
  • Loading branch information
ahamez committed Feb 26, 2025
1 parent d416642 commit 1cb6303
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions lib/mix/tasks/protox/generate.ex
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,12 @@ defmodule Mix.Tasks.Protox.Generate do
`mix protox.generate --output-path=lib/message.ex --include-path=. message.proto`
The generated file will be usable in any project as long as protox is declared
in the dependencies (the generated file still needs functions from the protox runtime).
in the dependencies (the generated code still needs functions from the protox runtime).
You can use the `--namespace` option to prepend a namespace to all generated modules.
If you have large protobuf files, you can use the `--multiple-files` option to generate
one file per module.
Finally, you can pass the option `--keep-unknown-fields=false` to remove support of
unknown fields.
one file per module (it will leverage parallel compilation).
"""
@shortdoc "Generate Elixir code from Protobuf definitions"

Expand Down

0 comments on commit 1cb6303

Please sign in to comment.