Apply general cosmetics

Author: rsora

cli/daemon/daemon.go

@@ -70,19 +70,19 @@ func runDaemonCommand(cmd *cobra.Command, args []string) {
 		VersionString:     globals.VersionInfo.VersionString,
 	})
 
-	// register the monitors service
+	// Register the monitors service
 	srv_monitor.RegisterMonitorServer(s, &daemon.MonitorService{})
 
-	// register the settings service
+	// Register the settings service
 	srv_settings.RegisterSettingsServer(s, &daemon.SettingsService{})
 
-	// register the debug session service
+	// Register the debug session service
 	srv_debug.RegisterDebugServer(s, &daemon.DebugService{})
 
 	if !daemonize {
 		// When parent process ends terminate also the daemon
 		go func() {
-			// stdin is closed when the controlling parent process ends
+			// Stdin is closed when the controlling parent process ends
 			_, _ = io.Copy(ioutil.Discard, os.Stdin)
 			os.Exit(0)
 		}()
@@ -91,9 +91,9 @@ func runDaemonCommand(cmd *cobra.Command, args []string) {
 	logrus.Infof("Starting daemon on TCP port %s", port)
 	lis, err := net.Listen("tcp", fmt.Sprintf(":%s", port))
 	if err != nil {
-		logrus.Fatalf("failed to listen: %v", err)
+		logrus.Fatalf("Failed to listen: %v", err)
 	}
 	if err := s.Serve(lis); err != nil {
-		logrus.Fatalf("failed to serve: %v", err)
+		logrus.Fatalf("Failed to serve: %v", err)
 	}
 }

client_example/main.go

@@ -120,28 +120,28 @@ func main() {
 
 	// Attach a board to a sketch.
 	// Uncomment if you do have an actual board connected.
-	//log.Println("calling BoardAttach(serial:///dev/ttyACM0)")
-	//callBoardAttach(client, instance)
+	// log.Println("calling BoardAttach(serial:///dev/ttyACM0)")
+	// callBoardAttach(client, instance)
 
 	// Compile a sketch
 	log.Println("calling Compile(arduino:samd:mkr1000, VERBOSE, hello.ino)")
 	callCompile(client, instance)
 
 	// Upload a sketch
 	// Uncomment if you do have an actual board connected.
-	//log.Println("calling Upload(arduino:samd:mkr1000, /dev/ttyACM0, VERBOSE, hello.ino)")
-	//callUpload(client, instance)
+	// log.Println("calling Upload(arduino:samd:mkr1000, /dev/ttyACM0, VERBOSE, hello.ino)")
+	// callUpload(client, instance)
 
 	// Debug a sketch on a board
 	// Uncomment if you do have an actual board connected via debug port,
 	// or a board connected to a debugger.
-	//debugClient := dbg.NewDebugClient(conn)
-	//debugStreamingClient, err := debugClient.Debug(context.Background())
-	//if err != nil {
-	//	log.Fatalf("debug steraming open  error: %s\n", err)
-	//}
-	//log.Println("calling Debug(arduino:samd:mkr1000, hello.ino)")
-	//callDebugger(debugStreamingClient, instance)
+	// debugClient := dbg.NewDebugClient(conn)
+	// debugStreamingClient, err := debugClient.Debug(context.Background())
+	// if err != nil {
+	// 	 log.Fatalf("debug steraming open  error: %s\n", err)
+	// }
+	// log.Println("calling Debug(arduino:samd:mkr1000, hello.ino)")
+	// callDebugger(debugStreamingClient, instance)
 
 	// List all boards
 	log.Println("calling BoardListAll(mkr)")
@@ -833,7 +833,7 @@ func callDebugger(debugStreamingOpenClient dbg.Debug_DebugClient, instance *rpc.
 	}
 	// Loop and consume the server stream until all the operations are done.
 	waitForPrompt(debugStreamingOpenClient, "(gdb)")
-	// wait for gdb to init and show the prompt
+	// Wait for gdb to init and show the prompt
 	log.Printf("Send 'info registers' rcommand")
 	err = debugStreamingOpenClient.Send(&dbg.DebugReq{Data: []byte("info registers\n")})
 	if err != nil {

commands/daemon/daemon.go

@@ -127,7 +127,7 @@ func (s *ArduinoCoreServerImpl) Compile(req *rpc.CompileReq, stream rpc.ArduinoC
 		stream.Context(), req,
 		utils.FeedStreamTo(func(data []byte) { stream.Send(&rpc.CompileResp{OutStream: data}) }),
 		utils.FeedStreamTo(func(data []byte) { stream.Send(&rpc.CompileResp{ErrStream: data}) }),
-		false) // set debug to false
+		false) // Set debug to false
 	if err != nil {
 		return err
 	}

commands/daemon/debug.go

@@ -17,6 +17,7 @@ package daemon
 
 import (
 	"fmt"
+
 	"github.com/arduino/arduino-cli/arduino/utils"
 	cmd "github.com/arduino/arduino-cli/commands/debug"
 	dbg "github.com/arduino/arduino-cli/rpc/debug"
@@ -27,22 +28,22 @@ type DebugService struct{}
 
 // Debug returns a stream response that can be used to fetch data from the
 // target. The first message passed through the `Debug` request must
-// contain DebugConfigReq configuration params, not data.
+// contain DebugReq configuration params, not data.
 func (s *DebugService) Debug(stream dbg.Debug_DebugServer) error {
 
-	// grab the first message
+	// Grab the first message
 	msg, err := stream.Recv()
 	if err != nil {
 		return err
 	}
 
-	// ensure it's a config message and not data
+	// Ensure it's a config message and not data
 	req := msg.GetDebugReq()
 	if req == nil {
-		return fmt.Errorf("first message must contain debug request, not data")
+		return fmt.Errorf("First message must contain debug request, not data")
 	}
 
-	// launch debug recipe attaching stdin and out to grpc streaming
+	// Launch debug recipe attaching stdin and out to grpc streaming
 	resp, err := cmd.Debug(stream.Context(), req,
 		utils.ConsumeStreamFrom(func() ([]byte, error) {
 			command, err := stream.Recv()

commands/debug/debug.go

@@ -75,7 +75,7 @@ func Debug(ctx context.Context, req *dbg.DebugConfigReq, inStream io.Reader, out
 	}
 
 	go func() {
-		// copy data from passed inStream into command stdIn
+		// Copy data from passed inStream into command stdIn
 		io.Copy(in, inStream)
 		// In any case, try process termination after a second to avoid leaving
 		// zombie process.

rpc/debug/debug.proto

@@ -58,6 +58,5 @@ message DebugResp {
     string error = 2;
 }
 
-// duplicate from commands/common.proto
-// as module imports seems not to work
+// TODO remove this in next proto refactoring because is a duplicate from commands/common.proto
 message Instance { int32 id = 1; }