docs: fixed examples and help output

This commit is contained in:
David Allen 2025-09-03 17:38:00 -06:00
parent 760b386f2d
commit 3ced4e4fd4
Signed by: towk
GPG key ID: 0430CDBE22619155

View file

@ -17,7 +17,7 @@ import (
var pluginsCmd = &cobra.Command{ var pluginsCmd = &cobra.Command{
Use: "plugins", Use: "plugins",
Short: "Manage, inspect, and compile plugins (requires Go build tools)", Short: "Manage, inspect, and compile plugins (requires Go build tools and C compiler)",
PersistentPreRun: func(cmd *cobra.Command, args []string) { PersistentPreRun: func(cmd *cobra.Command, args []string) {
setenv(cmd, "host", "MAKESHIFT_HOST") setenv(cmd, "host", "MAKESHIFT_HOST")
}, },
@ -31,13 +31,13 @@ var pluginsCompileCmd = &cobra.Command{
# try to compile all plugins in current directory # try to compile all plugins in current directory
cd src/plugins cd src/plugins
makeshift plugin compile makeshift plugins compile
# try to compile all plugins in specified directory # try to compile all plugins in specified directory
makeshift plugin compile src/plugins makeshift plugins compile src/plugins
# compile 'src/plugins/myplugin.go' and save to 'lib/myplugin.so' # compile 'src/plugins/myplugin.go' and save to 'lib/myplugin.so'
makeshift plugin compile src/plugins/myplugin.go -o lib/myplugin.so makeshift plugins compile src/plugins/myplugin.go -o lib/myplugin.so
`, `,
Args: cobra.MaximumNArgs(1), Args: cobra.MaximumNArgs(1),
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
@ -97,7 +97,7 @@ var pluginsInspectCmd = &cobra.Command{
Args: cobra.MinimumNArgs(1), Args: cobra.MinimumNArgs(1),
Example: ` Example: `
# inspect a plugin and print its information # inspect a plugin and print its information
makeshift plugin inspect lib/jinja2.so makeshift plugins inspect lib/jinja2.so
`, `,
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
for _, path := range args { for _, path := range args {