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.

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

Refactoring of docs #171

Merged
merged 1 commit into from
Apr 10, 2020
Merged

Conversation

smaillet
Copy link
Member

  • Moved docs markdown for samples into the actual sample libraries to make it easier to find and provide contextual docs when dealing only in source.
  • Editorial corrections and updates to doc markdown topics
  • Kaleidoscope Changed Chapter 2 to conform with Program+ReplEngine+CodeGenerator pattern of the other chapters to make discussion and comparisons easier.

Breaking Change

  • OrcJit lazy call back support is currently disabled due to bugs in LLVM impacting the JIT on Windows
  • To help prevent accidental misuse of the LLVM target registration (e.g. register before initialization) the library initialization and registration were changed. The registration static methods were all removed and instead an interface for registration is provided. The initialize now returns an instance of that interface, which is also IDisposable. The interface is then used to register the targets. This ensures that the registration only occurs after initialization. Additionally, the logic for initialization was updated to defend against any sort of init.dispose,re-init that isn't supported by the underlying LLVM library. (Both of these points were the results of attempts to document the correct use and reallizing that a better answer was to enforce the pattern in the library itself rather than relying on the docs.)

@smaillet smaillet merged commit c1914e0 into UbiquityDotNET:develop Apr 10, 2020
@smaillet smaillet deleted the RefactorDocs branch April 10, 2020 16:32
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.

1 participant