From 7aa68756c5518e0fc2e2f65cab6b933c1c48534a Mon Sep 17 00:00:00 2001 From: Shenghou Ma Date: Thu, 8 Jan 2015 21:43:47 -0500 Subject: [PATCH] doc/asm: document that assembly function must use short name MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit e.g. ·Name instead of package·Name for automatic stack map to be applied from its Go prototype. The underlying reason is that liblink look up name with suffix ".args_stackmap" for the stackmap coming from its Go prototype, but all the Go functions are named "".Name as this stage. Thus an assembly function named package·Name will never find its stackmap, which is named "".package.Name.args_stackmap. Perhaps cmd/vet should give a warning for this. Change-Id: I10d154a73ec969d574d20af877f747424350fbd1 Reviewed-on: https://go-review.googlesource.com/2588 Reviewed-by: Ian Lance Taylor --- doc/asm.html | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/asm.html b/doc/asm.html index 771c493cc2f..43382fc96be 100644 --- a/doc/asm.html +++ b/doc/asm.html @@ -350,7 +350,11 @@ live pointers in its arguments, results, and local stack frame. For an assembly function with no pointer results and either no local stack frame or no function calls, the only requirement is to define a Go prototype for the function -in a Go source file in the same package. +in a Go source file in the same package. The name of the assembly +function must not contain the package name component (for example, +function Syscall in package syscall should +use the name ·Syscall instead of the equivalent name +syscall·Syscall in its TEXT directive). For more complex situations, explicit annotation is needed. These annotations use pseudo-instructions defined in the standard #include file funcdata.h.