<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html lang="en" style='--code-editor-font: var(--default-mono-font, "GitLab Mono"), JetBrains Mono, Menlo, DejaVu Sans Mono, Liberation Mono, Consolas, Ubuntu Mono, Courier New, andale mono, lucida console, monospace;'>
<head>
<meta content="text/html; charset=US-ASCII" http-equiv="Content-Type">
<title>
GitLab
</title>
<style data-premailer="ignore" type="text/css">
a { color: #1068bf; }
</style>
<style>img {
max-width: 100%; height: auto;
}
body {
font-size: .875rem;
}
body {
-webkit-text-shadow: rgba(255,255,255,.01) 0 0 1px;
}
body {
font-family: "GitLab Sans",-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Noto Sans",Ubuntu,Cantarell,"Helvetica Neue",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji"; font-size: inherit;
}
</style>
</head>
<body style='font-size: inherit; -webkit-text-shadow: rgba(255,255,255,.01) 0 0 1px; font-family: "GitLab Sans",-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Noto Sans",Ubuntu,Cantarell,"Helvetica Neue",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";'>
<div class="content">
<p class="details" style="font-style: italic; color: #737278;">
<a href="https://gitlab.rtems.org/amar">Amar Takhar</a> created an issue: <a href="https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/33">#33</a>
</p>
<div class="md" style="position: relative; z-index: 1; color: #28272d; word-wrap: break-word;">
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial"><a href="https://gitlab.rtems.org/gedare" data-reference-type="user" data-user="8" data-container="body" data-placement="top" class="gfm gfm-project_member js-user-link" title="Gedare Bloom" style="background-color: #cbe2f9; border-radius: .25rem; color: #0b5cad; margin-top: 0; padding: 0 2px;">@gedare</a> has worked quite hard to provide an excellent RTEMS-style formatting tool using Clang-Format.</p>
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial">Some of this initial work can be seen in <a href="https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/238" data-reference-type="merge_request" data-original="https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/238" data-link="false" data-link-reference="true" data-merge-request="436" data-project="26" data-project-path="rtems/rtos/rtems" data-iid="238" data-container="body" data-placement="top" title="Reformat cpukit score src thread" class="gfm gfm-merge_request" style="margin-top: 0;">rtems/rtos/rtems!238</a> and <a href="https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/237" data-reference-type="merge_request" data-original="https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/237" data-link="false" data-link-reference="true" data-merge-request="435" data-project="26" data-project-path="rtems/rtos/rtems" data-iid="237" data-container="body" data-placement="top" title="Reformat cpukit rtems src" class="gfm gfm-merge_request">rtems/rtos/rtems!237</a></p>
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial">We need to document:</p>
<ol dir="auto" style="text-align: initial; margin: 0 0 16px; padding: 0;">
<li style="margin-top: 0; line-height: 1.6em; margin-left: 25px; padding-left: 3px;">How the tool is used.
<ol style="margin: 0; padding: 0;">
<li style="margin-top: 0; line-height: 1.6em; margin-left: 25px; padding-left: 3px;">
<a href="https://gitlab.rtems.org/chris" data-reference-type="user" data-user="3" data-container="body" data-placement="top" class="gfm gfm-project_member js-user-link" title="Chris Johns" style="background-color: #cbe2f9; border-radius: .25rem; color: #0b5cad; margin-top: 0; padding: 0 2px;">@chris</a> has suggested we create some new commands <code style='font-size: 90%; color: #18171d; word-wrap: break-word; background-color: #ececef; border-radius: .25rem; font-family: "GitLab Mono","JetBrains Mono","Menlo","DejaVu Sans Mono","Liberation Mono","Consolas","Ubuntu Mono","Courier New","andale mono","lucida console",monospace; vertical-align: bottom; white-space: pre-wrap; overflow-wrap: break-word; word-break: keep-all; padding: 2px 4px;'>waf format</code> and <code style='font-size: 90%; color: #18171d; word-wrap: break-word; background-color: #ececef; border-radius: .25rem; font-family: "GitLab Mono","JetBrains Mono","Menlo","DejaVu Sans Mono","Liberation Mono","Consolas","Ubuntu Mono","Courier New","andale mono","lucida console",monospace; vertical-align: bottom; white-space: pre-wrap; overflow-wrap: break-word; word-break: keep-all; padding: 2px 4px;'>waf format-check</code> to handle running the tool.</li>
</ol>
</li>
<li style="line-height: 1.6em; margin-left: 25px; padding-left: 3px;">What rules we apply when deciding to turn formatting off for a code block.</li>
<li style="line-height: 1.6em; margin-left: 25px; padding-left: 3px;">What files the formatter is run on. <a href="https://gitlab.rtems.org/joel" data-reference-type="user" data-user="7" data-container="body" data-placement="top" class="gfm gfm-project_member js-user-link" title="Joel Sherrill" style="background-color: #cbe2f9; border-radius: .25rem; color: #0b5cad; margin-top: 0; padding: 0 2px;">@joel</a> has suggested we disable it for inline ASM heavy files but maybe we can get away with disabling blocks.
<ol style="margin: 0; padding: 0;">
<li style="margin-top: 0; line-height: 1.6em; margin-left: 25px; padding-left: 3px;">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.</li>
</ol>
</li>
</ol>
<p dir="auto" style="color: #28272d; margin: 0;" align="initial">The second point above is mostly what this issue is about.</p>
</div>
</div>
<div class="footer" style="margin-top: 10px;">
<p style="font-size: small; color: #737278;">
—
<br>
<a href="https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/33">View it on GitLab</a>.
<br>
You're receiving this email because of your account on <a target="_blank" rel="noopener noreferrer" href="https://gitlab.rtems.org">gitlab.rtems.org</a>. <a href="https://gitlab.rtems.org/-/sent_notifications/e19867a4486c1df82b7d62b93a6b8f05/unsubscribe" target="_blank" rel="noopener noreferrer">Unsubscribe</a> from this thread · <a href="https://gitlab.rtems.org/-/profile/notifications" target="_blank" rel="noopener noreferrer" class="mng-notif-link">Manage all notifications</a> · <a href="https://gitlab.rtems.org/help" target="_blank" rel="noopener noreferrer" class="help-link">Help</a>
<script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","action":{"@type":"ViewAction","name":"View Issue","url":"https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/33"}}</script>
</p>
</div>
</body>
</html>