From 954e73b328ae8cdaeaaefeecd9101232eb2c86d3 Mon Sep 17 00:00:00 2001 From: per1234 Date: Sat, 4 Jul 2020 12:11:45 -0700 Subject: [PATCH] Correct documentation re: arduino-cli config init behavior - Default configuration file location is no longer correctly described as "$EXE_DIR". It is now directories.data. - Location of the written configuration file location may be customized via --dest-dir. - Current configuration is written, not the default configuration. - If configuration file already exists, it is updated with the current configuration. --- cli/config/init.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/cli/config/init.go b/cli/config/init.go index 7dd3a56d7e6..8d0cbc66559 100644 --- a/cli/config/init.go +++ b/cli/config/init.go @@ -33,10 +33,10 @@ const defaultFileName = "arduino-cli.yaml" func initInitCommand() *cobra.Command { initCommand := &cobra.Command{ Use: "init", - Short: "Initializes a new configuration file into the default location.", - Long: "Initializes a new configuration file into the default location ($EXE_DIR/cli-config.yml).", + Short: "Writes current configuration to a configuration file.", + Long: "Creates or updates the configuration file in the data directory or custom directory with the current configuration settings.", Example: "" + - " # Creates a default configuration file into the default location.\n" + + " # Writes current configuration to the configuration file in the data directory.\n" + " " + os.Args[0] + " config init", Args: cobra.NoArgs, Run: runInitCommand,