You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2021/09/07 20:24:14 UTC

[GitHub] [incubator-nuttx] acassis opened a new pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

acassis opened a new pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494


   ## Summary
   Other RTOSes like FreeRTOS, RIOT, etc use "make flash" to flash the firmware.
   Adopting the same standard will make the transition easier.
   ## Impact
   Users will be a known command to flash the firmware
   ## Testing
   esp32-devkit
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] acassis commented on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
acassis commented on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-915203949


   > > > Is there any reason for not just `FLASH` instead of `FLASHCMD`?
   > > > If there is no impediment, for consistency to the other Makefile functions, I believe it should be changed to just `FLASH`.
   > > 
   > > 
   > > Yes, to avoid issue with other use of the word FLASH. Please keep it as FLASHCMD, it is clear and will avoid people thinking it is the flash device.
   > 
   > `FLASH` is a make function, there is no reason for one to confuse it with a flash device.
   
   git grep FLASH
   
   Please let keep it as FLASHCMD


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] nandojve commented on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
nandojve commented on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-915600332


   Just curious, what FLASHCMD will be?
   I mean, from an outsider perspective, I should expect that FLASHCMD have the whole "command" that will be executed when user type `> make flash`. Is that correct?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] acassis commented on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
acassis commented on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-915601526


   > Just curious, what FLASHCMD will be?
   > I mean, from an outsider perspective, I should expect that FLASHCMD have the whole "command" that will be executed when user type `> make flash`. Is that correct?
   
   Yes, FLASHCMD will be the command to be executed, i.e. for STM32:
   
   ```
   st-flash write nuttx.bin 0x8000000
   ```


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] acassis commented on a change in pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
acassis commented on a change in pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#discussion_r703812503



##########
File path: README.md
##########
@@ -1546,12 +1546,12 @@ build directory.
     build. (2) The logic in tools/mkexport.sh only supports GCC and, for example,
     explicitly assumes that the archiver is 'ar'
 
-  * `download`
+  * `flash` (or `download` : DEPRECATED)
 
     This is a helper target that will rebuild NuttX and download it to the target
     system in one step.  The operation of this target depends completely upon
-    implementation of the DOWNLOAD command in the user Make.defs file.  It will
-    generate an error an error if the DOWNLOAD command is not defined.
+    implementation of the FLASHCMD command in the user Make.defs file.  It will
+    generate an error an error if the FLASHCMD command is not defined.

Review comment:
       Fixed! Thanks!

##########
File path: tools/Makefile.win
##########
@@ -408,15 +408,18 @@ ifeq ($(CONFIG_RAW_BINARY),y)
 endif
 	$(call POSTBUILD, $(TOPDIR))
 
-# download
+# flash (or download : DEPRECATED)
 #
 # This is a helper target that will rebuild NuttX and download it to the target
 # system in one step.  The operation of this target depends completely upon
-# implementation of the DOWNLOAD command in the user Make.defs file.  It will
-# generate an error an error if the DOWNLOAD command is not defined.
+# implementation of the FLASHCMD command in the user Make.defs file.  It will
+# generate an error an error if the FLASHCMD command is not defined.

Review comment:
       Fixed! Thanks!




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] saramonteiro commented on a change in pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
saramonteiro commented on a change in pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#discussion_r703811963



##########
File path: tools/Makefile.win
##########
@@ -408,15 +408,18 @@ ifeq ($(CONFIG_RAW_BINARY),y)
 endif
 	$(call POSTBUILD, $(TOPDIR))
 
-# download
+# flash (or download : DEPRECATED)
 #
 # This is a helper target that will rebuild NuttX and download it to the target
 # system in one step.  The operation of this target depends completely upon
-# implementation of the DOWNLOAD command in the user Make.defs file.  It will
-# generate an error an error if the DOWNLOAD command is not defined.
+# implementation of the FLASHCMD command in the user Make.defs file.  It will
+# generate an error an error if the FLASHCMD command is not defined.

