mirror of
https://github.com/MobileGL-Dev/MobileGL
synced 2026-11-07 01:53:24 +09:00
[Docs] (.github/workflows, CMakeLists.txt, MG_Backend, MG_Backend/DirectGLES, MG_Backend/DirectVulkan, MG_Backend/MGPipe, MG_Backend/Record, MG_Impl/Pipe, MG_IntegrationTest, MG_IntegrationTest/Harness, MG_IntegrationTest/Scenarios, MG_Pipe, MG_Remote, MG_Remote/Client, MG_Remote/Server, MG_Remote/Transport, MG_Remote/Wire, MG_State/GLState, MG_Test, MG_Test/Buffer, MG_Test/Purity, MG_Test/Util, MG_Test/Wire, MG_Util/Metrics, MobileGL, scripts, tools/trace_replay): replace stale line-number citations with sections and symbols
This commit is contained in:
@@ -10,8 +10,8 @@
|
||||
|
||||
A design document that cites the code is only as good as its line numbers, and a wrong one
|
||||
is worse than none: it sends the next reader to a function that does something else. The
|
||||
disaggregation plan's first draft cited SamplerObject.h:468-492 for a struct that lives at
|
||||
:72-96 in a 160-line file, and nothing caught it.
|
||||
disaggregation plan's first draft cited lines 468-492 of SamplerObject.h for a struct that then
|
||||
lived at lines 72-96 of a 160-line file, and nothing caught it.
|
||||
|
||||
So every `File.h:123` and `File.cpp:123-456` in the given documents is resolved against a
|
||||
git revision - the file must exist there and must have at least that many lines. Bare file
|
||||
|
||||
Reference in New Issue
Block a user