]> git.lttng.org Git - lttng-tools.git/commitdiff
Docs: CodingStyle: Move error management guidelines to separate section
authorErica Bugden <ebugden@efficios.com>
Mon, 8 Jul 2024 18:20:32 +0000 (14:20 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Tue, 7 Jan 2025 20:48:37 +0000 (20:48 +0000)
Move error management guidelines to separate section to group and highlight
them in the coding style.

Change-Id: I0d0ba0f8ea8a4c74c73bb28217a81b4efeb9a35f
Signed-off-by: Erica Bugden <ebugden@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
CodingStyle.md

index 19388087902e9386b84fb43a0841b02dc93b13d0..967fbf106da4ce5d914e5acf1e4c75244343720b 100644 (file)
@@ -141,6 +141,17 @@ ffc::grapefruit::grapefruit()
 }
 ```
 
+### Error management
+
+* Use RAII wrappers when managing system resources or interacting with C libraries.
+
+  In other words, don't rely on ``goto``s and error labels to clean up as you would do in C.
+
+* Throw an exception when there's an unexpected, exceptional condition,
+  [including from a constructor](https://isocpp.org/wiki/faq/exceptions#ctors-can-throw), instead of returning a status code.
+
+  However, be mindful of the exception-safety of your users. For instance, `liblttng-ctl` exposes a C interface meaning that is must catch and handle all exceptions, most likely by returning a suitable error code.
+
 ### File layout example
 
 ```cpp
@@ -252,15 +263,6 @@ Here are a couple of reminders:
 
   For example, use `|` as a bitwise or logical-or, not as a shell-style pipe.
 
-* Use RAII wrappers when managing system resources or interacting with C libraries.
-
-  In other words, don't rely on ``goto``s and error labels to clean up as you would do in C.
-
-* Throw an exception when there's an unexpected, exceptional condition,
-  [including from a constructor](https://isocpp.org/wiki/faq/exceptions#ctors-can-throw), instead of returning a status code.
-
-  However, be mindful of the exception-safety of your users. For instance, `liblttng-ctl` exposes a C interface meaning that is must catch and handle all exceptions, most likely by returning a suitable error code.
-
 * Accept a by-value parameter and move it (when it's moveable) when you intend to copy it anyway. You can do this with most STL containers.
 
 ## Python
This page took 0.029289 seconds and 4 git commands to generate.