[gnome-todo] docs: Update HACKING
- From: Georges Basile Stavracas Neto <gbsneto src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-todo] docs: Update HACKING
- Date: Mon, 11 Jun 2018 16:17:30 +0000 (UTC)
commit 3a375c5f9fed4768b6af734c145599633e31edfb
Author: Georges Basile Stavracas Neto <georges stavracas gmail com>
Date: Mon Jun 11 13:16:30 2018 -0300
docs: Update HACKING
Add more explicitness to the rules.
doc/HACKING.md | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
---
diff --git a/doc/HACKING.md b/doc/HACKING.md
index 3096feb..8c25c4d 100644
--- a/doc/HACKING.md
+++ b/doc/HACKING.md
@@ -7,6 +7,8 @@ rules. Please read them carefully and, if in doubt, ask a maintainer for directi
The most important rule is: **see the surrounding code, and copy its style**.
+GNOME To Do's line length is 120 columns.
+
Another rule that applies to function declarations is that all parameters are
aligned by the last '*'. There are plenty of examples below.
@@ -81,13 +83,13 @@ do_something_on_data (Foo *data,
### Signal Callbacks
Signal callback names must have the name of the signal in the past. They **don't** have
-the `gtd_class_name` prefix as well, but have a `_cb` suffix. For example:
+the `gtd_class_name` prefix as well, but have a `on_` prefix and `_cb` suffix. For example:
```c
static void
-size_allocated_cb (GtkWidget *widget,
- GtkAllocation *allocation,
- gpointer user_data)
+on_size_allocated_cb (GtkWidget *widget,
+ GtkAllocation *allocation,
+ gpointer user_data)
{
/* ... */
}
@@ -95,6 +97,8 @@ size_allocated_cb (GtkWidget *widget,
### Line Splitting
+GNOME To Do's line length is 120 columns.
+
Line splitting works following the GTK code style, but legibility comes over above
all. If a function call looks unbalanced following the GTK style, it is fine to
slightly escape the rules.
@@ -116,7 +120,7 @@ comparison, it will look better if written like this:
```c
foo_bar_do_somthing_sync (a, 1, object, data,
- something
+ something,
cancellable,
&error);
```
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]