[PATCH] D80407: [AMDGPU] Correct formatting typos in documentation

[Tony Tye via Phabricator via llvm-commits]

t-tye created this revision.
Herald added subscribers: llvm-commits, kerbowa, tpr, dstuttard, yaxunl, nhaehnle, wdng, jvesely, kzhuravl.
Herald added a project: LLVM.
t-tye added a reviewer: kzhuravl.
t-tye added a reviewer: scott.linder.

- Correct missing space in some "note" and "TODO" directives in AMDGPUUsage.rst
- Correct warning for heading underline being too short in BitCodeFormat.rst


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D80407

Files:
  llvm/docs/AMDGPUUsage.rst
  llvm/docs/BitCodeFormat.rst


Index: llvm/docs/BitCodeFormat.rst
===================================================================
--- llvm/docs/BitCodeFormat.rst
+++ llvm/docs/BitCodeFormat.rst
@@ -1108,7 +1108,7 @@
 the type table.
 
 TYPE_CODE_BFLOAT Record
-^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^
 
 ``[BFLOAT]``
 
Index: llvm/docs/AMDGPUUsage.rst
===================================================================
--- llvm/docs/AMDGPUUsage.rst
+++ llvm/docs/AMDGPUUsage.rst
@@ -6673,12 +6673,12 @@
 
 The input and result arguments are assigned in order in the following manner:
 
-..note::
+.. note::
 
   There are likely some errors and omissions in the following description that
   need correction.
 
-  ..TODO::
+  .. TODO::
 
     Check the clang source code to decipher how function arguments and return
     results are handled. Also see the AMDGPU specific values used.
@@ -6726,7 +6726,7 @@
 4.  No CFI is currently generated. See
     :ref:`amdgpu-dwarf-call-frame-information`.
 
-    ..note::
+    .. note::
 
       CFI will be generated that defines the CFA as the unswizzled address
       relative to the wave scratch base in the unswizzled private address space
@@ -6751,7 +6751,7 @@
     from SP. Then SP is incremented to account for the known frame size before
     the call and decremented after the call.
 
-    ..note::
+    .. note::
 
       The CFI will reflect the changed calculation needed to compute the CFA
       from SP.
@@ -6760,7 +6760,7 @@
     emergency spill slot. Buffer instructions are used for stack accesses and
     not the ``flat_scratch`` instruction.
 
-    ..TODO::
+    .. TODO::
 
       Explain when the emergency spill slot is used.
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D80407.265601.patch
Type: text/x-patch
Size: 1675 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200521/047b5229/attachment.bin>