more package docs

packer-plugin-sdk/multistep/commonsteps/doc.go

@@ -12,5 +12,4 @@ provisioners to run inside your builder.
 While it is possible to create a simple builder without using the multistep
 runner or step_provision, your builder will lack core Packer functionality.
 */
-
 package commonsteps

packer-plugin-sdk/multistep/doc.go

@@ -57,5 +57,4 @@ Value is 1
 Value is 2
 ```
 */
-
 package multistep

packer-plugin-sdk/net/configure_port.go

@@ -1,3 +1,5 @@
+// package net contains some helper wrapping functions for the http and net
+// golang libraries that meet Packer-specific needs.
 package net
 
 import (

packer-plugin-sdk/packerbuilderdata/generated_data.go

@@ -1,3 +1,7 @@
+// Package packerbuilderdata provides tooling for setting and getting special
+// builder-generated data that will be passed to the provisioners. This data
+// should be limited to runtime data like instance id, ip address, and other
+// relevant details that provisioning scripts may need access to.
 package packerbuilderdata
 
 import "github.com/hashicorp/packer/packer-plugin-sdk/multistep"

packer-plugin-sdk/pathing/config_file.go

@@ -1,3 +1,5 @@
+// Package pathing determines where to put the Packer config directory based on
+// host OS architecture and user environment variables.
 package pathing
 
 import (

packer-plugin-sdk/random/string.go

@@ -1,3 +1,4 @@
+// Package random is a helper for generating random alphanumeric strings.
 package random
 
 import (

packer-plugin-sdk/retry/retry.go

@@ -1,3 +1,5 @@
+// Package retry provides tooling to retry API calls which are known to be
+// vulnerable to throttling or flakiness due to eventual consistency.
 package retry
 
 import (

packer-plugin-sdk/rpc/init.go

@@ -1,3 +1,9 @@
+/*
+Package rpc contains the implementation of the remote procedure call code that
+the Packer core uses to communicate with packer plugins. As a plugin maintainer,
+You are unlikely to need to directly import or use this package, but it
+underpins the packer server that all plugins must implement.
+*/
 package rpc
 
 import "encoding/gob"