procyberian/gimp
2
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/gimp.git synced 2025-07-04 09:53:25 +00:00
Code Issues 1 Projects 1 Releases Packages Wiki Activity Actions

HACKING: some update on coding style and other.

Browse source 
Add in particular some notes about alignments and trailing whitespaces.
This commit is contained in:
Jehan 2021-01-15 16:37:20 +01:00
parent dce0eef704
commit 773c3a88e5
1 changed files with 26 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

30
HACKING
View file

@ -3,13 +3,17 @@ Requirements
If you want to hack on the GIMP project, it will make your life easier If you want to hack on the GIMP project, it will make your life easier
to have the following packages (or newer versions) installed: to have the following packages (or newer versions) installed:
* GNU autoconf 2.54 * GNU autoconf 2.54 or over
- ftp://ftp.gnu.org/gnu/autoconf/ - ftp://ftp.gnu.org/gnu/autoconf/
* GNU automake 1.9 (automake 1.10 should also work) * GNU automake 1.13 or over
- ftp://ftp.gnu.org/gnu/automake/ - ftp://ftp.gnu.org/gnu/automake/
* GNU libtool 1.5 * GNU libtool 1.5 or over
- ftp://ftp.gnu.org/gnu/libtool/ - ftp://ftp.gnu.org/gnu/libtool/
Alternatively a build with meson 0.54.0 or over is possible but it is
not complete yet, hence not usable for packaging (yet usable for
development).
Fine GNU mirrors are listed at https://www.gnu.org/prep/ftp.html Fine GNU mirrors are listed at https://www.gnu.org/prep/ftp.html
Beta software can be found at alpha.gnu.org. Beta software can be found at alpha.gnu.org.
@ -96,7 +100,10 @@ Patches
------- -------
The best way to submit patches is to provide files created with The best way to submit patches is to provide files created with
git-format-patch. git-format-patch. The recommended command for a patch against the
`master` branch is:
$ git format-patch origin/master
It is recommended that you file a bug report at It is recommended that you file a bug report at
https://gitlab.gnome.org/GNOME/gimp https://gitlab.gnome.org/GNOME/gimp
@ -152,6 +159,21 @@ style is enforced. The GIMP coding style is defined as follows:
starting in the first column of the following line. All starting in the first column of the following line. All
parameters are prototyped and there's a new line for each. parameters are prototyped and there's a new line for each.
* Align relevant listing:
- In declaration and definition of functions, each parameter
should be on a new line and aligned with the first one.
- In function calls, if the call is too long and spans on
several lines, you should align the parameters with the first
one.
- Blocks of variable declaration/initialization should align the
variable names, allowing quick skimming of the variable list.
- Function names in blocks of function declarations should be
aligned.
* Avoid trailing whitespaces. Any editor should have a function to
warn of trailing spaces/tabs. By default, git colorization also
warns about trailing whitespaces.
The source tree contains local config files which can be used to set the The source tree contains local config files which can be used to set the
right coding style in common editors: `.dir-locals.el` for Emacs, right coding style in common editors: `.dir-locals.el` for Emacs,
`.kateconfig` for Kate, and `devel-docs/c.vim` for Vim (check the top `.kateconfig` for Kate, and `devel-docs/c.vim` for Vim (check the top