docs: unify user journey and clarify build and early deployment flow #7806
+232
−131
Conversation
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
Member
Author
|
Thanks for the review. I’ve applied all the suggested clarifications, fixed stale Doxygen references, and ensured the docs build cleanly. Please let me know if anything else needs tweaking. |
| - INTERNAL = for DynamoRIO developer use | ||
| - DISABLE_WARNINGS = useful if your version of gcc produces warnings we have not seen (we compile with warnings-are-errors) | ||
|
|
||
| \subsubsection sec_cmake_debug Debug Build |
Contributor
There was a problem hiding this comment.
This is now splitting up the CMake text: see line 638 which says "Press Configure" and shouldn't be under a Debug Build header. This debug section would have to be further down; it's not until https://dynamorio.org/page_building.html#autotoc_md102 where it says you can pass parameters on the command line.
Maybe it should go back up under Advanced Build Scenarios?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR refines the structure and navigation of the DynamoRIO documentation by establishing a canonical end-to-end User Journey on the home page and aligning the build and deployment guides with that flow.
The build documentation is reorganized to clearly separate quick-start guidance from advanced build scenarios, and to explicitly document build layout, install outputs, and platform/architecture scope. Runtime validation steps are removed from the build flow to keep build and execution concerns distinct.
The deployment documentation adds concise execution context, including where
drruncomes from, how the launch models differ (drrun,drconfig,drinject), and what constitutes a first successful run. Platform-specific deployment content (Android, QEMU) is grouped under an advanced section, and attach behavior is consistently marked as experimental.The Build Your Own Tool page is kept focused on client APIs and concepts, with a short reference to the canonical User Journey rather than duplicating workflow steps.
Documentation only; no API, tooling, or behavioral changes are introduced.