Commit Graph

81 Commits

Author SHA1 Message Date
Niels De Graef 92e80d12e8 docs: Migrate from gtk-doc to gi-docgen
gtk-doc has been slowly dying for the past few years; with gi-docgen we
have a nice successor.

This also makes sure the C documentation also uses the GIR file, which
in turn means faster build times (since all the C code doesn't have to
be parsed and recompiled again), and has a clear dependency graph.

See the [gi-docgen tutorial] for more info on how the system works.

[gi-docgen tutorial]: https://gnome.pages.gitlab.gnome.org/gi-docgen/tutorial.html
2021-12-27 10:47:34 +01:00
Jehan dc36b45f88 CODING_STYLE: update.
- Organize the rules in sections and subsections.
- Add some text about the linear git history (this can be seen as coding
  style after all).
- Add comment coding style and non-public API documentation sections.
- A bit of section reordering.
- Move the configuration files info from HACKING into CODING_STYLE.md,
  and make a new "Helping tools" section.
2021-10-31 01:31:47 +02:00
Stanislav Grinkov 1373bec64a Add separate CODING_STYLE file 2021-08-02 11:16:34 +00:00
Jehan 773c3a88e5 HACKING: some update on coding style and other.
Add in particular some notes about alignments and trailing whitespaces.
2021-01-15 16:37:20 +01:00
Michael Natterer bab75b7365 Change a bazillion URLs to https://
Including all user-visible link and links called from code, like
the help pages.
2018-07-14 14:19:27 +02:00
Jehan c6a1b9bcde Update various places with old git repository URIs. 2018-05-27 04:19:18 +02:00
Jehan 6ebff7b3c5 configure, desktop: update the bug report URL.
Also make so that the metadata URL is taken from the one of the package
set with configure.
2018-05-25 15:05:47 +02:00
Michael Natterer b05cfc6050 pdb: (try 3) move PDB generation and sources to toplevel/pdb
It never belonged inside "tools". Also rename its "pdb" subdirectory
to "groups". This had to happen before 2.10 so cherry-picking between
branches doesn't become a nightmare in the future.
2017-12-17 14:16:08 -05:00
Jehan acfca30899 HACKING: add a comment about the 3 config files for common editors.
We have coding style config files for Emacs, Kate and Vim.
2016-08-23 20:00:13 +02:00
Mikael Magnusson 025354b914 HACKING: add some missing info 2015-02-23 08:15:03 +01:00
Michael Natterer d3506a13fc HACKING: patches: recommend git-format-patch, not a repo to fetch from
Also update the developer mailing list address.
2012-10-07 15:19:40 +02:00
Kevin Cozens a2e037fb00 Corrected spelling errors spotted by Ari Pollak (Mostly fixes bug #683694)
Still need to address the "allows to" grammatical error.
2012-09-10 12:22:12 -04:00
Martin Nordholts f96bc446a6 Minor formating fix in HACKING 2009-05-08 20:15:46 +02:00
Martin Nordholts 64cbf6254f Convert Subversion references to git 2009-04-25 18:12:21 +02:00
Sven Neumann e816403306 Please re-run autogen.sh after this update, and let me know if there are
2008-08-11  Sven Neumann  <sven@gimp.org>

	Please re-run autogen.sh after this update, and let me know if
	there are any problems.

	* po-*/Makefile.in.in: updated to a version that does not 
require
	mkinstalldirs to be present.

	* autogen.sh: removed the call to glib-gettextize and call
	intltoolize without the --force command-line option. This change
	makes an end to the po/Makefile.in.in being overwritten.

	* HACKING: changed the documentation accordingly.


svn path=/trunk/; revision=26500
2008-08-11 16:15:25 +00:00
Sven Neumann 1681f55129 mention the fact that intltool now needs to be installed in order to build
2008-07-03  Sven Neumann  <sven@gimp.org>

	* INSTALL: mention the fact that intltool now needs to be
	installed in order to build from tarball.

	* HACKING: removed mentioning of intltoolize here.

svn path=/trunk/; revision=26041
2008-07-03 09:20:08 +00:00
Sven Neumann 3d48dcc119 note that we need intltool 0.35.5 or newer.
2008-05-24  Sven Neumann  <sven@gimp.org>

	* HACKING: note that we need intltool 0.35.5 or newer.


svn path=/trunk/; revision=25785
2008-05-24 08:58:28 +00:00
Sven Neumann 3e579fe6a4 HACKING removed mentions of libart, added a link for cairo.
2008-05-09  Sven Neumann  <sven@gimp.org>

	* HACKING
	* INSTALL: removed mentions of libart, added a link for cairo.


svn path=/trunk/; revision=25592
2008-05-09 07:21:48 +00:00
Sven Neumann d231e50ba6 updated for name change of generated files.
2008-04-04  Sven Neumann  <sven@gimp.org>

	* HACKING: updated for name change of generated files.

svn path=/trunk/; revision=25361
2008-04-04 11:20:15 +00:00
Mukund Sivaraman b087159552 Updated section on getting dependencies, as we don't want to encourage
2008-03-23  Mukund Sivaraman <muks@mukund.org>

        * HACKING: Updated section on getting dependencies, as we don't
          want to encourage using deps from svn for building GIMP.


svn path=/trunk/; revision=25188
2008-03-23 23:21:51 +00:00
Sven Neumann 950a71b9a4 HACKING dropped support for automake 1.8 and require automake >= 1.9.6.
2007-11-21  Sven Neumann  <sven@gimp.org>

	* HACKING
	* autogen.sh: dropped support for automake 1.8 and require
	automake >= 1.9.6. Require libtool 1.5 for all platforms.

svn path=/trunk/; revision=24210
2007-11-21 09:30:21 +00:00
Sven Neumann 8c36cdaf72 suggest to use pango-1-16.
2007-05-06  Sven Neumann  <sven@gimp.org>

	* HACKING: suggest to use pango-1-16.

	* configure.in: added --enable-gtk-doc-app option and an 
automake
	conditional for it.
	
	* devel-docs/Makefile.am: build the app directory conditionally.

	* devel-docs/app/Makefile.am: override disthook since we don't
	want to distribute any generated files.


svn path=/trunk/; revision=22426
2007-05-05 23:16:58 +00:00
Sven Neumann 5b45b7321f removed obsolete paragraph about authorsgen.
2007-01-20  Sven Neumann  <sven@gimp.org>

	* HACKING: removed obsolete paragraph about authorsgen.


svn path=/trunk/; revision=21742
2007-01-20 17:50:44 +00:00
Mukund Sivaraman a28d39473c Updated with Subversion instructions.
2007-01-20  Mukund Sivaraman <muks@mukund.org>

        * HACKING: Updated with Subversion instructions.


svn path=/trunk/; revision=21739
2007-01-20 07:18:09 +00:00
Sven Neumann 5bf710beec configure.in depend on glib >= 2.12.3.
2007-01-12  Sven Neumann  <sven@gimp.org>

	* configure.in
	* app/sanity.c: depend on glib >= 2.12.3.

	* HACKING: updated branches.

	* libgimpwidgets/gimpintstore.c: added a construct-only property
	that allows to specify the GType of the user-data column.


svn path=/trunk/; revision=21692
2007-01-12 13:48:30 +00:00
Sven Neumann dcc6ebd1b0 HACKING tools/pdbgen/lib.pl fixed spelling of "auto-generated".
2007-01-09  Sven Neumann  <sven@gimp.org>

	* HACKING
	* tools/pdbgen/lib.pl
	* tools/pdbgen/app.pl: fixed spelling of "auto-generated".

	* tools/pdbgen/pdb/color.pdb
	* tools/pdbgen/pdb/brush_select.pdb
	* tools/pdbgen/pdb/palette_select.pdb
	* tools/pdbgen/pdb/font_select.pdb
	* tools/pdbgen/pdb/procedural_db.pdb
	* tools/pdbgen/pdb/pattern_select.pdb
	* tools/pdbgen/pdb/drawable.pdb
	* tools/pdbgen/pdb/gradient_select.pdb: improved wording and fixed
	spelling errors.
	
	* libgimp/gimp.c: fixed spelling errors.

	* app/pdb/*.h: 
	* libgimp/gimp*_pdb.[ch]: regenerated.


svn path=/trunk/; revision=21676
2007-01-09 10:52:47 +00:00
Raphael Quinet c1530eb134 Mention that the mailing list is a good place to discuss patches (if they
2006-08-07  Raphael Quinet  <raphael@gimp.org>

	* HACKING: Mention that the mailing list is a good place to
	discuss patches (if they need to be discussed).
2006-08-07 15:15:27 +00:00
Raphael Quinet 8576f41ecd Clarify how patches can be submitted.
2006-07-27  Raphael Quinet  <raphael@gimp.org>

	* HACKING: Clarify how patches can be submitted.
2006-07-27 20:39:34 +00:00
Tor Lillqvist db66fd2a68 Clarify the wording about TABs. s/bracket/brace/ .
2006-04-28  Tor Lillqvist  <tml@novell.com>

	* HACKING: Clarify the wording about TABs. s/bracket/brace/ .
2006-04-28 09:18:51 +00:00
Sven Neumann 8e9b20e55c HACKING document the changed dependencies.
2005-12-28  Sven Neumann  <sven@gimp.org>

	* HACKING
	* INSTALL: document the changed dependencies.

	* configure.in
	* app/sanity.c: check for glib >= 2.8.2 at compile and run-time.

	* app/plug-in/plug-in.c: removed workaround for glib < 2.8.2.
2005-12-28 21:36:03 +00:00
Sven Neumann 90154e2c46 minor update.
2005-09-21  Sven Neumann  <sven@gimp.org>

	* HACKING: minor update.
2005-09-21 20:30:27 +00:00
Sven Neumann cc31f3ed08 changed automake version requirement 2005-06-12 10:37:57 +00:00
Michael Natterer c4847750dd updated info about stable CVS branches of modules we depend on.
2005-02-08  Michael Natterer  <mitch@gimp.org>

	* HACKING: updated info about stable CVS branches of modules we
	depend on.
2005-02-08 20:59:51 +00:00
Manish Singh 228cf3811b We work with automake 1.9 too 2005-02-07 18:44:40 +00:00
Sven Neumann 377dd60dcb HACKING dropped support for automake 1.6, automake >= 1.7 is now required.
2005-02-07  Sven Neumann  <sven@gimp.org>

	* HACKING
	* autogen.sh: dropped support for automake 1.6, automake >= 1.7 is
	now required.

	* configure.in: removed cruft that was there only for automake 1.6.
2005-02-07 12:05:05 +00:00
Sven Neumann e0a6c25548 HACKING Makefile.am acinclude.m4 applied (modified) patch from Raphaël
2005-01-20  Sven Neumann  <sven@gimp.org>

	* HACKING
	* Makefile.am
	* acinclude.m4
	* autogen.sh: applied (modified) patch from Raphaël Quinet that
	allows to build GIMP from CVS without having gtk-doc installed.
	If you need to do this, pass --disable-gtk-doc to autogen.sh.

	* configure.in: removed --disable-devel-docs option since it has
	become obsolete now.

	* devel-docs/Makefile.am: require gtk-doc when running 'make dist'.
2005-01-20 18:21:41 +00:00
Sven Neumann c9ee12aeec check for gtk-doc.m4, depend on intltool > 0.31.
2004-12-17  Sven Neumann  <sven@gimp.org>

	* autogen.sh: check for gtk-doc.m4, depend on intltool > 0.31.
2004-12-17 16:29:27 +00:00
Sven Neumann 3d7364b658 HACKING autogen.sh switched to using gtkdocize for the build of the API
2004-12-13  Sven Neumann  <sven@gimp.org>

	* HACKING
	* autogen.sh
	* configure.in: switched to using gtkdocize for the build of the
	API docs.
2004-12-13 22:51:55 +00:00
Sven Neumann 4c70bd1254 set the padding-mode to custom color if a custom color is choosen. Fixes
2004-11-10  Sven Neumann  <sven@gimp.org>

	* app/dialogs/preferences-dialog.c: set the padding-mode to custom
	color if a custom color is choosen. Fixes bug #157844.
2004-11-10 13:44:14 +00:00
Sven Neumann 29e9f01ada some updates.
2004-11-10  Sven Neumann  <sven@gimp.org>

	* HACKING: some updates.
2004-11-10 02:18:35 +00:00
Sven Neumann 41a9add7da added a rule to generate gtkuimanager XML files using an XSL
2004-05-02  Sven Neumann  <sven@gimp.org>

	* menus/Makefile.am: added a rule to generate gtkuimanager XML
	files using an XSL transformation.

	* menus/menus.xsl: a simple XSLT to generate a menubar and a popup
	menu with identical content.

	* menus/image-menu.xml: removed this file from CVS ...

	* menus/image-menu.xml.in: ... and added this instead.

	* HACKING: xsltproc is now needed to build from CVS.
2004-05-01 22:43:15 +00:00
Sven Neumann 28e79ea063 some minor updates.
2004-03-19  Sven Neumann  <sven@gimp.org>

	* HACKING: some minor updates.
2004-03-19 19:35:49 +00:00
Sven Neumann c224df0449 follow the changes done for other modules such as glib, pango and gtk+:
2004-03-04  Sven Neumann  <sven@gimp.org>

	* autogen.sh: follow the changes done for other modules such as
	glib, pango and gtk+:

	- exit with $? instead of 1 in case of failure
	- exit with $? if ./configure failed
	- removed --enable-gtk-doc option
	- added $AUTOGEN_CONFIGURE_ARGS

	* HACKING: document the new behaviour.
2004-03-04 14:47:37 +00:00
Sven Neumann 8915bbadfc don't update the fields here...
2004-01-25  Sven Neumann  <sven@gimp.org>

	* app/gui/info-window.c (info_window_create): don't update the fields
	here...

	* app/gui/view-commands.c (view_info_window_cmd_callback): ... but
	here when the info window is connected to the display shell. Patch
	from Shlomi Fish; fixes bug #132329.

	* app/gui/info-window.c (info_window_update_extended): fixed update
	of info window in automatic mode. Bug #118084, patch by Shlomi Fish.

	* autogen.sh: check for automake-1.8 also.

	* HACKING: note that automake-1.8 should work as well.
2004-01-25 13:53:23 +00:00
Sven Neumann c6f42dda80 set GIMP_VERSION to 2.0pre1.
2004-01-07  Sven Neumann  <sven@gimp.org>

        * configure.in: set GIMP_VERSION to 2.0pre1.

        * HACKING
        * INSTALL
        * NEWS
        * README: updated and changed accordingly.
2004-01-07 00:43:53 +00:00
Sven Neumann daa5f9e673 HACKING require libtool version 1.5.0 or newer when building on Win32.
2003-09-03  Sven Neumann  <sven@gimp.org>

	* HACKING
	* autogen.sh: require libtool version 1.5.0 or newer when building
	on Win32. Completely untested but it should fix bug #120953.
2003-09-03 17:36:49 +00:00
Dave Neary e5c4c12863 Changed slightly - I overestimated/overanticipated some things.
2003-09-03  Dave Neary  <bolsh@gimp.org>

        * NEWS: Changed slightly - I overestimated/overanticipated
        some things.

        * HACKING: Updated to fix some indentation issues, and clear
        up some small points (like not building as root) following
        suggestions from Emmet Caulfield <emmet@netrogen.com>
2003-09-02 18:57:01 +00:00
Sven Neumann 6d639f4144 update autoconf version here as well 2003-08-16 22:56:10 +00:00
Sven Neumann 5bd481a65f HACKING updated for GTK+ 2.2.
2003-03-06  Sven Neumann  <sven@gimp.org>

	* HACKING
	* INSTALL: updated for GTK+ 2.2.
2003-03-06 10:18:17 +00:00
Sven Neumann 4093cd2e75 added a note about generating the developers documentation and how to
2003-02-08  Sven Neumann  <sven@gimp.org>

	* HACKING: added a note about generating the developers
	documentation and how to disable it in case of problems.
2003-02-08 10:52:19 +00:00