[PATCH] D76833: [CodingStandards] Document coding standard for error and warning messages

Reid Kleckner via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Mon Mar 30 12:30:27 PDT 2020


rnk accepted this revision.
rnk added inline comments.


================
Comment at: llvm/docs/CodingStandards.rst:338
+
+  error: file.o: section header 3 is corrupt. Size is 10 when it should be 20
+
----------------
If you look at clang diagnostics, I think most of the time we would use a semicolon to separate sentences here, so it would look like this:
  error: file.o: section header 3 is corrupt; size is 10 when it should be 20

However, overall this is useful guidance, and if you want to leave this example as is for migrating existing multi-sentence diagnostics, that's OK with me.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D76833/new/

https://reviews.llvm.org/D76833





More information about the llvm-commits mailing list