Review comment:
       ```suggestion
   # generate an error if the FLASHCMD command is not defined.
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] saramonteiro commented on a change in pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
saramonteiro commented on a change in pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#discussion_r703810867



##########
File path: README.md
##########
@@ -1546,12 +1546,12 @@ build directory.
     build. (2) The logic in tools/mkexport.sh only supports GCC and, for example,
     explicitly assumes that the archiver is 'ar'
 
-  * `download`
+  * `flash` (or `download` : DEPRECATED)
 
     This is a helper target that will rebuild NuttX and download it to the target
     system in one step.  The operation of this target depends completely upon
-    implementation of the DOWNLOAD command in the user Make.defs file.  It will
-    generate an error an error if the DOWNLOAD command is not defined.
+    implementation of the FLASHCMD command in the user Make.defs file.  It will
+    generate an error an error if the FLASHCMD command is not defined.

Review comment:
       ```suggestion
       generate an error if the FLASHCMD command is not defined.
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] gustavonihei edited a comment on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
gustavonihei edited a comment on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-914857551


   Is there any reason for not just `FLASH` instead of `FLASHCMD`?
   If there is no impediment, for consistency to the other Makefile functions, I believe it should be changed to just `FLASH`.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] gustavonihei commented on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
gustavonihei commented on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-915566028


   > > > > Is there any reason for not just `FLASH` instead of `FLASHCMD`?
   > > > > If there is no impediment, for consistency to the other Makefile functions, I believe it should be changed to just `FLASH`.
   > > > 
   > > > 
   > > > Yes, to avoid issue with other use of the word FLASH. Please keep it as FLASHCMD, it is clear and will avoid people thinking it is the flash device.
   > > 
   > > 
   > > `FLASH` is a make function, there is no reason for one to confuse it with a flash device.
   > 
   > git grep FLASH
   
   This is a very weak motivation for giving up consistency.
   Every make function in the NuttX build system is named after an action or verb:
   `PREPROCESS`, `COMPILE`, `ASSEMBLE`, `CLEAN`, `DOWNLOAD`.
   So I suggest we follow the current naming approach.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] gustavonihei edited a comment on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
gustavonihei edited a comment on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-915566028






-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] gustavonihei commented on a change in pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
gustavonihei commented on a change in pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#discussion_r703954708



##########
File path: tools/esp32/Config.mk
##########
@@ -147,12 +147,12 @@ endif
 
 ESPTOOL_BAUD ?= 921600
 
-# DOWNLOAD -- Download binary image via esptool.py
+# FLASHCMD -- Upload a binary image via esptool.py

Review comment:
       ````suggestion
   # FLASHCMD -- Download a binary image via esptool.py
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] gustavonihei commented on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
gustavonihei commented on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-915193031


   > > Is there any reason for not just `FLASH` instead of `FLASHCMD`?
   > > If there is no impediment, for consistency to the other Makefile functions, I believe it should be changed to just `FLASH`.
   > 
   > Yes, to avoid issue with other use of the word FLASH. Please keep it as FLASHCMD, it is clear and will avoid people thinking it is the flash device.
   
   `FLASH` is a make function, there is no reason for one to confuse it with a flash device.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] acassis commented on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
acassis commented on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-915583568


   > > > > > Is there any reason for not just `FLASH` instead of `FLASHCMD`?
   > > > > > If there is no impediment, for consistency to the other Makefile functions, I believe it should be changed to just `FLASH`.
   > > > > 
   > > > > 
   > > > > Yes, to avoid issue with other use of the word FLASH. Please keep it as FLASHCMD, it is clear and will avoid people thinking it is the flash device.
   > > > 
   > > > 
   > > > `FLASH` is a make function, there is no reason for one to confuse it with a flash device.
   > > 
   > > 
   > > git grep FLASH
   > 
   > This is a very weak motivation for giving up consistency.
   > Every Make function in the NuttX build system is named after an action or verb:
   > `PREPROCESS`, `COMPILE`, `ASSEMBLE`, `CLEAN`, `DOWNLOAD`...
   > So I suggest we follow the current naming approach.
   
   Ok, let me explain: when I'm searching for a symbol inside the building system, it is better to have a unique name that I could find it easily. Searching for FLASH will return a ton of similar symbols. Using FLASHCMD instead just FLASH is better to fix it.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] acassis edited a comment on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
