From 3dfe1440aecc285992b0f325b13c1b95468f0074 Mon Sep 17 00:00:00 2001 From: Arthur Eubanks Date: Tue, 30 Jun 2020 15:53:03 -0700 Subject: [PATCH] [Docs][BasicAA] Rename -basicaa to -basic-aa in docs Follow up to https://reviews.llvm.org/D82607. --- llvm/docs/AliasAnalysis.rst | 8 ++++---- llvm/docs/Passes.rst | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/llvm/docs/AliasAnalysis.rst b/llvm/docs/AliasAnalysis.rst index 23d374a42ddb..65d2477db9c5 100644 --- a/llvm/docs/AliasAnalysis.rst +++ b/llvm/docs/AliasAnalysis.rst @@ -77,7 +77,7 @@ possible) C code: C[1] = A[9-i]; /* One byte store */ } -In this case, the ``basicaa`` pass will disambiguate the stores to ``C[0]`` and +In this case, the ``basic-aa`` pass will disambiguate the stores to ``C[0]`` and ``C[1]`` because they are accesses to two distinct locations one byte apart, and the accesses are each one byte. In this case, the Loop Invariant Code Motion (LICM) pass can use store motion to remove the stores from the loop. In @@ -278,7 +278,7 @@ implementing, you just override the interfaces you can improve. With only one special exception (the :ref:`-no-aa ` pass) every alias analysis pass chains to another alias analysis implementation (for -example, the user can specify "``-basicaa -ds-aa -licm``" to get the maximum +example, the user can specify "``-basic-aa -ds-aa -licm``" to get the maximum benefit from both alias analyses). The alias analysis class automatically takes care of most of this for methods that you don't override. For methods that you do override, in code paths that return a conservative MayAlias or @@ -515,10 +515,10 @@ The ``-no-aa`` pass is just like what it sounds: an alias analysis that never returns any useful information. This pass can be useful if you think that alias analysis is doing something wrong and are trying to narrow down a problem. -The ``-basicaa`` pass +The ``-basic-aa`` pass ^^^^^^^^^^^^^^^^^^^^^ -The ``-basicaa`` pass is an aggressive local analysis that *knows* many +The ``-basic-aa`` pass is an aggressive local analysis that *knows* many important facts: * Distinct globals, stack allocations, and heap allocations can never alias. diff --git a/llvm/docs/Passes.rst b/llvm/docs/Passes.rst index abb7b9d820e0..216b87a925d2 100644 --- a/llvm/docs/Passes.rst +++ b/llvm/docs/Passes.rst @@ -66,7 +66,7 @@ function. This is inspired and adapted from code by: Naveen Neelakantam, Francesco Spadini, and Wojciech Stryjewski. -``-basicaa``: Basic Alias Analysis (stateless AA impl) +``-basic-aa``: Basic Alias Analysis (stateless AA impl) ------------------------------------------------------ A basic alias analysis pass that implements identities (two different globals