Cosmetics here and there

Author: rsora

arduino/utils/stream.go

@@ -37,7 +37,6 @@ func FeedStreamTo(writer func(data []byte)) io.Writer {
 // ConsumeStreamFrom creates a pipe to consume data from the reader function.
 // ConsumeStreamFrom returns the io.Reader side of the pipe, which the user can use to consume the data
 func ConsumeStreamFrom(reader func() ([]byte, error)) io.Reader {
-
 	r, w := io.Pipe()
 	go func() {
 		for {

cli/cli.go

@@ -17,7 +17,6 @@ package cli
 
 import (
 	"fmt"
-	"github.com/arduino/arduino-cli/cli/debug"
 	"io/ioutil"
 	"os"
 	"path/filepath"
@@ -29,6 +28,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/config"
 	"github.com/arduino/arduino-cli/cli/core"
 	"github.com/arduino/arduino-cli/cli/daemon"
+	"github.com/arduino/arduino-cli/cli/debug"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/generatedocs"

cli/debug/debug.go

@@ -42,17 +42,15 @@ func NewCommand() *cobra.Command {
 	debugCommand := &cobra.Command{
 		Use:     "debug",
 		Short:   "Debug Arduino sketches.",
-		Long:    "Debug Arduino sketches.",
-		Example: "  " + os.Args[0] + " debug /home/user/Arduino/MySketch",
+		Long:    "Debug Arduino sketches. (this command opens an interactive gdb session)",
+		Example: "  " + os.Args[0] + " debug -b arduino:samd:mkr1000  /home/user/Arduino/MySketch",
 		Args:    cobra.MaximumNArgs(1),
 		Run:     run,
 	}
 
 	debugCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", "Fully Qualified Board Name, e.g.: arduino:avr:uno")
 	debugCommand.Flags().StringVarP(&port, "port", "p", "", "Upload port, e.g.: COM10 or /dev/ttyACM0")
-	debugCommand.Flags().StringVarP(&importFile, "input", "i", "", "Input file to be uploaded.")
-
-	debugCommand.MarkFlagRequired("port")
+	debugCommand.Flags().StringVarP(&importFile, "input", "i", "", "Input file to be uploaded for debug.")
 
 	return debugCommand
 }
@@ -77,7 +75,7 @@ func run(command *cobra.Command, args []string) {
 		Port:       port,
 		ImportFile: importFile,
 	}, os.Stdin, os.Stdout); err != nil {
-		feedback.Errorf("Error during Upload: %v", err)
+		feedback.Errorf("Error during Debug: %v", err)
 		os.Exit(errorcodes.ErrGeneric)
 	}
 }

commands/debug/debug.go

@@ -28,12 +28,11 @@ import (
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/arduino/sketches"
 	"github.com/arduino/arduino-cli/commands"
+	"github.com/arduino/arduino-cli/executils"
+	dbg "github.com/arduino/arduino-cli/rpc/debug"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/sirupsen/logrus"
-
-	"github.com/arduino/arduino-cli/executils"
-	dbg "github.com/arduino/arduino-cli/rpc/debug"
 )
 
 // Debug command launches a debug tool for a sketch.
@@ -44,7 +43,7 @@ import (
 // It also implements tool process lifecycle management
 func Debug(ctx context.Context, req *dbg.DebugConfigReq, inStream io.Reader, out io.Writer) (*dbg.DebugResp, error) {
 
-	// get tool commandLine from core recipe
+	// Get tool commandLine from core recipe
 	pm := commands.GetPackageManager(req.GetInstance().GetId())
 	commandLine, err := getCommandLine(req, pm)
 	if err != nil {

commands/debug/debug_test.go

@@ -17,13 +17,13 @@ package debug
 
 import (
 	"fmt"
+	"strings"
+	"testing"
+
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
-	rpc "github.com/arduino/arduino-cli/rpc/common"
 	dbg "github.com/arduino/arduino-cli/rpc/debug"
 	"github.com/arduino/go-paths-helper"
 	"github.com/stretchr/testify/assert"
-	"strings"
-	"testing"
 )
 
 var customHardware = paths.New("testdata", "custom_hardware")
@@ -36,14 +36,18 @@ func TestGetCommandLine(t *testing.T) {
 	pm.LoadHardwareFromDirectory(customHardware)
 	pm.LoadHardwareFromDirectory(dataDir)
 
+	// Arduino Zero has an integrated debugger port, anc it could be debugged directly using USB
 	req := &dbg.DebugConfigReq{
-		Instance:   &rpc.Instance{Id: 1},
+		Instance:   &dbg.Instance{Id: 1},
 		Fqbn:       "arduino-test:samd:arduino_zero_edbg",
 		SketchPath: sketchPath,
 		Port:       "none",
 	}
 	packageName := strings.Split(req.Fqbn, ":")[0]
 	processor := strings.Split(req.Fqbn, ":")[1]
+	// This boardFamily variable is necessary for this particular board as it is represented in the core as 2 separated
+	// boards, to expose the programming port and the debug (edbg) port. So we point at the same openocd configuration
+	// variant for upload in both cases
 	boardFamily := "arduino_zero"
 
 	goldCommand := []string{
@@ -59,9 +63,10 @@ func TestGetCommandLine(t *testing.T) {
 	assert.Nil(t, err)
 	assert.Equal(t, goldCommand, command)
 
-	// for other samd boards
+	// Other samd boards such as mkr1000 can be debugged using an external tool such as Atmel ICE connected to
+	// the board debug port
 	req2 := &dbg.DebugConfigReq{
-		Instance:   &rpc.Instance{Id: 1},
+		Instance:   &dbg.Instance{Id: 1},
 		Fqbn:       "arduino-test:samd:mkr1000",
 		SketchPath: sketchPath,
 		Port:       "none",