X-Git-Url: http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=blobdiff_plain;f=CODING.md;h=7a517e91f504e431b320632d781808ac608ce431;hp=971b6a9b91422d6a42919e836568f6249fd48d03;hb=refs%2Fheads%2Fmaster;hpb=7e49584732934d26c0e36145895900ec09e44cd5 diff --git a/CODING.md b/CODING.md index 971b6a9b..4f4d492f 100644 --- a/CODING.md +++ b/CODING.md @@ -42,6 +42,22 @@ For use with the [GTKInspector](https://wiki.gnome.org/action/show/Projects/GTK/ Sample command line call: `GTK_DEBUG=interactive src/geeqie` +### DEBUG_BT() + +Prints a backtrace. +Use only for temporary debugging i.e. not in code in the repository + +### DEBUG_FD() + +Prints a dump of the FileData hash list as a ref. count followed by the full path of the item. +Use only for temporary debugging i.e. not in code in the repository + +### Log Window + +When the Log Window has focus, the F1 key executes the action specified in `Edit/Preferences/Behavior/Log Window F1 Command` with the selected text as a parameter. +If no text is selected, the entire line is passed to the command. +This feature may be used to open an editor at a file location in the text string. + --- ## GPL header @@ -187,6 +203,8 @@ Headers: #ifndef _FILENAME_H ``` +Use [Names and Order of Includes](https://google.github.io/styleguide/cppguide.html#Names_and_Order_of_Includes) for headers include order. + Use spaces around every operator (except `.`, `->`, `++` and `--`). Unary operator `*` and `&` are missing the space from right, (and also unary `-`). @@ -198,7 +216,6 @@ Variables declarations should be followed by a blank line and should always be a Use glib types when possible (ie. gint and gchar instead of int and char). Use glib functions when possible (i.e. `g_ascii_isspace()` instead of `isspace()`). Check if used functions are not deprecated. -Use UNUSED() for unused function parameters. --- @@ -220,6 +237,7 @@ mktemp "${TMPDIR:-/tmp}/geeqie.XXXXXXXXXX" ``` --- + ## External Software Tools ### astyle