You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by "jerpelea (via GitHub)" <gi...@apache.org> on 2024/07/24 07:30:54 UTC

[PR] doc: improve commit log examples [nuttx]

jerpelea opened a new pull request, #12756:
URL: https://github.com/apache/nuttx/pull/12756

   ## Summary
   The releasenotes tools can use proper commit titles and automate commit sorting
   
   ## Impact
   DOC
   
   ## Testing
   NONE
   


-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "acassis (via GitHub)" <gi...@apache.org>.
acassis commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689506787


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   Why to avoid using complete path? Because the git log title is just 50 chars long, if we force a long prefix  there won't be enough space for info in the title.



-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "acassis (via GitHub)" <gi...@apache.org>.
acassis commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689490628


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   @jerpelea Thank you for improvements, some small consideration:
   
   Normally the comments after board doesn't include the complete path, it is usually: boards/<boardname> as you can find in our git log history.
   
   Also I think it is important to show a "real" example with a board name, so maybe include the information that should be "boards/<boardname>  and then show the example as it was initially.



-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "jerpelea (via GitHub)" <gi...@apache.org>.
jerpelea commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689628271


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   we should be careful not to merge PRS that contain both arch, board, drivers and fixes commits
   ex:
   add new xxx board 
   
   modify arch to support board
   add initial board support
   add xxx driver for the board
   fix crash during boot



-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "jerpelea (via GitHub)" <gi...@apache.org>.
jerpelea commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689596784


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   @acassis 
   We need the complete path to be able to sort the commits for the release
   board/architecture/platform/board_name
   arch/architecture/platform
   
   the minimum that we can use (will not be optimal) is:
   board/architecture/board_name
   
   Without those changes sorting can not be optimised



-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "jerpelea (via GitHub)" <gi...@apache.org>.
jerpelea commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689596784


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   @acassis 
   We need the complete path to be able to sort the commits for the release
   board/architecture/platform/board_name
   arch/architecture/platform
   Without those changes sorting can not be optimised



-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "jerpelea (via GitHub)" <gi...@apache.org>.
jerpelea commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689624214


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   this will make things easy if we properly review



-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "xiaoxiang781216 (via GitHub)" <gi...@apache.org>.
xiaoxiang781216 merged PR #12756:
URL: https://github.com/apache/nuttx/pull/12756


-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "acassis (via GitHub)" <gi...@apache.org>.
acassis commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689490628


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   @jerpelea Thank you for improvements, some small consideration:
   
   Normally the comments after board doesn't include the complete path, it is usually: boards/\<boardname\> as you can find in our git log history.
   
   Also I think it is important to show a "real" example with a board name, so maybe include the information that should be "boards/<boardname>  and then show the example as it was initially.



-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "acassis (via GitHub)" <gi...@apache.org>.
acassis commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689490628


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   @jerpelea Thank you for improvements, some small consideration:
   
   Normally the comments after board doesn't include the complete path, it is usually: boards/\<boardname\> as you can find in our git log history.
   
   Also I think it is important to show a "real" example with a board name, so maybe include the information that should be "boards/\<boardname\>  and then show the example as it was initially.



-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "acassis (via GitHub)" <gi...@apache.org>.
acassis commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689615204


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   @jerpelea isn't the board unique for each architecture/platform? It is possible to retrieve the arch and plat from the board name.
   
   Maybe we can follow Linux:
   https://github.com/torvalds/linux/commits/master/arch/arm/configs/aspeed_g5_defconfig?after=786c8248dbd33a5a7a07f7c6e55a7bfc68d2ca48+34
   
   Instead of using boards/boardname, we can just use: \<arch\>/\<boardname\>:



-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "acassis (via GitHub)" <gi...@apache.org>.
acassis commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689615204


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   @jerpelea isn't the board unique for each architecture/platform? It is possible to retrieve the arch and plat from the board name.
   
   Maybe we can follow Linux:
   https://github.com/torvalds/linux/commits/master/arch/arm/configs/aspeed_g5_defconfig?after=786c8248dbd33a5a7a07f7c6e55a7bfc68d2ca48+34
   
   Instead of using boards/boardname, use just use: \<arch\>/\<boardname\>:



-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "acassis (via GitHub)" <gi...@apache.org>.
acassis commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689506787


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   Why to avoid using complete path? Because the git log title is just 50 chars long, if we force a long prefix there will not enough space for info in the title.



-- 
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


Re: [PR] doc: improve commit log examples [nuttx]

Posted by "jerpelea (via GitHub)" <gi...@apache.org>.
jerpelea commented on code in PR #12756:
URL: https://github.com/apache/nuttx/pull/12756#discussion_r1689596784


##########
Documentation/contributing/making-changes.rst:
##########
@@ -211,15 +211,28 @@ squash before submitting the Pull Request:
    In the commit title please include the subsystem/area related to your contribution,
    followed by a descriptive message. Some examples:
 
+    Adding or fixing a platform
+
+    .. code-block:: bash
+
+       arch/<arch>/<platform>/: Add arch support for xxxxx platform
+
+       This patch adds initial support for xxxx platform. Please read
+       the documentation included for more details how to wire the display.
+
+       Signed-off-by: Your Name <yo...@whoareyou.com>
+
+    Adding or fixing a board
+
     .. code-block:: bash
 
-       boards/stm32f4discover: Add board initialization for SSD1306 OLED Display
+       boards/<arch>/<platform>/<board>: Add board initialization for SSD1306 OLED Display

Review Comment:
   @acassis 
   We need the complete path to be able to sort the commits for the release
   board/architecture/platform/board_name
   arch/architecture/platform
   
   The minimum that we can use (will not be optimal) is:
   board/architecture/board_name
   
   Without those changes sorting can not be optimized



-- 
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