Board.KolibriOS.org

Решил написать полный справочник (которого так не хватает) по исходному коду ядра Колибри, выкладываю то, что получилось на данный момент.
Пока идея документа простая, для каждого файла исходного кода описать, какие функции и структуры данных в нем реализуются, как они работают и зачем они нужны.
Знаю, в Вики подробно описана концепция работы ядра, но к сожалению она не описывает большинство внутренних функций и структур ядра, а только самые самые основные. Также стоит сказать, что некоторые участки ядра неплохо прокомментированы в самом коде, в то время как попадаются и места где комментарии полностью отсутствуют. В результате, я начал писать справочник.
P.S. в файле в некоторых местах встречаются пометки TODO вместо описаний а также пока не рассмотрены многие файлы кода, было бы очень хорошо если участники нашего сообщества, которые имеют более глубокие познания во внутренностях ядра, дополнили бы данный документ

UPD: Перенесено в Wiki: http://wiki.kolibrios.org/wiki/Kernel_code/ru и развивается там.

_________________
The best way to predict the future is to create it.

Documentation is vital for KolibriOS development and your effort is very appreciated.

Some thoughts on this:

1. There is no reason to keep description of a function in a separate file from its body.
2. Same for more high-level logic. CleverMouse set a quite high standard of documentation that I see no reason to not follow (except lazyness of course).
3. May be it's time to proceed with discussion of in-code documentation?

1) I think it is convenient to have descriptions of all function in one place along with the comments in code. For example to overview the kernel structure its quite easier to learn documentation in one file (maybe with internal hyperlinks), than open many many tabs in text editor. Also, maybe Ill add more detailed explanations on how does some things in the kernel work, so document above can become rather a book than only documentation.
2) You mean http://wiki.kolibrios.org/wiki/Style/ru ? Yes, we need to translate existing russian comments in the kernel and add missing, following one standart.
3) Yes it is good idea to add possibility to automatically make documentation files from in-code comments. Writing python script that grabs function decriptions from source code file, using regexps, would be not bad and simple solution..

_________________
The best way to predict the future is to create it.

Here is the 0.0.2 version, ive added descriptions on some things and how they work. Now still only in russian, but in future I'll translate it in english too.

_________________
The best way to predict the future is to create it.

Перенес из txt в новую страницу на Wiki: http://wiki.kolibrios.org/wiki/Kernel_code/ru . В начале страницы располагается автоматическое иерархическое оглавление, что дает большое удобство навигации. В дальнейшем справочник будет развиваться и дополняться именно на данной странице.

_________________
The best way to predict the future is to create it.

Гм, имхо легче искать информацию в исходном асм-листинге,
чем ползать по одной плоской вики-странице.

Надо добавить граф/таблицу перекрёстных ссылок,
иначе не поймёшь где конкретная функция используется
и для чего она вообще в ядре нужна.

В идеале, конечно, неплохо бы сделать на Doxygen или аналогах. Хотя, мне кажется что и у вики-версии есть свои плюсы: в описании функции можно написать свои пространные рассуждения о том, как и что там работает, и даже привести примеры использования. Не думаю, что в коде уместно писать настолько много и подробно..


Помню dunkaist генерировал граф инклудов в ядре. Сделать то же самое для функций было бы классно (кстати граф выйдет гигантским )
Таблицу перекрестных ссылок сделать попроще, думаю добавлю. То есть в конце описания каждой функции будет "Используется в :" и набор ссылок.

_________________
The best way to predict the future is to create it.

как эта функция определяет длину packed_data я не знаю, но сюда можно добавить:

dword[packed_data + 0] -> символы 'KPCK'
dword[packed_data + 4] -> размер unpacked_data

Спасибо, добавил

_________________
The best way to predict the future is to create it.