gimp/devel-docs
Jehan cc02ee1160 devel-docs: c.vim to help contributors enforce our coding style in VIM.
The GNU coding standards rules can be found in:
https://gcc.gnu.org/wiki/FormattingCodeForGCC
I added a few rules, like if the file has existing tabs, we want to show
them as 8 columns. Yet typing tabs automatically expands to 2 spaces.

I also added a rule to highlight (in red) trailing whitespaces, but also
tabs (everywhere, not only trailing) making them easy to spot.
This file can be easily sourced from vimrc for the whole GIMP tree, but
I advise against setting VIM to automatic discover a locale .vimrc,
which is possible but a high security risk since a third-party vimrc
could contain random shell commands.
2016-08-23 17:37:10 +02:00
..
app app: split GimpFileDialog into Gimp(Open|Save|Export)Dialog subclasses. 2015-09-02 20:05:01 +02:00
libgimp devel-docs: remove a template file that should not be in git 2015-06-02 02:48:46 +02:00
libgimpbase Remove the "GIMP" from all "Since: GIMP 2.x" API doc comments 2015-05-31 21:18:09 +02:00
libgimpcolor libgimpcolor: rename the gimp_lcms_*() functions to gimp_color_profile_*() 2015-06-03 09:41:23 +02:00
libgimpconfig libgimpconfig: rename the new GimpColorConfig profile accessor functions 2015-06-03 09:57:34 +02:00
libgimpmath Remove the "GIMP" from all "Since: GIMP 2.x" API doc comments 2015-05-31 21:18:09 +02:00
libgimpmodule Remove the "GIMP" from all "Since: GIMP 2.x" API doc comments 2015-05-31 21:18:09 +02:00
libgimpthumb Remove the "GIMP" from all "Since: GIMP 2.x" API doc comments 2015-05-31 21:18:09 +02:00
libgimpwidgets Revert "libgimpwidgets: remove gimp_color_profile_chooser_dialog_new()" 2016-05-07 00:57:40 +02:00
tools devel-docs: don't use deprecated API in doc-shooter 2015-12-06 23:46:11 +01:00
.gitignore Added .gitignore files generated with git svn create-ignore. 2009-01-31 11:37:44 +00:00
GIMP3-API-Changes.txt devel-docs: some more items for GIMP3-API-Changes.txt 2014-06-02 20:38:20 +02:00
Jenkins-Tutorial.odt Add Jenkins tutorial 2014-10-26 13:08:36 +01:00
Makefile.am devel-docs: Add libtool-instructions.txt 2014-08-27 08:41:02 +05:30
README devel-docs: rewording, grammar fixes, etc. 2013-03-08 21:38:19 +01:00
README.gtkdoc added a link to http://www.gtk.org/gtk-doc/ 2008-12-10 11:53:50 +00:00
bugzilla-milestones.txt devel-docs: rewording, grammar fixes, etc. 2013-03-08 21:38:19 +01:00
c.vim devel-docs: c.vim to help contributors enforce our coding style in VIM. 2016-08-23 17:37:10 +02:00
commit-rules.txt Bug 692641 - Various spelling fixes 2013-01-27 18:59:02 +01:00
compositing.txt Review, amend and update the XCF file format spec and parasites.txt 2014-10-20 20:52:30 +02:00
contexts.txt devel-docs: rewording, grammar fixes, etc. 2013-03-08 21:38:19 +01:00
debug-plug-ins.txt Bug 678925 - Debugging plugins with windows 2013-02-23 16:25:58 +01:00
exif-handling.txt Bill Skaggs <weskaggs@primate.ucdavis.edu> 2005-01-04 17:48:13 +00:00
gbr.txt Corrected consistency of name length and wording of the v3 explanation 2009-06-20 12:46:42 +02:00
gegl-porting-plan.txt devel-docs: Add gegl-porting-plan.txt 2011-08-29 03:19:15 +02:00
ggr.txt updated for the new fields in the gradient files. 2006-09-01 00:20:01 +00:00
gih.txt Changed "The GIMP" to "GIMP" everywhere, where it's used as a name. 2007-06-06 08:44:52 +00:00
gimp-module-dependencies.svg app: Get rid of config -> display module dependency 2010-02-01 21:56:48 +01:00
gpb.txt Jens Lautenbacher <jtl@gimp.org> 2000-12-18 20:37:23 +00:00
gtkbuilder-porting-guide.txt devel-docs: rewording, grammar fixes, etc. 2013-03-08 21:38:19 +01:00
icons.txt devel-docs: update the icons doc with some of Mitch explanations. 2016-08-06 02:16:59 +02:00
includes.txt s:libgimp/gimpintl.h:gimp-intl.h: 2003-07-10 18:49:32 +00:00
libtool-instructions.txt devel-docs: Add libtool-instructions.txt 2014-08-27 08:41:02 +05:30
parasites.txt Review, amend and update the XCF file format spec and parasites.txt 2014-10-20 20:52:30 +02:00
pat.txt Bug 587710 – PAT file specification seems to have a wrong magic number 2009-07-12 19:26:13 +03:00
release-howto.txt devel-docs: updated after the latest release experience 2015-11-26 00:24:48 +01:00
structure.xml Bug 692641 - Various spelling fixes 2013-01-27 18:59:02 +01:00
submitting-patches.txt devel-docs: Refer to website for patch submitting instructions 2009-08-15 09:49:10 +02:00
tagging.txt devel-docs: rewording, grammar fixes, etc. 2013-03-08 21:38:19 +01:00
ui-framework.txt devel-docs: Add a paragraph about sessionrc 2010-01-19 22:24:17 +01:00
undo.txt Moved various files from the docs directory to devel-docs and 2000-06-13 14:05:35 +00:00
vbr.txt Bug 715018 - Developer documentation on VBRs incorrect 2013-11-22 20:47:16 +01:00
xcf.txt Review, amend and update the XCF file format spec and parasites.txt 2014-10-20 20:52:30 +02:00

