https://maemo.octonezd.me/api.php?action=feedcontributions&feedformat=atom&user=83.201.250.110Maemo Wiki Mirror - User contributions [en]2026-04-21T23:14:51ZUser contributionsMediaWiki 1.45.1https://maemo.octonezd.me/index.php?title=Documentation/Patching_API_docs&diff=8250Documentation/Patching API docs2010-12-09T17:33:18Z<p>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...</p>
<hr />
<div>There are three possible places you should go to make a change to API documentation, depending on the package:<br />
<br />
# Upstream API<br />
# Open Maemo-specific API<br />
# Closed Maemo-specific API<br />
<br />
== Upstream API ==<br />
<br />
''Example: [http://bugs.maemo.org/4716 Maemo bug #4716]''<br />
<br />
* Open a bug in Maemo bugzilla for the API documentation issue<br />
* Open a corresponding bug upstream for the issue, and add a pointer to the upstream bug to the maemo.org bug<br />
* 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])<br />
* 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<br />
* (optionally) prepare a patch for the Maemo package (typically in gitorious nowadays). Alternately, refer to the upstream commit.<br />
* 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<br />
<br />
== Maemo specific API ==<br />
<br />
''Example: [http://bugs.maemo.org/4337 Maemo bug #4337]''<br />
<br />
* Open a bug in Maemo bugzilla for the API documentation issue<br />
* 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])<br />
* 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.<br />
* Assign bug to the module owner to get the patch applied.<br />
* 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</div>83.201.250.110