Documentation/Patching API docs - Revision history

amigadave: /* Open Maemo specific API */ do not suggest git diff to generate a patch

2011-02-01T09:57:47Z

Open Maemo specific API: do not suggest git diff to generate a patch

← Older revision		Revision as of 09:57, 1 February 2011
Line 18:		Line 18:
	== Open Maemo specific API ==		== Open Maemo specific API ==

-	''Example: [http://bugs.maemo.org/4337 Maemo bug #4337]''	+	''Example: [http://bugs.maemo.org/show_bug.cgi?id=4337 Maemo bug #4337]''

	* Open a bug in Maemo bugzilla for the API documentation issue		* Open a bug in Maemo bugzilla for the API documentation issue
	* Get the source code of the module from gitorious (in the case of libhildondesktop, that is [http://maemo.gitorious.org/fremantle-hildon-desktop/libhildondesktop the freemantle-hildon-desktop module])		* Get the source code of the module from gitorious (in the case of libhildondesktop, that is [http://maemo.gitorious.org/fremantle-hildon-desktop/libhildondesktop the freemantle-hildon-desktop module])
-	* Patch the source code to correct the documentation issue, and attach a patch (generated with ~~<pre>git diff</pre> or~~ <pre>git format-patch</pre>) to the bug. See [https://bugs.maemo.org/show_bug.cgi?id=4337#c8 comment #8] of the example bug.	+	* [[The Good Patch\|Patch the source code]] to correct the documentation issue, and attach a patch (generated with <pre>git format-patch</pre>) to the bug. See [https://bugs.maemo.org/show_bug.cgi?id=4337#c8 comment #8] of the example bug.
	* Assign bug to the module owner to get the patch applied.		* Assign bug to the module owner to get the patch applied.
	* Then assign the bug to (name needed - Soumya used to do this) to update the API docs for the module once the fix has been integrated		* Then assign the bug to (name needed - Soumya used to do this) to update the API docs for the module once the fix has been integrated

dneary at 17:34, 9 December 2010

2010-12-09T17:34:54Z

← Older revision		Revision as of 17:34, 9 December 2010
Line 16:		Line 16:
	* Assign bug to (name to be filled - this used to be Soumya) to update the API docs for the module once the fix has been integrated		* Assign bug to (name to be filled - this used to be Soumya) to update the API docs for the module once the fix has been integrated

-	== Maemo specific API ==	+	== Open Maemo specific API ==

	''Example: [http://bugs.maemo.org/4337 Maemo bug #4337]''		''Example: [http://bugs.maemo.org/4337 Maemo bug #4337]''
Line 25:		Line 25:
	* Assign bug to the module owner to get the patch applied.		* Assign bug to the module owner to get the patch applied.
	* Then assign the bug to (name needed - Soumya used to do this) to update the API docs for the module once the fix has been integrated		* Then assign the bug to (name needed - Soumya used to do this) to update the API docs for the module once the fix has been integrated
		+
		+	== Closed Maemo specific API ==
		+
		+	* Open a bug for the issue
		+	* Propose an alternative text for the documentation as a comment in the bug, and assign it to the module owner. It's their responsibility after this to ensure your work is integrated.
		+
		+	[[Category:Documentation]]

83.201.250.110: New page: There are three possible places you should go to make a change to API documentation, depending on the package: # Upstream API # Open Maemo-specific API # Closed Maemo-specific API == Ups...

2010-12-09T17:33:18Z

New page: There are three possible places you should go to make a change to API documentation, depending on the package: # Upstream API # Open Maemo-specific API # Closed Maemo-specific API == Ups...

New page

There are three possible places you should go to make a change to API documentation, depending on the package:

# Upstream API
# Open Maemo-specific API
# Closed Maemo-specific API

== Upstream API ==

''Example: [http://bugs.maemo.org/4716 Maemo bug #4716]''

* Open a bug in Maemo bugzilla for the API documentation issue
* Open a corresponding bug upstream for the issue, and add a pointer to the upstream bug to the maemo.org bug
* Get the source code of the upstream module from its source control system (in the case of gnome-vfs, that is [http://git.gnome.org/browse/gnome-vfs/ git])
* Patch the upstream source code to correct the documentation issue, and attach a patch (generated with <pre>git diff</pre> or <pre>git format-patch</pre>) to the upstream bug
* (optionally) prepare a patch for the Maemo package (typically in gitorious nowadays). Alternately, refer to the upstream commit.
* Assign bug to (name to be filled - this used to be Soumya) to update the API docs for the module once the fix has been integrated

== Maemo specific API ==

''Example: [http://bugs.maemo.org/4337 Maemo bug #4337]''

* Open a bug in Maemo bugzilla for the API documentation issue
* Get the source code of the module from gitorious (in the case of libhildondesktop, that is [http://maemo.gitorious.org/fremantle-hildon-desktop/libhildondesktop the freemantle-hildon-desktop module])
* Patch the source code to correct the documentation issue, and attach a patch (generated with <pre>git diff</pre> or <pre>git format-patch</pre>) to the bug. See [https://bugs.maemo.org/show_bug.cgi?id=4337#c8 comment #8] of the example bug.
* Assign bug to the module owner to get the patch applied.
* Then assign the bug to (name needed - Soumya used to do this) to update the API docs for the module once the fix has been integrated