T0b1/wasmtime
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix documentation for codegen::Context::compile (#4019)

Browse Source 
The function docs incorrectly referred to an argument that's no longer there.
This commit is contained in:
Nikita Baksalyar
2022-04-12 21:01:00 +01:00
committed by GitHub
parent 7a55779c6b
commit f9cf4fe640
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
cranelift/codegen/src/context.rs
View File

@@ -100,8 +100,8 @@ impl Context {
/// ///
/// Run the function through all the passes necessary to generate code for the target ISA /// Run the function through all the passes necessary to generate code for the target ISA
/// represented by `isa`, as well as the final step of emitting machine code into a /// represented by `isa`, as well as the final step of emitting machine code into a
/// `Vec<u8>`. The machine code is not relocated. Instead, any relocations are emitted /// `Vec<u8>`. The machine code is not relocated. Instead, any relocations can be obtained
/// into `relocs`. /// from `mach_compile_result`.
/// ///
/// This function calls `compile` and `emit_to_memory`, taking care to resize `mem` as /// This function calls `compile` and `emit_to_memory`, taking care to resize `mem` as
/// needed, so it provides a safe interface. /// needed, so it provides a safe interface.
@@ -173,7 +173,8 @@ impl Context {
/// Write all of the function's machine code to the memory at `mem`. The size of the machine /// Write all of the function's machine code to the memory at `mem`. The size of the machine
/// code is returned by `compile` above. /// code is returned by `compile` above.
/// ///
/// The machine code is not relocated. Instead, any relocations are emitted into `relocs`. /// The machine code is not relocated.
/// Instead, any relocations can be obtained from `mach_compile_result`.
/// ///
/// # Safety /// # Safety
/// ///