acassis edited a comment on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-915601526


   > Just curious, what FLASHCMD will be?
   > I mean, from an outsider perspective, I should expect that FLASHCMD have the whole "command" that will be executed when user type `> make flash`. Is that correct?
   
   Yes, FLASHCMD will be the command to be executed, i.e. for STM32 on Windows:
   
   ```
   st-flash write nuttx.bin 0x8000000
   ```


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] gustavonihei commented on a change in pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
gustavonihei commented on a change in pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#discussion_r703954708



##########
File path: tools/esp32/Config.mk
##########
@@ -147,12 +147,12 @@ endif
 
 ESPTOOL_BAUD ?= 921600
 
-# DOWNLOAD -- Download binary image via esptool.py
+# FLASHCMD -- Upload a binary image via esptool.py

Review comment:
       ````suggestion
   # FLASHCMD -- Download a binary image via esptool.py
   ```
   According to the Embedded Systems Dictionary, by Jack Ganssle, `download` is the defined convention for "moving data or code into a target's memory over a communications channel such as a serial port".




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] acassis commented on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
acassis commented on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-914789661


   > `Upload` term incorrectly used according to the literature.
   
   Fixed


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] acassis commented on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
acassis commented on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-915188348


   > Is there any reason for not just `FLASH` instead of `FLASHCMD`?
   > If there is no impediment, for consistency to the other Makefile functions, I believe it should be changed to just `FLASH`.
   
   Yes, to avoid issue with other use of the word FLASH. Please keep it as FLASHCMD, it is clear and will avoid people thinking it is the flash device.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] gustavonihei commented on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
gustavonihei commented on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-914857551


   Is there any reason for not just `FLASH` instead of `FLASHCMD`?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] xiaoxiang781216 commented on pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
xiaoxiang781216 commented on pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#issuecomment-927091670


   @acassis the patch need rebase to fix the conflict.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] gustavonihei commented on a change in pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
gustavonihei commented on a change in pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#discussion_r703954969



##########
File path: tools/esp32/Config.mk
##########
@@ -147,12 +147,12 @@ endif
 
 ESPTOOL_BAUD ?= 921600
 
-# DOWNLOAD -- Download binary image via esptool.py
+# FLASHCMD -- Upload a binary image via esptool.py

Review comment:
       ```suggestion
   # FLASHCMD -- Download a binary image via esptool.py
   ```
   According to the Embedded Systems Dictionary, by Jack Ganssle and Michael Barr, `download` is the defined convention for "moving data or code into a target's memory over a communications channel such as a serial port".




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [incubator-nuttx] gustavonihei commented on a change in pull request #4494: build: Replace 'make download' with 'make flash', but keep both for now

Posted by GitBox <gi...@apache.org>.
gustavonihei commented on a change in pull request #4494:
URL: https://github.com/apache/incubator-nuttx/pull/4494#discussion_r703954969



##########
File path: tools/esp32/Config.mk
##########
@@ -147,12 +147,12 @@ endif
 
 ESPTOOL_BAUD ?= 921600
 
-# DOWNLOAD -- Download binary image via esptool.py
+# FLASHCMD -- Upload a binary image via esptool.py

Review comment:
       ```suggestion
   # FLASHCMD -- Download a binary image via esptool.py
   ```
   According to the Embedded Systems Dictionary, by Jack Ganssle, `download` is the defined convention for "moving data or code into a target's memory over a communications channel such as a serial port".

##########
File path: tools/esp32c3/Config.mk
##########
@@ -92,15 +92,15 @@ endef
 
 ESPTOOL_BAUD ?= 921600
 
-# DOWNLOAD -- Download binary image via esptool.py
+# FLASHCMD -- Upload a binary image via esptool.py

Review comment:
       ```suggestion
   # FLASHCMD -- Download a binary image via esptool.py
   ```

##########
File path: tools/esp32s2/Config.mk
##########
@@ -92,15 +92,15 @@ endef
 
 ESPTOOL_BAUD ?= 921600
 
-# DOWNLOAD -- Download binary image via esptool.py
+# FLASHCMD -- Upload a binary image via esptool.py

Review comment:
       ```suggestion
   # FLASHCMD -- Download a binary image via esptool.py
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org