Developer manual - Revision history

Mgmax: /* Global Verbs */

2025-05-26T15:07:33Z

Global Verbs

PBS: /* Introduction */ Update developer access, C++ references

2023-02-05T07:31:33Z

Introduction: Update developer access, C++ references

← Older revision		Revision as of 07:31, 5 February 2023
Line 25:		Line 25:
	planned. ;-)		planned. ;-)

	We have a process for gaining ~~SVN commit~~ access. The reason is that		We have a process for gaining GitLab Developer access. The reason is that
	while it is important that we keep access to the codebase open, we don’t		while it is important that we keep access to the codebase open, we don’t
	want to be crazy and leave it wide open to any random passer-by. The		want to be crazy and leave it wide open to any random passer-by. The
Line 32:		Line 32:
	to get account access.		to get account access.

	In general you won’t need ~~SVN commit access~~ in order to start doing		In general you won’t need Developer role in order to start doing
	development, because you can ~~work from an anonymous checkout and~~ create		development, because you can create merge requests with only a regular account. Due to GitLab constraints however, you won't be able to run Windows or MacOS CI - but we can always do that for you.
	~~patches~~. ~~If you’ve not done this before~~, ~~you’ll need~~ to ~~learn this~~
	~~skill first (basically see docs~~ for ~~`svn diff`)~~.

	When you first start hacking on Inkscape code, I wouldn’t recommend		When you first start hacking on Inkscape code, I wouldn’t recommend
Line 67:		Line 65:
	refactoring effort (such as when we converted from C to C++), that		refactoring effort (such as when we converted from C to C++), that
	we encourage lots of people to help on, in the philosophy that many		we encourage lots of people to help on, in the philosophy that many
	hands ~~makes short~~ work. This work tends to be pretty rote so is		hands make light work. This work tends to be pretty rote so is
	not hard for new folks to get involved with; it just takes time. We		not hard for new folks to get involved with; it just takes time. We
	generally have one of these kinds of efforts per release. It		generally have one of these kinds of efforts per release. It
