Skip to content

docs: clean up and complete the JSIR documentation - #133

Open
rootkiller6788 wants to merge 1 commit into
google:mainfrom
rootkiller6788:docs/documentation-cleanup
Open

docs: clean up and complete the JSIR documentation#133
rootkiller6788 wants to merge 1 commit into
google:mainfrom
rootkiller6788:docs/documentation-cleanup

Conversation

@rootkiller6788

Copy link
Copy Markdown

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. This
change fixes those and documents the jsir / jshir dialect split.

Changes

  • README.md

    • Fix a stale JSHIR reference: the jsir_gen tool produces the full IR
      (both dialects), not the high-level dialect alone, so the heading now says
      JSIR.
    • Link docs/dataflow_analysis.md alongside the existing IR design doc.
  • docs/intermediate_representation_design.md

    • Add a "Two dialects: jsir and jshir" section explaining that jshir is
      the high-level IR (HIR, control-flow ops) and jsir is the low-level IR
      (LIR, non-control-flow ops), per maldoca/astgen/ast_def.h.
    • Replace the in-progress symbol-representation note with a link to Revisit the representation of lvalues, especially patterns #25.
  • docs/dataflow_analysis.md

    • Add a "The C++ API" section covering JsirState<T>, JsirPerVarState,
      the analysis base classes, and the RunJsirAnalysis(...) entry point.
    • Add the lattice-order definition for constant propagation
      (Uninit ≤ Const{N} ≤ Unknown).
    • Replace work-in-progress phrasing with links to tracking issues.
    • Remove the leftover [TOC] placeholder (also removed from
      intermediate_representation_design.md).
    • Clarify the jsir / jshir op naming and Uninit (uninitialized)
      terminology.

References

Notes

  • Doc-only change; no code or build changes.
  • Signed the Google CLA (required before this can be merged).

@google-cla

google-cla Bot commented Aug 15, 2026

Copy link
Copy Markdown

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
rootkiller6788 force-pushed the docs/documentation-cleanup branch from 8c51891 to 3656d7a Compare August 15, 2026 16:05
@phisiart

Copy link
Copy Markdown
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clean up and release documentation

2 participants