docs: clean up and complete the JSIR documentation - #133
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
8c51891 to
3656d7a
Compare
|
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. |
| short-circuit and conditional expressions (`jshir.logical_expression`, | ||
| `jshir.conditional_expression`). | ||
|
|
||
| * `jsir` is the low-level IR (LIR). It holds the operations without |
There was a problem hiding this comment.
jsir does not mean low-level. Maybe change the two bullet points into:
jshirholds the operations that carry control-flow (branch) semantics...jsirholds the operations without control-flow semantics...
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