You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fory.apache.org by "ayush00git (via GitHub)" <gi...@apache.org> on 2026/02/24 10:18:20 UTC
[I] [DOCS]: Match the foryc --help output with the compile options table [fory]
ayush00git opened a new issue, #3402:
URL: https://github.com/apache/fory/issues/3402
### Search before asking
- [x] I had searched in the [issues](https://github.com/apache/fory/issues) and found no similar issues.
### Version
Latest
### Component(s)
Doc
### Minimal reproduce step
Type `foryc --help` in your terminal, and see the result -
```bash
usage: foryc [-h] [--scan-generated] [--lang LANG] [--output OUTPUT] [--package PACKAGE] [-I PATH] [--java_out DST_DIR] [--python_out DST_DIR] [--cpp_out DST_DIR]
[--go_out DST_DIR] [--rust_out DST_DIR] [--go_nested_type_style {camelcase,underscore}] [--emit-fdl] [--emit-fdl-path EMIT_FDL_PATH] [--root ROOT] [--relative]
[--delete | --dry-run] [--grpc]
[FILE ...]
Fory IDL compiler
positional arguments:
FILE IDL files to compile
options:
-h, --help show this help message and exit
--scan-generated Scan for generated files under the current directory
--lang LANG Comma-separated list of target languages (java,python,cpp,rust,go). Default: all
--output, -o OUTPUT Output directory. Default: ./generated
--package PACKAGE Override package name from FDL file
-I, --proto_path, --import_path PATH
Add a directory to the import search path. Can be specified multiple times.
--java_out DST_DIR Generate Java code in DST_DIR
--python_out DST_DIR Generate Python code in DST_DIR
--cpp_out DST_DIR Generate C++ code in DST_DIR
--go_out DST_DIR Generate Go code in DST_DIR
--rust_out DST_DIR Generate Rust code in DST_DIR
--go_nested_type_style {camelcase,underscore}
Go nested type naming style: camelcase or underscore (default)
--emit-fdl Emit translated FDL (for non-FDL inputs) for debugging
--emit-fdl-path EMIT_FDL_PATH
Write translated FDL to this path (file or directory)
--root ROOT Root directory to scan (default: current directory)
--relative Print paths relative to the scan root
--delete Delete all scanned generated files
--dry-run Scan and print without deleting files
--grpc Generate gRPC service code (stubs, serialization traits, etc.)
```
### What did you expect to see?
- the default value of the `--go_nested_type_style` is `underscore` but the docs mentions it as `from schema/default`
- Also the definitions of the `--emit-fdl` and `--emit-fld-path` in the compile options table does not matches with the `foryc --help` command's output.
### What did you see instead?
/
### Anything Else?
- The default value of `--go_nested_type_style` should be set to `underscore` in the docs.
- `--grpc` flag was introduced in the PR #3361 but not added in the compile options table.
### Are you willing to submit a PR?
- [x] I'm willing to submit a PR!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fory.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fory.apache.org
For additional commands, e-mail: commits-help@fory.apache.org
Re: [I] [DOCS]: Match the foryc --help output with the compile options table [fory]
Posted by "ayush00git (via GitHub)" <gi...@apache.org>.
ayush00git commented on issue #3402:
URL: https://github.com/apache/fory/issues/3402#issuecomment-3950630041
Hey @chaokunyang
This needs to be updated in the [compiler-guide.md](https://github.com/apache/fory/blob/main/docs/compiler/compiler-guide.md#options)
Should I raise a PR to fix this up?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fory.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fory.apache.org
For additional commands, e-mail: commits-help@fory.apache.org
Re: [I] [DOCS]: Match the foryc --help output with the compile options table [fory]
Posted by "chaokunyang (via GitHub)" <gi...@apache.org>.
chaokunyang commented on issue #3402:
URL: https://github.com/apache/fory/issues/3402#issuecomment-3960180359
Yes, a pr would be great
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fory.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fory.apache.org
For additional commands, e-mail: commits-help@fory.apache.org
Re: [I] [DOCS]: Match the foryc --help output with the compile options table [fory]
Posted by "ayush00git (via GitHub)" <gi...@apache.org>.
ayush00git commented on issue #3402:
URL: https://github.com/apache/fory/issues/3402#issuecomment-3960133100
Hey @chaokunyang
This needs to be updated in the [compiler-guide.md](https://github.com/apache/fory/blob/main/docs/compiler/compiler-guide.md#options)
Should I raise a PR to fix this up?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fory.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fory.apache.org
For additional commands, e-mail: commits-help@fory.apache.org
Re: [I] [DOCS]: Match the foryc --help output with the compile options table [fory]
Posted by "ayush00git (via GitHub)" <gi...@apache.org>.
ayush00git commented on issue #3402:
URL: https://github.com/apache/fory/issues/3402#issuecomment-3956559278
Hey @chaokunyang
This needs to be updated in the [compiler-guide.md](https://github.com/apache/fory/blob/main/docs/compiler/compiler-guide.md#options)
Should I raise a PR to fix this up?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fory.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fory.apache.org
For additional commands, e-mail: commits-help@fory.apache.org