docs: code-verified fixes across remaining docs + fill protocol/{http,new}.md#176
Merged
Conversation
…l/{http,new}.md
Surgical fixes verified against current source:
- fiber.md, logging.md: flare::Async → flare::fiber::Async (no such alias at top level)
- io.md: malformed link io/../../io/detail/watchdog.h → ../io/detail/watchdog.h
- intro-http.md: HttpResponse::Status_OK → HttpStatus::OK (enum lives in net/http/types.h)
- rpc-form.md: typo Mssage → Message
- testing.md: stale namespace comment flare::testing::detail → example
- option.md: SomeParer → SomeParser, XxxOption>...> → XxxOption<...>,
StringToJsonParser → JsonParser (real name in base/option/json_parser.h)
- coding-comparison.md: read.Read() → reader.Read() (variable mismatch)
- protocol/protocol-buffers.md: EnableCompression → SetCompressionAlgorithm
(server controller has only the latter); max_queueing_delay →
max_queueing_delay_ms; flag accept_request_raw_bytes as TODO (still
commented out in rpc_options.proto:60 and std_protocol.cc:198)
- protocol.md: typo 内置协义 → 内置协议
- README.md: index orphans buffer.md / coding-comparison.md / gdb-plugin.md
added so they show up in the docs ToC
Filled previously-empty stubs:
- protocol/http.md: describes HTTP-as-wire-protocol entry points
(Http11Protocol, HttpService, HttpRequest/Response, HttpStatus) and
delegates user-facing usage to intro-http.md
- protocol/new.md: step-by-step guide for adding a new protocol —
StreamProtocol / Message / Controller / StreamService surfaces,
FLARE_RPC_REGISTER_*_STREAM_PROTOCOL* registration macros, and a
reference table of existing implementations (StdProtocol, Http11Protocol,
HbaseClient/ServerProtocol, RedisProtocol)
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
- logging.md: CnTransGroup/EffectiveModernCppChinese was deleted upstream (HTTP 404 on the repo itself). Drop the dead URL but keep the textual reference to "Effective Modern C++" Item 30. - protocol/protocol-buffers.md:249: relative path was missing the "protocol/" segment — ../../rpc/protobuf/rpc_meta.proto → ../../rpc/protocol/protobuf/rpc_meta.proto (matches the three other correct refs in the same file). Both links pre-existed; the modified-files-only link checker only surfaced them because this PR touched those two files. 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
Surgical, code-verified fixes to flare docs not touched by #174 / #175, plus the two long-empty protocol stubs.
Verified against current source
fiber.md,logging.mdflare::Async→flare::fiber::Async(no top-level alias)io.mdio/../../io/detail/watchdog.h→../io/detail/watchdog.hintro-http.md(×5)HttpResponse::Status_OK→HttpStatus::OK(enum lives innet/http/types.h)rpc-form.mdMssage→Messagetesting.mdflare::testing::detail→exampleoption.mdSomeParer→SomeParser,XxxOption>...>→XxxOption<...>,StringToJsonParser→JsonParser(real name inbase/option/json_parser.h)coding-comparison.mdread.Read()→reader.Read()(variable name mismatch in snippet)protocol/protocol-buffers.mdEnableCompression→SetCompressionAlgorithm(server controller has only the latter);flare.max_queueing_delay→flare.max_queueing_delay_ms; flagaccept_request_raw_bytesas TODO (still commented out inrpc_options.proto:60andstd_protocol.cc:198)protocol.md内置协义→内置协议README.mdbuffer.md/coding-comparison.md/gdb-plugin.mdto the indexFilled previously-empty stubs
Both files were 0 bytes despite being linked from
protocol.md.protocol/http.md: pointers toHttp11Protocol/HttpService/HttpRequest|Response/HttpStatus; delegates user-facing usage tointro-http.md.protocol/new.md: step-by-step guide for adding a new protocol —StreamProtocol/Message/Controller/StreamServicesurfaces,FLARE_RPC_REGISTER_*_STREAM_PROTOCOL*registration macros, and a reference table of existing implementations (StdProtocol,Http11Protocol,HbaseClient/ServerProtocol,RedisProtocol).Test plan
🤖 Generated with Claude Code