Minor formatting fixes for the LLVM devdocs #22397
Merged
Conversation
This file contains 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
|
Btw @Keno these docs are legendary. Excellent work. |
tkelman
reviewed
Jun 17, 2017
doc/src/devdocs/llvm.md
Outdated
| @@ -112,36 +112,36 @@ The last step is labor intensive. Suggestions on a better way would be apprecia | |||
|
|
|||
| Julia has a generic calling convention for unoptimized code, which looks somewhat | |||
| as follows: | |||
| ``` | |||
| ```c | |||
| jl_value_t *any_unoptimized_call(jl_value_t *, jl_value_t **, int); | |||
There was a problem hiding this comment.
does the indentation do any good if it's already triple-backtick-fenced?
There was a problem hiding this comment.
I believe they end up showing as indented in that case. Dunno whether that was intentional.
There was a problem hiding this comment.
if it's just a single line of code, seems unnecessary?
ajkeller34
reviewed
Jun 17, 2017
doc/src/devdocs/llvm.md
Outdated
| @@ -63,29 +63,29 @@ via the environment variable `JULIA_LLVM_ARGS`. Here are example settings using | |||
| ## Debugging LLVM transformations in isolation | |||
|
|
|||
| On occasion, it can be useful to debug LLVM's transformations in isolation from | |||
| the rest of the julia system, e.g. because reproducing the issue inside julia | |||
| the rest of the Julia system, e.g. because reproducing the issue inside Julia | |||
| would take too long, or because one wants to take advantage of LLVM's tooling | |||
| (e.g. bugpoint). To get unoptimized IR for the entire system iamge, pass the | |||
ararslan
force-pushed
the
aa/gc-root-doc-fixes
branch
from
fb4de18
to
a2cc49b
Compare
Keno
reviewed
Jun 17, 2017
doc/src/devdocs/llvm.md
Outdated
| @@ -63,29 +63,29 @@ via the environment variable `JULIA_LLVM_ARGS`. Here are example settings using | |||
| ## Debugging LLVM transformations in isolation | |||
|
|
|||
| On occasion, it can be useful to debug LLVM's transformations in isolation from | |||
| the rest of the julia system, e.g. because reproducing the issue inside julia | |||
| the rest of the Julia system, e.g. because reproducing the issue inside Julia | |||
There was a problem hiding this comment.
These do actually refer to the executable, so should be lower case.
Keno
reviewed
Jun 17, 2017
doc/src/devdocs/llvm.md
Outdated
| image, one could do: | ||
| ``` | ||
| opt -load libjulia.so -julia -o opt.bc unopt.bc | ||
| llc -o sys.o opt.bc | ||
| cc -shared -o sys.so sys.o | ||
| ``` | ||
| This system image can then be loaded by julia as usual. | ||
| This system image can then be loaded by Julia as usual. |
There was a problem hiding this comment.
also lower case here and the one above
Keno
approved these changes
Jun 17, 2017
ararslan
force-pushed
the
aa/gc-root-doc-fixes
branch
from
a2cc49b
to
3207358
Compare
ararslan
force-pushed
the
aa/gc-root-doc-fixes
branch
from
3207358
to
96dadb7
Compare
Keno
approved these changes
Jun 17, 2017
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.
In particular, there were a few places where Julia and GC should be capitalized as well as a couple of typos. I also added language annotation to the code blocks. (Highlighter supports LLVM!)
Addresses some of the things noted by @tkelman in #21888.
Note that CI has been skipped and that it should be removed from the commit message when merging to ensure the docs get built.
make check-whitespacepassed locally.