From f9cf4fe6400417544965b63e0b540c5c58ce306a Mon Sep 17 00:00:00 2001 From: Nikita Baksalyar Date: Tue, 12 Apr 2022 21:01:00 +0100 Subject: [PATCH] Fix documentation for codegen::Context::compile (#4019) The function docs incorrectly referred to an argument that's no longer there. --- cranelift/codegen/src/context.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/cranelift/codegen/src/context.rs b/cranelift/codegen/src/context.rs index 91781d1895..bedc5aeb1e 100644 --- a/cranelift/codegen/src/context.rs +++ b/cranelift/codegen/src/context.rs @@ -100,8 +100,8 @@ impl Context { /// /// 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 - /// `Vec`. The machine code is not relocated. Instead, any relocations are emitted - /// into `relocs`. + /// `Vec`. The machine code is not relocated. Instead, any relocations can be obtained + /// from `mach_compile_result`. /// /// This function calls `compile` and `emit_to_memory`, taking care to resize `mem` as /// 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 /// 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 ///