/usr/share/doc/latexila/HACKING is in latexila 3.22.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 | Guidelines for LaTeXila
=======================
LaTeXila source code is maintained using the Git version control system and is
available at the following location:
git://git.gnome.org/latexila
A web interface is available at:
http://git.gnome.org/browse/latexila
You can download the source code from the Git repository by doing:
$ git clone git://git.gnome.org/latexila
Later, to take the new commits you just have to do:
$ git pull
An easy way to build LaTeXila and its dependencies is to use jhbuild
(gnome-world moduleset). Example of a jhbuildrc file for LaTeXila:
https://people.gnome.org/~swilmet/latexila/jhbuildrc
Commits
=======
To create a patch, make first one or several commits (in another branch) and
then use the 'git format-patch' command. You can submit your patch to the
GNOME bugzilla.
A GitHub repository is available, so you can fork it easily:
https://github.com/GNOME/latexila
Git commits should have maximum 72 characters for the first line, followed by a
blank line and then a longer description.
Code conventions
================
For consistency, there are some conventions to follow when coding.
For Vala and C:
- no trailing spaces
- use blank lines to space out blocks of code (only one blank line is enough).
- space out each case in a switch, i.e. have a blank line after each 'break;'.
- as a general rule of thumb, when modifying a file use the same coding
style of that file.
For Vala:
- indentation: 4 spaces
- lines: 90 characters maximum (in some cases it can be a little more)
- /* ... */ comments for delimiting code sections
- // ... comments otherwise (e.g. for explaining just one line)
- curly braces are always on a separate line
- for one-line blocks (if, for, while, etc), no curly braces
- some spaces almost everywhere:
- function (blah); // not function(blah);
- int num = 5; // not int num=5;
- if (! foo) // not if (!foo)
- for (int i = 0 ; i < max ; i++) // not for(int i=0;i<max;i++)
- etc...
- do not use 'var' for declaring variables, unless the type is very long.
The type of a variable is a form of self-documentation.
For C:
- follow the GNU coding style:
https://developer.gnome.org/programming-guidelines/stable/c-coding-style.html.en
- no maximum line length (but short lines are better)
- only /* ... */ comments (for C89 compatibility)
- spacing differences with Vala:
- if (!foo)
- for (int i = 0; i < max; i++)
Debug
=====
How to debug LaTeXila with gdb?
Build LaTeXila with the option -g in the CFLAGS.
Here is how you can get the backtrace after a crash:
$ gdb latexila
> run
[segmentation fault]
> backtrace
> quit
|