RTEMS Tools | misc/bin2c/rtems-bin2c.c: Add feature to include license header in generated C files (!58)

[Christian Mauderer (@c-mauderer)]

Christian Mauderer commented on a discussion on misc/bin2c/rtems-bin2c.c: https://gitlab.rtems.org/rtems/tools/rtems-tools/-/merge_requests/58#note_121668

 >   *
 >   * Subsequently modified by Joel Sherrill <joel.sherrill at oarcorp.com>
 >   * to add a number of capabilities not in the original.
 > + * 
 > + * Modified by Harinder Singh Dhanoa <hsd1807 at proton.me>
 > + * to add the feature to include license file support and a default BSD-2-Clause license header.
 >   *
 >   * syntax:  bin2c [-c] [-z] <input_file> <output_file>

I'm not a fan of duplication, but it's already there. So of course you can update it if you prefer that solution.

My personal approach would be to just remove the text. Someone who wants to only use the tool should call the tool with `-h` to get help or take a look at the RTEMS documentation (if it is documented there - not entirely sure). And someone who edits the code should be able to find and read the help text string in the code. So the help text in the comment is not useful in my opinion. But like I said: Personal opinion. I'm also OK if you want to update the text.

So for your original question: Yes, either update the line or remove the text entirely. Whatever you think is better.

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/tools/rtems-tools/-/merge_requests/58#note_121668
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20250324/5de76ab1/attachment-0001.htm>