Documentation | Document code formatter. (#33)

[Amar Takhar (@amar)]

Amar Takhar created an issue: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/33



@gedare has worked quite hard to provide an excellent RTEMS-style formatting tool using Clang-Format.

Some of this initial work can be seen in https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/238 and https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/237

We need to document:

1. How the tool is used.
   1. @chris  has suggested we create some new commands `waf format` and `waf format-check` to handle running the tool.
2. What rules we apply when deciding to turn formatting off for a code block.
3. What files the formatter is run on.  @joel has suggested we disable it for inline ASM heavy files but maybe we can get away with disabling blocks.
   1. Disabled files should be disabled at the top of the file so there is awareness the files are not auto-formatted and it simplifies that we can just run the tool over all source.

The second point above is mostly what this issue is about.

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/33
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/20240925/06f96bdc/attachment-0001.htm>