README

Developers documentation 
------------------------

This directory holds information that you will find useful if you
develop a GIMP plug-in or want to work on the GIMP core.

See http://wiki.gimp.org/index.php/Main_Page for more information.

   app                     - setup for documentation of the GIMP core;
                             not built by default since it is huge and
                             only relevant for core developers

   libgimp
   libgimpbase
   libgimpcolor
   libgimpconfig
   libgimpmath
   libgimpmodule
   libgimpthumb
   libgimpwidgets          - complete libgimp documentation generated from
                             the source; see README.gtkdoc

   tools                   - the source code for tools used to generate
                             documentation



   bugzilla-milestones.txt - describes how the GIMP project
                             uses milestones in the Bugzilla bugtracker
   commit-rules.txt        - describes rules and things to think
                             about when creating GIMP commits
   contexts.txt            - describes how GimpContexts are used in GIMP
   debug-plug-ins.txt      - how to debug GIMP plug-ins
   exif-handling.txt       - how GIMP should handle EXIF data
   includes.txt            - the policy for inclusion of header files
   parasites.txt           - descriptions of known parasites
   release-howto.txt       - a check-list for doing a GIMP release
   submitting-patches.txt  - how to submit a patch for GIMP
   tagging.txt             - how resource tagging in Gimp works
   ui-framework.txt        - describes how the GIMP UI framework functions and
                             how it is implemented
   undo.txt                - description of the undo system


   structure.xml           - a DocBook article that gives an overview on
                             the directory structure of the GIMP source tree,
                             also check out gimp-module-dependencies.svg


   gbr.txt                 - description of the GBR format used to store
                             pixmap brushes
   ggr.txt                 - description of the GGR format used to store
                             GIMP gradients
   gih.txt                 - description of the GIH format used to store a
                             series of pixmap brushes
   gpb.txt                 - OBSOLETE: description of the GPB format for
                             pixmap brushes
   pat.txt                 - description of the PAT format for patterns
   vbr.txt                 - description of VBR format used for
                             "generated" brushes
   xcf.txt                 - description of Gimp's XCF format