docs: clean up and complete the JSIR documentation - #133
Open
rootkiller6788 wants to merge 1 commit into
Open
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
- Fix stale JSHIR reference in README and link the dataflow analysis doc - Document the jsir/jshir dialect split (high-level vs low-level IR) - Add a "The C++ API" section and a lattice-order definition - Replace work-in-progress phrasing with links to tracking issues - Remove leftover [TOC] placeholders
rootkiller6788
force-pushed
the
docs/documentation-cleanup
branch
from
August 15, 2026 16:05
8c51891 to
3656d7a
Compare
Collaborator
|
Thanks for the contribution! Please note that your PR might be delayed by several days because (1) we still haven't established a way to automatically sync GitHub PRs into our internal codebase, so we will have to manually do it; (2) our internal codebase -> GitHub sync process is somewhat unstable, so we might need to fix that first. |
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
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
Completes the JSIR documentation cleanup tracked in #9. The docs previously
contained a stale dialect reference, a missing dataflow-analysis API reference,
unresolved work-in-progress phrasing, and leftover
[TOC]placeholders. Thischange fixes those and documents the
jsir/jshirdialect split.Changes
README.md
JSHIRreference: thejsir_gentool produces the full IR(both dialects), not the high-level dialect alone, so the heading now says
JSIR.docs/dataflow_analysis.mdalongside the existing IR design doc.docs/intermediate_representation_design.md
jsirandjshir" section explaining thatjshiristhe high-level IR (HIR, control-flow ops) and
jsiris the low-level IR(LIR, non-control-flow ops), per
maldoca/astgen/ast_def.h.docs/dataflow_analysis.md
JsirState<T>,JsirPerVarState,the analysis base classes, and the
RunJsirAnalysis(...)entry point.(
Uninit ≤ Const{N} ≤ Unknown).[TOC]placeholder (also removed fromintermediate_representation_design.md).jsir/jshirop naming andUninit(uninitialized)terminology.
References
Notes