<div dir="ltr">Thanks for the feedback. I've now put <a href="https://reviews.llvm.org/D76833">https://reviews.llvm.org/D76833</a> up for review.<br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, 24 Mar 2020 at 12:57, Hubert Tong <<a href="mailto:hubert.reinterpretcast@gmail.com">hubert.reinterpretcast@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Mon, Mar 23, 2020 at 11:54 AM James Henderson via llvm-dev <<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div>Hi all,</div><div><br></div><div>This came up in a recent review. There is currently no documented style for how to write error messages. For example, should they start with a capital letter or end in a full stop?</div></div></blockquote><div>The policy should also mention use of other end-of-sentence punctuation. Also, for multi-sentence messages like "err_drv_trivial_auto_var_init_zero_disabled".</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div>Consequently, there's quite a bit of inconsistency in our diagnostics throughout the code base.</div><div><br></div><div>clang typically emits error messages with no leading capital letter and no trailing full stop. For example:</div><div><br></div><div>C:\>clang<br></div><div>"clang: error: no input files"</div><div><br></div><div>I have suggested this approach be followed in many different reviews, primarily in the LLVM equivalents of the GNU binutils that I typically work on. I'd like to propose that this be followed more widely too, and documented in the coding standards as such. Note, I am not proposing changing existing error messages as part of this. Do people agree with this proposal? If not, what would you prefer to see?<br></div><div><br></div><div>As well as "regular" errors you'll see in typical usage, there are 3 other kinds of errors that are widely used, with the following output styles:</div><div><br></div><div>Assertion failures:</div><div><br></div><div>Assertion failed: false && "this is the message", file <filepath><br></div><div><br></div><div>llvm_unreachable failures:</div><div><br></div><div>this is the message<br>UNREACHABLE executed at <filepath></div></div></blockquote><div>I understand the proposal is not meant to cover llvm_unreachable; however, I do want to point out that the non-full-stop and lowercase style in this output format made the message completely unnoticeable for me. A bit less so for the assertion failure output.<br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div><br></div><div>report_fatal_error failures:</div><div><br></div><div>LLVM ERROR: this is the message</div><div><br></div><div>Looking at the existing output, and how they are used, I think llvm_unreachable and assertions do not need standardising, since they are purely for internal usage, whilst report_fatal_error should be standardised to the same as other normal errors (i.e. lower-case first letter, trailing full stop).</div></div></blockquote><div>I believe that the document would clearly indicate that the appearance of the output differs for llvm_unreachable and assertions, making it so that the guidance may not be suitable for those cases (and thus it does not apply in those cases).<br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div><br></div><div>What do people think?</div><div><br></div><div>James<br></div></div>
_______________________________________________<br>
LLVM Developers mailing list<br>
<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a><br>
<a href="https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev" rel="noreferrer" target="_blank">https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev</a><br>
</blockquote></div></div>
</blockquote></div>