From: Mauri de Souza Meneguzzo <mauri870@gmail.com>
Date: Tue, 28 Nov 2023 18:50:01 +0000 (+0000)
Subject: doc: document PCALIGN directive
X-Git-Tag: go1.22rc1~144
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=5df4a6376f4368e55bfb848f27f078f237f01482;p=gostls13.git

doc: document PCALIGN directive

Fixes #64283

Change-Id: Ie0167410fc5557143f0b2e17af56ad9fe34605cf
GitHub-Last-Rev: 77144c76d38ca261b6728ba12ff128d22553efa5
GitHub-Pull-Request: golang/go#64296
Reviewed-on: https://go-review.googlesource.com/c/go/+/544115
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Keith Randall <khr@golang.org>
Reviewed-by: Cherry Mui <cherryyz@google.com>
Auto-Submit: Keith Randall <khr@golang.org>
Reviewed-by: Keith Randall <khr@google.com>
---

diff --git a/doc/asm.html b/doc/asm.html
index f7787a4076..dd395ec833 100644
--- a/doc/asm.html
+++ b/doc/asm.html
@@ -464,6 +464,23 @@ Function is the outermost frame of the call stack. Traceback should stop at this
 </li>
 </ul>
 
+<h3 id="special-instructions">Special instructions</h3>
+
+<p>
+The <code>PCALIGN</code> pseudo-instruction is used to indicate that the next instruction should be aligned
+to a specified boundary by padding with no-op instructions.
+</p>
+
+<p>
+It is currently supported on arm64, amd64, ppc64, loong64 and riscv64.
+
+For example, the start of the <code>MOVD</code> instruction below is aligned to 32 bytes:
+<pre>
+PCALIGN $32
+MOVD $2, R0
+</pre>
+</p>
+
 <h3 id="data-offsets">Interacting with Go types and constants</h3>
 
 <p>