Skip to content

Standardization pass through docs/ folder. #3597

Merged
ScottTodd merged 4 commits intoiree-org:mainfrom
ScottTodd:docs-cmake
Oct 23, 2020
Merged

Standardization pass through docs/ folder. #3597
ScottTodd merged 4 commits intoiree-org:mainfrom
ScottTodd:docs-cmake

Conversation

@ScottTodd
Copy link
Copy Markdown
Member

  • recommend an out-of-tree CMake build directory ../iree-build/ instead of in-tree build/
  • consistently use .vmfb as VM module flatbuffer file extensions
  • make some docs use CMake examples instead of Bazel examples
  • prefix all shell commands with $
  • indent shell commands two spaces when continuing onto multiple lines
  • consistently use - for LLVM flags and -- for Abseil flags
  • typo fixes

@ScottTodd ScottTodd added the documentation ✏️ Improvements or additions to documentation label Oct 23, 2020
@google-cla google-cla Bot added the cla: yes label Oct 23, 2020
@GMNGeoffrey
Copy link
Copy Markdown
Contributor

I so badly want copy-paste that strips the $. We should look at how that's implemented internally and see if we can easily add it.

Comment on lines +96 to 97
# Use --config=asserts to enable assertions in IREE and LLVM.
build:asserts --compilation_mode=opt '--per_file_copt=iree|llvm@-UNDEBUG'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pretty sure @bjacob said this would create ODR violations and was bad

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

We can follow up on that later, separate from this PR.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yeah just noticed it :-)

@ScottTodd ScottTodd merged commit 2edc7d6 into iree-org:main Oct 23, 2020
@ScottTodd ScottTodd deleted the docs-cmake branch October 23, 2020 23:37
@ScottTodd
Copy link
Copy Markdown
Member Author

I so badly want copy-paste that strips the $. We should look at how that's implemented internally and see if we can easily add it.

Same... Discussed a bit on Discord. We have some options, none look super easy though.

ScottTodd added a commit that referenced this pull request Oct 28, 2020
Knew there would be some issues in #3597 :P
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation ✏️ Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants