Document the automatic alias printing of InstAliases.
authorBill Wendling <isanbard@gmail.com>
Wed, 4 May 2011 23:40:14 +0000 (23:40 +0000)
committerBill Wendling <isanbard@gmail.com>
Wed, 4 May 2011 23:40:14 +0000 (23:40 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@130889 91177308-0d34-0410-b5e6-96231b3b80d8

docs/CodeGenerator.html

index 9185563323924b613ca2eac3d18b1af7cfbf5dce..60f42607f07be64fab614a391caf93329377952c 100644 (file)
@@ -2019,6 +2019,11 @@ def : InstAlias&lt;"fcomi $reg", (COM_FIr RST:$reg)&gt;;
 <p>Instruction aliases can also have a Requires clause to make them
 subtarget specific.</p>
 
+<p>If the back-end supports it, the instruction printer can automatically emit
+   the alias rather than what's being aliased. It typically leads to better,
+   more readable code. If it's better to print out what's being aliased, then
+   pass a '0' as the third parameter to the InstAlias definition.</p>
+
 </div>
 
 </div>