summaryrefslogtreecommitdiff
path: root/src/cmd/pack/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'src/cmd/pack/doc.go')
-rw-r--r--src/cmd/pack/doc.go27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/cmd/pack/doc.go b/src/cmd/pack/doc.go
new file mode 100644
index 000000000..8b17f3ca2
--- /dev/null
+++ b/src/cmd/pack/doc.go
@@ -0,0 +1,27 @@
+// Copyright 2009 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+/*
+
+Pack is a variant of the Plan 9 ar tool. The original is documented at
+
+ http://plan9.bell-labs.com/magic/man2html/1/ar
+
+It adds a special Go-specific section __.PKGDEF that collects all the
+Go type information from the files in the archive; that section is
+used by the compiler when importing the package during compilation.
+
+Usage:
+ go tool pack [uvnbailogS][mrxtdpq][P prefix] archive files ...
+
+The new option 'g' causes pack to maintain the __.PKGDEF section
+as files are added to the archive.
+
+The new option 'S' forces pack to mark the archive as safe.
+
+The new option 'P' causes pack to remove the given prefix
+from file names in the line number information in object files
+that are already stored in or added to the archive.
+*/
+package documentation