Editing Documentation/Patching API docs

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

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/show_bug.cgi?id=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])
* [[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.
* 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

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

Retrieved from "http://wiki.maemo.org/Documentation/Patching_API_docs"

@@ 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
-== Open Maemo specific API ==
+== Maemo specific API ==
 ''Example: [http://bugs.maemo.org/show_bug.cgi?id=4337 Maemo bug #4337]''
@@ Line 25: / Line 25: @@
 * 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
-== 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]]

Personal tools

Navigation

Views

Editing Documentation/Patching API docs