Apply gofmt to comments

With go 1.19, automated go formatting with `go fmt` applies to comments
as well. This caused the unit test job to fail on new PRs. Let's apply
the go 1.19 formatting to the whole code base.

Fixes gophercloud#2449

Author: mandre

acceptance/openstack/compute/v2/compute.go

@@ -1140,7 +1140,7 @@ func WaitForComputeStatus(client *gophercloud.ServiceClient, server *servers.Ser
 	})
 }
 
-//Convenience method to fill an QuotaSet-UpdateOpts-struct from a QuotaSet-struct
+// Convenience method to fill an QuotaSet-UpdateOpts-struct from a QuotaSet-struct
 func FillUpdateOptsFromQuotaSet(src quotasets.QuotaSet, dest *quotasets.UpdateOpts) {
 	dest.FixedIPs = &src.FixedIPs
 	dest.FloatingIPs = &src.FloatingIPs

acceptance/openstack/networking/v2/extensions/fwaas/fwaas.go

@@ -117,7 +117,7 @@ func CreatePolicy(t *testing.T, client *gophercloud.ServiceClient, ruleID string
 }
 
 // CreateRule will create a Firewall Rule with a random source address and
-//source port, destination address and port. An error will be returned if
+// source port, destination address and port. An error will be returned if
 // the rule could not be created.
 func CreateRule(t *testing.T, client *gophercloud.ServiceClient) (*rules.Rule, error) {
 	ruleName := tools.RandomString("TESTACC-", 8)

acceptance/openstack/networking/v2/extensions/fwaas_v2/fwaas_v2.go

@@ -69,7 +69,7 @@ func CreatePolicy(t *testing.T, client *gophercloud.ServiceClient, ruleID string
 }
 
 // CreateRule will create a Firewall Rule with a random source address and
-//source port, destination address and port. An error will be returned if
+// source port, destination address and port. An error will be returned if
 // the rule could not be created.
 func CreateRule(t *testing.T, client *gophercloud.ServiceClient) (*rules.Rule, error) {
 	ruleName := tools.RandomString("TESTACC-", 8)

auth_options.go

@@ -12,20 +12,20 @@ provider.
 
 An example of manually providing authentication information:
 
-  opts := gophercloud.AuthOptions{
-    IdentityEndpoint: "https://openstack.example.com:5000/v2.0",
-    Username: "{username}",
-    Password: "{password}",
-    TenantID: "{tenant_id}",
-  }
+	opts := gophercloud.AuthOptions{
+	  IdentityEndpoint: "https://openstack.example.com:5000/v2.0",
+	  Username: "{username}",
+	  Password: "{password}",
+	  TenantID: "{tenant_id}",
+	}
 
-  provider, err := openstack.AuthenticatedClient(opts)
+	provider, err := openstack.AuthenticatedClient(opts)
 
 An example of using AuthOptionsFromEnv(), where the environment variables can
 be read from a file, such as a standard openrc file:
 
-  opts, err := openstack.AuthOptionsFromEnv()
-  provider, err := openstack.AuthenticatedClient(opts)
+	opts, err := openstack.AuthOptionsFromEnv()
+	provider, err := openstack.AuthenticatedClient(opts)
 */
 type AuthOptions struct {
 	// IdentityEndpoint specifies the HTTP endpoint that is required to work with

doc.go

@@ -3,7 +3,7 @@ Package gophercloud provides a multi-vendor interface to OpenStack-compatible
 clouds. The library has a three-level hierarchy: providers, services, and
 resources.
 
-Authenticating with Providers
+# Authenticating with Providers
 
 Provider structs represent the cloud providers that offer and manage a
 collection of services. You will generally want to create one Provider
@@ -49,7 +49,7 @@ instead of "project".
 	opts, err := openstack.AuthOptionsFromEnv()
 	provider, err := openstack.AuthenticatedClient(opts)
 
-Service Clients
+# Service Clients
 
 Service structs are specific to a provider and handle all of the logic and
 operations for a particular OpenStack service. Examples of services include:
@@ -60,7 +60,7 @@ pass in the parent provider, like so:
 
 	client, err := openstack.NewComputeV2(provider, opts)
 
-Resources
+# Resources
 
 Resource structs are the domain models that services make use of in order
 to work with and represent the state of API resources:
@@ -144,6 +144,5 @@ An example retry backoff function, which respects the 429 HTTP response code and
 
 		return nil
 	}
-
 */
 package gophercloud

docs/contributor-tutorial/.template/doc.go

@@ -1,13 +1,12 @@
 /*
 Package NAME manages and retrieves RESOURCE in the OpenStack SERVICE Service.
 
-Example to List RESOURCE
+# Example to List RESOURCE
 
-Example to Create a RESOURCE
+# Example to Create a RESOURCE
 
-Example to Update a RESOURCE
+# Example to Update a RESOURCE
 
 Example to Delete a RESOURCE
-
 */
 package RESOURCE

openstack/baremetal/apiversions/doc.go

@@ -18,6 +18,5 @@ Package apiversions provides information about the versions supported by a speci
 		if err != nil {
 			panic("unable to get API version: " + err.Error())
 		}
-
 */
 package apiversions

openstack/baremetal/httpbasic/doc.go

@@ -3,16 +3,16 @@ Package httpbasic provides support for http_basic bare metal endpoints.
 
 Example of obtaining and using a client:
 
-      client, err := httpbasic.NewBareMetalHTTPBasic(httpbasic.Endpoints{
-		IronicEndpoing:     "http://localhost:6385/v1/",
-		IronicUser:         "myUser",
-		IronicUserPassword: "myPassword",
-	})
-	if err != nil {
-		panic(err)
-	}
+	      client, err := httpbasic.NewBareMetalHTTPBasic(httpbasic.Endpoints{
+			IronicEndpoing:     "http://localhost:6385/v1/",
+			IronicUser:         "myUser",
+			IronicUserPassword: "myPassword",
+		})
+		if err != nil {
+			panic(err)
+		}
 
-	client.Microversion = "1.50"
-	nodes.ListDetail(client, nodes.listOpts{})
+		client.Microversion = "1.50"
+		nodes.ListDetail(client, nodes.listOpts{})
 */
 package httpbasic

openstack/baremetal/v1/nodes/results.go

@@ -373,8 +373,8 @@ type DriverValidation struct {
 	Reason string `json:"reason"`
 }
 
-//  Ironic validates whether the Node’s driver has enough information to manage the Node. This polls each interface on
-//  the driver, and returns the status of that interface as an DriverValidation struct.
+// Ironic validates whether the Node’s driver has enough information to manage the Node. This polls each interface on
+// the driver, and returns the status of that interface as an DriverValidation struct.
 type NodeValidation struct {
 	BIOS       DriverValidation `json:"bios"`
 	Boot       DriverValidation `json:"boot"`

openstack/baremetal/v1/ports/doc.go

@@ -1,85 +1,83 @@
 /*
- Package ports contains the functionality to Listing, Searching, Creating, Updating,
- and Deleting of bare metal Port resources
-
- API reference: https://developer.openstack.org/api-ref/baremetal/#ports-ports
+	Package ports contains the functionality to Listing, Searching, Creating, Updating,
+	and Deleting of bare metal Port resources
 
+	API reference: https://developer.openstack.org/api-ref/baremetal/#ports-ports
 
 Example to List Ports with Detail
 
- 	ports.ListDetail(client, nil).EachPage(func(page pagination.Page) (bool, error) {
- 		portList, err := ports.ExtractPorts(page)
- 		if err != nil {
- 			return false, err
- 		}
+	ports.ListDetail(client, nil).EachPage(func(page pagination.Page) (bool, error) {
+		portList, err := ports.ExtractPorts(page)
+		if err != nil {
+			return false, err
+		}
 
- 		for _, n := range portList {
- 			// Do something
- 		}
+		for _, n := range portList {
+			// Do something
+		}
 
- 		return true, nil
- 	})
+		return true, nil
+	})
 
 Example to List Ports
 
-	listOpts := ports.ListOpts{
- 		Limit: 10,
-	}
+		listOpts := ports.ListOpts{
+	 		Limit: 10,
+		}
 
- 	ports.List(client, listOpts).EachPage(func(page pagination.Page) (bool, error) {
- 		portList, err := ports.ExtractPorts(page)
- 		if err != nil {
- 			return false, err
- 		}
+	 	ports.List(client, listOpts).EachPage(func(page pagination.Page) (bool, error) {
+	 		portList, err := ports.ExtractPorts(page)
+	 		if err != nil {
+	 			return false, err
+	 		}
 
- 		for _, n := range portList {
- 			// Do something
- 		}
+	 		for _, n := range portList {
+	 			// Do something
+	 		}
 
- 		return true, nil
- 	})
+	 		return true, nil
+	 	})
 
 Example to Create a Port
 
-	createOpts := ports.CreateOpts{
- 		NodeUUID: "e8920409-e07e-41bb-8cc1-72acb103e2dd",
-		Address: "00:1B:63:84:45:E6",
-    PhysicalNetwork: "my-network",
-	}
+		createOpts := ports.CreateOpts{
+	 		NodeUUID: "e8920409-e07e-41bb-8cc1-72acb103e2dd",
+			Address: "00:1B:63:84:45:E6",
+	    PhysicalNetwork: "my-network",
+		}
 
- 	createPort, err := ports.Create(client, createOpts).Extract()
- 	if err != nil {
- 		panic(err)
- 	}
+	 	createPort, err := ports.Create(client, createOpts).Extract()
+	 	if err != nil {
+	 		panic(err)
+	 	}
 
 Example to Get a Port
 
- 	showPort, err := ports.Get(client, "c9afd385-5d89-4ecb-9e1c-68194da6b474").Extract()
- 	if err != nil {
- 		panic(err)
- 	}
+	showPort, err := ports.Get(client, "c9afd385-5d89-4ecb-9e1c-68194da6b474").Extract()
+	if err != nil {
+		panic(err)
+	}
 
 Example to Update a Port
 
-	updateOpts := ports.UpdateOpts{
- 		ports.UpdateOperation{
- 			Op:    ReplaceOp,
- 			Path:  "/address",
- 			Value: "22:22:22:22:22:22",
- 		},
-	}
+		updateOpts := ports.UpdateOpts{
+	 		ports.UpdateOperation{
+	 			Op:    ReplaceOp,
+	 			Path:  "/address",
+	 			Value: "22:22:22:22:22:22",
+	 		},
+		}
 
- 	updatePort, err := ports.Update(client, "c9afd385-5d89-4ecb-9e1c-68194da6b474", updateOpts).Extract()
- 	if err != nil {
- 		panic(err)
- 	}
+	 	updatePort, err := ports.Update(client, "c9afd385-5d89-4ecb-9e1c-68194da6b474", updateOpts).Extract()
+	 	if err != nil {
+	 		panic(err)
+	 	}
 
 Example to Delete a Port
 
- 	err = ports.Delete(client, "c9afd385-5d89-4ecb-9e1c-68194da6b474").ExtractErr()
- 	if err != nil {
- 		panic(err)
-	}
-
+	 	err = ports.Delete(client, "c9afd385-5d89-4ecb-9e1c-68194da6b474").ExtractErr()
+	 	if err != nil {
+	 		panic(err)
+		}
 */
 package ports

openstack/blockstorage/apiversions/doc.go

@@ -18,7 +18,6 @@ Example of Retrieving all API Versions
 		fmt.Printf("%+v\n", version)
 	}
 
-
 Example of Retrieving an API Version
 
 	version, err := apiversions.Get(client, "v3").Extract()

openstack/blockstorage/extensions/availabilityzones/doc.go

@@ -4,18 +4,18 @@ available volume availability zones.
 
 Example of Get Availability Zone Information
 
-	allPages, err := availabilityzones.List(volumeClient).AllPages()
-	if err != nil {
-		panic(err)
-	}
+		allPages, err := availabilityzones.List(volumeClient).AllPages()
+		if err != nil {
+			panic(err)
+		}
 
-	availabilityZoneInfo, err := availabilityzones.ExtractAvailabilityZones(allPages)
-	if err != nil {
-		panic(err)
-	}
+		availabilityZoneInfo, err := availabilityzones.ExtractAvailabilityZones(allPages)
+		if err != nil {
+			panic(err)
+		}
 
-	for _, zoneInfo := range availabilityZoneInfo {
-  		fmt.Printf("%+v\n", zoneInfo)
-	}
+		for _, zoneInfo := range availabilityZoneInfo {
+	  		fmt.Printf("%+v\n", zoneInfo)
+		}
 */
 package availabilityzones

openstack/blockstorage/extensions/limits/doc.go

@@ -3,11 +3,11 @@ Package limits shows rate and limit information for a project you authorized for
 
 Example to Retrieve Limits
 
-    limits, err := limits.Get(blockStorageClient).Extract()
-    if err != nil {
-        panic(err)
-    }
+	limits, err := limits.Get(blockStorageClient).Extract()
+	if err != nil {
+	    panic(err)
+	}
 
-    fmt.Printf("%+v\n", limits)
+	fmt.Printf("%+v\n", limits)
 */
 package limits

openstack/blockstorage/extensions/quotasets/doc.go

@@ -50,7 +50,6 @@ Example to Update a Quota set with volume_type quotas
 
 	fmt.Printf("%+v\n", quotaset)
 
-
 Example to Delete a Quota Set
 
 	err := quotasets.Delete(blockStorageClient, "project-id").ExtractErr()

openstack/blockstorage/extensions/volumeactions/doc.go

@@ -25,7 +25,6 @@ Example of Attaching a Volume to an Instance
 		panic(err)
 	}
 
-
 Example of Creating an Image from a Volume
 
 	uploadImageOpts := volumeactions.UploadImageOpts{

openstack/blockstorage/v3/attachments/doc.go

@@ -82,6 +82,5 @@ Example to Delete Attachment
 	if err != nil {
 		panic(err)
 	}
-
 */
 package attachments

openstack/blockstorage/v3/attachments/requests.go

@@ -12,7 +12,7 @@ type CreateOptsBuilder interface {
 }
 
 // CreateOpts contains options for creating a Volume attachment. This object is
-//passed to the Create function. For more information about these parameters,
+// passed to the Create function. For more information about these parameters,
 // see the Attachment object.
 type CreateOpts struct {
 	// VolumeUUID is the UUID of the Cinder volume to create the attachment

openstack/blockstorage/v3/qos/doc.go

@@ -78,7 +78,6 @@ Example of updating QoSSpec
 	}
 	fmt.Printf("%+v\n", specs)
 
-
 Example of deleting specific keys/specs from a QoS
 
 	qosID := "de075d5e-8afc-4e23-9388-b84a5183d1c0"
@@ -143,6 +142,5 @@ Example of listing all associations of a QoS
 	for _, association := range allAssociations {
 		fmt.Printf("Association: %+v\n", association)
 	}
-
 */
 package qos