From 57f087c9da584c68452d0394ddbfa2f3385fe2ce Mon Sep 17 00:00:00 2001 From: Tyler McMullen Date: Tue, 18 Dec 2018 12:38:18 -0800 Subject: [PATCH] Add note to simple_preopt differentiating its use from the preopt crate. --- cranelift/codegen/src/simple_preopt.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/cranelift/codegen/src/simple_preopt.rs b/cranelift/codegen/src/simple_preopt.rs index 2890cb262c..640d866919 100644 --- a/cranelift/codegen/src/simple_preopt.rs +++ b/cranelift/codegen/src/simple_preopt.rs @@ -1,4 +1,8 @@ //! A pre-legalization rewriting pass. +//! +//! This module provides early-stage optimizations. The optimizations found +//! should be useful for already well-optimized code. More general purpose +//! early-stage optimizations can be found in the preopt crate. #![allow(non_snake_case)]