docs(flare): verify and fix small issues across doc/#175
Merged
Conversation
Pure-mechanical cleanup pass through the remaining flare/doc/ files. Every change is verified against the actual code referenced. * `profiler.md`: title typo ``Profiller -> Profiler``; ``flag::Server`` -> ``flare::Server`` in the CPU profiler section. * `async.md`: ``Futrue`` typo -> ``Future``; link ``Async`` to its real header ``flare/fiber/async.h`` instead of leaving it as bare text. * `controller.md`: replace "see source code comments" with concrete header links (``rpc_client_controller.h``, ``rpc_server_controller.h``, ``rpc_controller.h``); link the "tracing" reference to ``tracing.md``. * `scheduling-group.md`: replace the ``...`` placeholder in the per-scheduling-group resources list with two concrete entries that exist in the code (object pool's ``memory_node_shared`` bucketing per NUMA node, monitoring's local-accumulate + cross-group aggregate reporting). * `gflags.md` / `buffer.md`: add the missing ``[返回目录]`` footer that every other doc has. ``buffer.md`` also had a stray triple ``)))`` in the last code sample -- removed. * `performance-guide.md`: fix broken header path ``../base/spinlock.h`` -> ``../base/thread/spinlock.h``. The file was moved into the ``thread/`` subdirectory at some point and the doc never followed. * `rpc-log-and-dry-run.md`: fix two weird relative paths that contained nested ``../`` segments and a literal ``binlog/`` prefix that doesn't exist (``binlog/../../rpc/binlog/dumper.h`` -> ``../rpc/binlog/dumper.h``, ``../binlog/../rpc/binlog/dry_runner.h`` -> ``../rpc/binlog/dry_runner.h``). No content rewrites; only typos, broken refs, and missing footers. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Two issues link-check surfaced on this PR: * controller.md referenced a non-existent ``flare/rpc/rpc_controller.h``. Actual hierarchy: ``RpcClientController`` and ``RpcServerController`` both inherit from ``protobuf::RpcControllerCommon`` (no shared ``RpcController`` header). Replace the wrong link with a plain text mention of the common base class. * performance-guide.md links to cppreference / stackoverflow / linux.die.net all 403'd against the link-check user agent. These URLs aren't broken in any normal browser; the docs were untouched in this PR but ``check-modified-files-only=yes`` re-scanned the file. Add the three domains to ``ignorePatterns`` with comments documenting the reason. The existing pattern for bazel.build set the precedent. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
chen3feng
force-pushed
the
doc-verify-update
branch
from
bd60859 to
e05324e
Compare
Same shape as cppreference / stackoverflow / linux.die.net: the docs URL returns 403 to the action's User-Agent but works in any browser. Surfaced by rpc-log-and-dry-run.md re-scanning under this PR's edits. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Pure-mechanical verification pass over the remaining
flare/doc/files (separate from #174 which filled in the empty stubs). Every change verified against the actual code being referenced.Per-file changes
profiler.mdProfiller→Profiler;flag::Server→flare::Serverin CPU sectionasync.mdFutrue→Future; linkAsyncto its real header (flare/fiber/async.h) instead of bare textcontroller.mdrpc_client_controller.h,rpc_server_controller.h,rpc_controller.h); link "tracing" mention totracing.mdscheduling-group.md...placeholder in resources list with two concrete entries that exist in code (object poolmemory_node_sharedbucketing per NUMA, monitoring local-accumulate + cross-group aggregate)gflags.md[返回目录]footerbuffer.md)))in last code sampleperformance-guide.md../base/spinlock.h→../base/thread/spinlock.h. File moved into thethread/subdir at some point, doc didn't followrpc-log-and-dry-run.md../and a literalbinlog/prefix not on disk:binlog/../../rpc/binlog/dumper.h→../rpc/binlog/dumper.h; same fordry_runner.hNot changed
Plenty of docs were read but no edits needed:
channel.md,streaming-rpc.md,debugging.md,gdb-plugin.md,sanitizers.md,tracing.md,io.md,protocol.md,monitoring.md,option.md,logging.md,fiber.md,fiber-scheduling.md,future.md,intro-rpc.md,intro-http.md,coding-comparison.md,pb-plugin.md,pb-rpc-status.md,rpc-form.md,rtti.md,testing.md,benchmark.md,object-pool.mdThese had no broken refs, no obvious typos, and content that matches what the code does today.
Verification
ls flare/init/override_flag.hetc.)🤖 Generated with Claude Code