Merge pull request #89 from displague/fix-docs-checks

Fix docs checks
equinix · Sep 28, 2020 · 5ee1de5 · 5ee1de5
2 parents 299c3fc + 00e8cfc
commit 5ee1de5
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -34,4 +34,4 @@ jobs:
       env:
         PACKET_TOKEN: bogus
     - name: Detect Uncommitted Docs
-      run: git diff docs
+      run: git diff --exit-code docs
diff --git a/cmd/create_device.go b/cmd/create_device.go
@@ -131,8 +131,8 @@ func init() {
 
 	createDeviceCmd.Flags().StringVarP(&storage, "storage", "s", "", "UUID of the storage")
 	createDeviceCmd.Flags().StringVarP(&ipxescripturl, "ipxe-script-url", "i", "", "URL to the iPXE script")
-	createDeviceCmd.Flags().StringVarP(&userdata, "userdata", "u", "", "User data")
-	createDeviceCmd.Flags().StringVarP(&userdataFile, "userdata-file", "", "", "Filename to read Userdata from")
+	createDeviceCmd.Flags().StringVarP(&userdata, "userdata", "u", "", "Userdata for device initialization (can not be used with --userdata-file)")
+	createDeviceCmd.Flags().StringVarP(&userdataFile, "userdata-file", "", "", "Path to a userdata file for device initialization (can not be used with --userdata)")
 	createDeviceCmd.Flags().StringVarP(&customdata, "customdata", "c", "", "Custom data")
 	createDeviceCmd.Flags().StringSliceVarP(&tags, "tags", "t", []string{}, `Tags for the device: --tags="tag1,tag2"`)
 	createDeviceCmd.Flags().IntVarP(&publicIPv4SubnetSize, "public-ipv4-subnet-size", "v", 0, "Size of the public IPv4 subnet")

diff --git a/docs/packet_device_create.md b/docs/packet_device_create.md
@@ -34,7 +34,8 @@ packet device create [flags]
   -s, --storage string                   UUID of the storage
   -t, --tags strings                     Tags for the device: --tags="tag1,tag2"
   -T, --termination-time string          Device termination time: --termination-time="15:04:05"
-  -u, --userdata string                  User data
+  -u, --userdata string                  Userdata for device initialization (can not be used with --userdata-file)
+      --userdata-file string             Path to a userdata file for device initialization (can not be used with --userdata)
 ```
 
 ### Options inherited from parent commands