Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[cranelift docs] Fix grammar code blocks and heap image #1339

Merged
merged 3 commits into from
Mar 18, 2020
Merged

[cranelift docs] Fix grammar code blocks and heap image #1339

merged 3 commits into from
Mar 18, 2020

Conversation

samrat
Copy link
Contributor

@samrat samrat commented Mar 17, 2020

  • Move grammar segments in IR docs to code blocks
  • Replace dot code in IR docs with generated image.

bjorn3
bjorn3 suggested changes Mar 17, 2020
View reviewed changes
cranelift/docs/ir.md Outdated Show resolved Hide resolved
cranelift/docs/ir.md Outdated Show resolved Hide resolved
cranelift/docs/heap.svg Show resolved Hide resolved
@samrat samrat force-pushed the cranelift-ir-doc-formatting branch from 031507e to 4db0bcc Compare March 17, 2020 15:20
bjorn3
bjorn3 reviewed Mar 17, 2020
View reviewed changes
Copy link
Contributor

@bjorn3 bjorn3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't notice the indent last time

cranelift/docs/ir.md Outdated Show resolved Hide resolved
cranelift/docs/ir.md Outdated Show resolved Hide resolved
sunfishcode
sunfishcode reviewed Mar 17, 2020
View reviewed changes
Copy link
Member

@sunfishcode sunfishcode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks!

cranelift/docs/heap.dot Outdated Show resolved Hide resolved
@github-actions github-actions bot added cranelift Issues related to the Cranelift code generator cranelift:docs labels Mar 17, 2020
@github-actions

This comment has been minimized.

Sign in to view
samrat and others added 2 commits March 17, 2020 23:19
@samrat
[cranelift docs] Replace dot code in IR docs with generated image.
e59b7a2 
This is how the image was generated

$ cat > heap.dot << EOF
digraph {
        node [
              shape=record,
              fontsize=10,
              fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans"
              ]
        "static" [label="mapped\npages|unmapped\npages|offset_guard\npages"]
}
EOF

$ dot -Tsvg -O heap.dot
@samrat @bjorn3
[cranelift docs] Fix indentation in grammar block
f66a9f3 
Co-Authored-By: bjorn3 <bjorn3@users.noreply.github.com>
@samrat samrat force-pushed the cranelift-ir-doc-formatting branch from 6664b0a to f66a9f3 Compare March 17, 2020 17:49
@sunfishcode sunfishcode merged commit 1958e8a into bytecodealliance:master Mar 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bjorn3 bjorn3 bjorn3 requested changes

@sunfishcode sunfishcode sunfishcode left review comments

Assignees
No one assigned
Labels
cranelift Issues related to the Cranelift code generator
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@samrat @sunfishcode @bjorn3