Skip to content

Commit 77ec1c4

Browse files
docs(gen-data): correct -out flag help text to name the actual base
The -out default `internal/engine` is relative to the current working directory, not "relative to repo root" as the help string claimed. A contributor running gen-data from the actual repo root following the help text would write to <repo-root>/internal/engine/ which doesn't exist; if their shell auto-creates the dir, generated files land in the wrong place while the engine package keeps stale tables. The doc comment at the top of main.go already says to run from go-native/ressrf/, so the default does land in the right place when the documented workflow is followed. The flag help just disagreed. Addresses td-code-review finding #12.
1 parent b067228 commit 77ec1c4

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

  • go-native/ressrf/internal/cmd/gen-data

‎go-native/ressrf/internal/cmd/gen-data/main.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import (
2727

2828
func main() {
2929
configDir := flag.String("config", "../../crates/ressrf-core/config", "directory containing ip_ranges.json + domains_*.json (default points at the workspace's shared Rust crate config)")
30-
outDir := flag.String("out", "internal/engine", "directory to write generated Go files into (relative to repo root)")
30+
outDir := flag.String("out", "internal/engine", "directory to write generated Go files into (relative to the current working directory; run from go-native/ressrf/)")
3131
flag.Parse()
3232

3333
if err := generateIPRanges(*configDir, *outDir); err != nil {

0 commit comments

Comments
 (0)