Conversation
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. 📝 SummarySummary by CodeRabbit
WalkthroughThe documentation describes daemon HTTP address sources and precedence, opt-in configuration examples, and install-service startup behavior. ChangesDaemon HTTP configuration
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Other Merge Risk: 🔵 Low · up to On systems with an absolute XDG_CONFIG_HOME, following the multi-repo example may leave the HTTP endpoint disabled. The server and onboarding docs explain the correct config location, making this a narrow, readily correctable documentation issue. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Organization UI
- Review profile: ASSERTIVE
- Plan: Essentials
- Run ID:
23ff2b7e-9861-4842-b5fe-41929df2446b
📒 Files selected for processing (4)
docs/cli.mddocs/multi-repo.mddocs/onboarding.mddocs/server.md
Included review availability: This review used your included allowance. 4 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour. Your free on-demand review promotion remains active until October 9, 2026 at 6:00 PM UTC.
📜 Review details
⏰ Context from checks skipped due to timeout. (9)
- GitHub Check: build-onnx
- GitHub Check: test (macos-latest, 1.27)
- GitHub Check: test (windows-latest, 1.27)
- GitHub Check: test (ubuntu-latest, 1.27)
- GitHub Check: benchmark
- GitHub Check: trivy-fs
- GitHub Check: build-linux-static
- GitHub Check: lint
- GitHub Check: govulncheck
🔇 Additional comments (3)
docs/cli.md (1)
9-9: LGTM!docs/multi-repo.md (1)
45-47: LGTM!docs/server.md (1)
11-11: 🎯 Functional CorrectnessThe supplied inspection output is truncated before showing
DefaultGlobalConfigPathorLoadGlobal. It does not establish which path the config loader uses whenXDG_CONFIG_HOMEis set, so the documentation concern cannot be decided from this evidence.
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to GitHub limitations.
🟡 Minor · Document the XDG config path for this example. · multi-repo.md:38-46
docs/multi-repo.md:38-46
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDocument the XDG config path for this example.
When
XDG_CONFIG_HOMEis absolute, the daemon loads$XDG_CONFIG_HOME/gortex/config.yaml, not~/.gortex/config.yaml. A user who copies this example can setdaemon.http_addrin a file the daemon does not read, so the HTTP API remains disabled.Suggested fix
-# ~/.gortex/config.yaml +# ~/.gortex/config.yaml (or $XDG_CONFIG_HOME/gortex/config.yaml when XDG_CONFIG_HOME is absolute)
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Organization UI
- Review profile: ASSERTIVE
- Plan: Essentials
- Run ID:
faaeae3e-aed9-44e4-9ad6-b694a271de4b
📒 Files selected for processing (2)
docs/onboarding.mddocs/server.md
Included review availability: This review used your included allowance. 4 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour. Your free on-demand review promotion remains active until October 9, 2026 at 6:00 PM UTC.
📜 Review details
⏰ Context from checks skipped due to timeout. (7)
- GitHub Check: test (ubuntu-latest, 1.27)
- GitHub Check: test (windows-latest, 1.27)
- GitHub Check: build-onnx
- GitHub Check: test (macos-latest, 1.27)
- GitHub Check: benchmark
- GitHub Check: lint
- GitHub Check: build-linux-static
🔇 Additional comments (2)
docs/server.md (1)
11-11: LGTM!Also applies to: 22-22
docs/onboarding.md (1)
241-241: LGTM!
The docs still said the daemon serves HTTP only with --http-addr, and the install-service section listed only the XDG variables it captures. - server.md, cli.md: the address can also come from GORTEX_DAEMON_HTTP_ADDR or daemon.http_addr, with flag > env > config precedence, read at startup. - onboarding.md: install-service captures the installing shell's PATH, and the unit runs a bare `daemon start`, so daemon options belong in config. - server.md, onboarding.md: name the global config path, including $XDG_CONFIG_HOME/gortex/config.yaml when that variable is absolute. - multi-repo.md: a commented daemon.http_addr example in the sample config.
a2ba252 to
7bd2f9e
Compare
|
Continued upstream as zzet#876 |
Summary
Documents two merged daemon changes that the docs did not cover yet:
daemon.http_addr(zzet#863) and PATH capture ininstall-service(zzet#864).Changes
docs/server.md,docs/cli.md: the HTTP address can come from--http-addr,GORTEX_DAEMON_HTTP_ADDRordaemon.http_addr, in that order, read at startup. Aninstall-servicedaemon starts without flags, so it needs the config key.docs/onboarding.md:install-servicecaptures the installing shell'sPATH(absolute entries only), so run it from the shell whosePATHthe daemon should use.docs/multi-repo.md: a commenteddaemon.http_addrexample in the sample config. It stays commented so copying the sample does not open a TCP port.Testing
go test -race ./...)Docs only. Each statement was checked against
resolveDaemonHTTPAddrincmd/gortex/daemon.goandservicePathincmd/gortex/daemon_service.goonmain. On macOS, a daemon installed withinstall-servicefrom amainbuild had no--http-addrin its plist, listened on the address fromdaemon.http_addr, and had the login shell'sPATH.Checklist