Line 101:		Line 99:

	== C++ Reference ==		== C++ Reference ==
	* FAQ (with answers) sheet. We strongly recommend that everyone read this site comprehensively. You should not need to bookmark it, it should be the first of the sites on your autocomplete list for <code>par</code>!

	~~http~~://~~www~~.~~parashift~~.~~com~~/~~c++-faq-lite~~/		*The C++ Core Guidelines. A set of rules for using modern C++ well, emphasizing safety and simplicity.<p>https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines</p>

	It is actually more in-depth than the name FAQ suggests. Many experienced C++ programmers would benefit from it.		*The C++ FAQ (with answers). We strongly recommend that everyone read this site comprehensively. You should not need to bookmark it, it should already be at the top of your autocomplete list!<p>[https://isocpp.org/wiki/faq/ https://isocpp.org/wiki/faq]<br/>[http://www.parashift.com/c++-faq-lite/ http://www.parashift.com/c++-faq-lite] (previous version)</p><p>It is actually more in-depth than the name FAQ suggests. Many experienced C++ programmers would benefit from it.</p>

	* ~~List~~ of <s>~~[http~~://~~www.cs.helsinki.fi/u/vkarvone/2004s/cplusplus/errors~~.~~html schoolboy errors] (Broken Link)~~</s>~~. None of these should appear in [http://en.wikipedia.org/wiki/Free/Libre/Open-Source_Software FLOSS] code.~~		*C++ Reference. Documentation of all features of the language and standard library.<p>https://cppreference.com</p>

	== Please use const ==		== Please use const ==

Raphael: /* Please use const */ typo correction

2016-03-05T20:12:37Z

Please use const: typo correction

← Older revision		Revision as of 20:12, 5 March 2016
Line 121:		Line 121:

	int const & foo;		int const & foo;
	// RTL reading gives "foo is a reference o a constant int"		// RTL reading gives "foo is a reference to a constant int"

	int const * foo;		int const * foo;

Moini: /* Code modules */ Marked broken links, comment about possible replacement

2015-05-26T21:40:22Z

Code modules: Marked broken links, comment about possible replacement

← Older revision		Revision as of 21:40, 26 May 2015
Line 398:		Line 398:
	might want to have a look at these dependency graphs before you read deeper		might want to have a look at these dependency graphs before you read deeper
	into the source code (outside at the moment):		into the source code (outside at the moment):
			<s>
	[http://www.ark.in-berlin.de/gri-debug.svgz]		[http://www.ark.in-berlin.de/gri-debug.svgz]
	[http://www.ark.in-berlin.de/gri-dialogs.svgz]		[http://www.ark.in-berlin.de/gri-dialogs.svgz]
Line 408:		Line 408:
	[http://www.ark.in-berlin.de/gri-livarot.svgz]		[http://www.ark.in-berlin.de/gri-livarot.svgz]
	[http://www.ark.in-berlin.de/gri-widgets.svgz]		[http://www.ark.in-berlin.de/gri-widgets.svgz]
	[http://www.ark.in-berlin.de/gri-xml.svgz]		[http://www.ark.in-berlin.de/gri-xml.svgz]</s> (links broken)
			<!-- Was this the equivalent to the current Doxygen graphs? http://jenkins.inkscape.org/job/Inkscape_trunk_doxygen/doxygen/ -->

	These are not all modules! For questions about how to generate these graphs		These are not all modules! For questions about how to generate these graphs

Romain2Boss at 11:26, 25 August 2013

2013-08-25T11:26:21Z

← Older revision		Revision as of 11:26, 25 August 2013
Line 223:		Line 223:
	Here’s a readers’ digest summary of how Inkscape accelerators work:		Here’s a readers’ digest summary of how Inkscape accelerators work:

	A global mapping between key combinations and integer verb IDs		A global mapping between key combinations and integer [[verb]] IDs
	(<code>sp_verb_t</code>) is maintained in <code>shortcuts.cpp</code>; these are registered using		(<code>sp_verb_t</code>) is maintained in <code>shortcuts.cpp</code>; these are registered using
	<code>sp_shortcut_set()</code>.		<code>sp_shortcut_set()</code>.

Romain2Boss: Add "Please use const" following a developper discussion

2013-04-14T10:34:06Z

Add "Please use const" following a developper discussion

← Older revision		Revision as of 10:34, 14 April 2013
Line 108:		Line 108:

	* List of <s>[http://www.cs.helsinki.fi/u/vkarvone/2004s/cplusplus/errors.html schoolboy errors] (Broken Link)</s>. None of these should appear in [http://en.wikipedia.org/wiki/Free/Libre/Open-Source_Software FLOSS] code.		* List of <s>[http://www.cs.helsinki.fi/u/vkarvone/2004s/cplusplus/errors.html schoolboy errors] (Broken Link)</s>. None of these should appear in [http://en.wikipedia.org/wiki/Free/Libre/Open-Source_Software FLOSS] code.

			== Please use const ==

			Please be very aggressive in adding ''const'' to any code you write. It will help us understand code better and will prevent bugs from creeping in. It is very easy to remove ''const'' later on, but very hard to add it.

			''const'' can go on either side of a type. However once you get into references and pointers and such with C++, you generally read those from right-to-left. So it makes the code a little more legible if the ''const'' comes between the variable type and name.

			int const foo;
			// RTL reading gives "foo is a constant int".

			And then:

			int const & foo;
			// RTL reading gives "foo is a reference o a constant int"

			int const * foo;
			// RTL reading gives "foo is a pointer to a constant int"

			whereas:

			int * const foo;
			// RTL reading gives "foo is a constant pointer to an int"

			Read also:
			* [http://www.cprogramming.com/tutorial/const_correctness.html Const Correctness]
			* [http://yosefk.com/c++fqa/const.html Const Correctness]

	== Strings ==		== Strings ==

Zearin: Tweaked markup, some formatting, and a little phrasing.

2012-03-05T16:52:31Z

Tweaked markup, some formatting, and a little phrasing.

Show changes

Shivaenigma: /* C++ Reference */

2011-03-21T11:03:25Z

C++ Reference

← Older revision		Revision as of 11:03, 21 March 2011
Line 107:		Line 107:
	It is actually more in-depth than the name FAQ suggests. Many experienced C++ programmers would benefit from it.		It is actually more in-depth than the name FAQ suggests. Many experienced C++ programmers would benefit from it.

	* List of [http://www.cs.helsinki.fi/u/vkarvone/2004s/cplusplus/errors.html schoolboy errors]. None of these should appear in [http://en.wikipedia.org/wiki/Free/Libre/Open-Source_Software FLOSS] code.		* List of <s>[http://www.cs.helsinki.fi/u/vkarvone/2004s/cplusplus/errors.html schoolboy errors] (Broken Link)</s>. None of these should appear in [http://en.wikipedia.org/wiki/Free/Libre/Open-Source_Software FLOSS] code.


	== Strings ==		== Strings ==

JazzyNico: /* Strings */

2010-09-24T13:24:21Z

Strings

← Older revision		Revision as of 13:24, 24 September 2010
Line 120:		Line 120:
	"Ambiguous string"		"Ambiguous string"
	can then become		can then become
	Q_("Context\|Ambiguous string")		C_("Context", "Ambiguous string")

	For more complex things, please check the gettext/localization documentation.		For more complex things, please check the gettext/localization documentation.
	See also http://library.gnome.org/devel/glib/unstable/glib-I18N.html		See also http://library.gnome.org/devel/glib/unstable/glib-I18N.html


	== Implementing User Interface Changes ==		== Implementing User Interface Changes ==

Bkor: update developer.gnome.org to library.gnome.org

2010-08-18T19:34:02Z

update developer.gnome.org to library.gnome.org

← Older revision		Revision as of 19:34, 18 August 2010
Line 123:		Line 123:

	For more complex things, please check the gettext/localization documentation.		For more complex things, please check the gettext/localization documentation.
	See also http://~~developer~~.gnome.org/~~doc~~/~~API/2.0~~/~~glib~~/glib-I18N.html		See also http://library.gnome.org/devel/glib/unstable/glib-I18N.html