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.
Latest revision | Your text | ||
Line 18: | Line 18: | ||
== Open Maemo specific API == | == Open Maemo specific API == | ||
- | ''Example: [http://bugs.maemo.org/ | + | ''Example: [http://bugs.maemo.org/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. |
* 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 |
Learn more about Contributing to the wiki.