KolibriOS Documentation

You can leave links to different KoOS-related sites and articles here
  • Лог SVN никто не отменял, только вот авторы иной раз пишут очень кратко. Я понимаю когда дело касается неважных фиксов мелких багов, но когда написано два слова о серьезно вещи (обычно это название явления) и никакого намека на объяснение - становится просто грустно. Ведь не все могут знать что за явление, но авторы ведут себя по принципу "я трахался с этой проебенью, пусть и остальные трахаются" - а это неконструктивный подход, более того безперспективный для коллективной разработки. Хотя бы на форуме стоит отписать, хотя бы кратко. :!:

    Как были мы кучкой индивидуалистов, так и остались. :(
  • diamond wrote:
    art_zh wrote:Та же, что и в оригинале: kernel/trunk/docs/sysfuncs.txt
    Ну дык это устарело, не так ли? И где же "постоянные обновления" вики?
    Сразу всего не охватишь.
    И все-таки она обновляется.
    http://wiki.kolibrios.org/wiki/Special: ... get=Art+zh
    Старался чтобы людям удобнее было.
    Где находил ляпы - правил. (sysfn09)
    Старьё обновлял. (kernel_api, sysfn62)

    - и это всё, по-твоему, - "поддерживаемая система лажи"?
    или, может быть, процесс "постоянного пополнения всякой фигни"?? :evil:
  • Назревает ХолиВар...
    ушёл...
  • И как же признание
    art_zh wrote:Сразу всего не охватишь.
    соотносится с советом
    art_zh wrote:Сверяйся с Вики - там более полная, связная и постоянно обновляемая документация.
    ? Я же только советом возмущаюсь.
    Как я уже продемонстрировал, документация в klbr_doc.chm более точная, чем вики (естественно, в той области, которая покрывается klbr_doc.chm). Собственно, после исправления одной константы в описании функции 9 в сборке от 23 мая там разве что 62.{11,12,13} не описаны - и то только потому, что они новые, о дистре речи пока не идёт, и нужны, скажем так, очень ограниченному контингенту, которому и из исходников ядра всё очевидно.
    art_zh wrote:http://wiki.kolibrios.org/wiki/Special: ... get=Art+zh
    - и это всё, по-твоему, - "поддерживаемая система лажи"?
    или, может быть, процесс "постоянного пополнения всякой фигни"??
    Не считая системных функций (об описании которых я говорил выше), остаются Kernel/ru, EmbeddedKOS/ru, User:Art_zh, PCIDEV.
    Это "всё" определённо является довольно небольшим подмножеством всей вики, интересным всё тому же очень ограниченному контингенту, которому и без вики всё известно, а если неизвестно, то только вики в любом случае будет недостаточно. Вики несколько больше, чем множество вышеупомянутых страниц, а ОСь не ограничивается ядром.
    Ушёл к умным, знающим и культурным людям.
  • diamond wrote:И как же признание
    art_zh wrote:Сразу всего не охватишь.
    соотносится с советом
    art_zh wrote:Сверяйся с Вики - там более полная, связная и постоянно обновляемая документация.
    ? Я же только советом возмущаюсь.
    Не вижу противоречия. Обновление идет; третьестепенные темы тоже дождутся своей очереди (кстати, спасибо за замечание - исправил)
    Ваше возмущение мне представляется беспричинным.
    diamond wrote:Как я уже продемонстрировал, документация в klbr_doc.chm более точная, чем вики (естественно, в той области, которая покрывается klbr_doc.chm)...
    Абсолютно неубедительная демонстрация на совершенно несущественном примере.
    Вы можете оставаться при своем личном мнении, маэстро, но другие с Вами вполне могут и не согласиться.
    ИМХУется мне, что вики полнее и удобнее. К тому же инвариантна ночным сборкам.
    diamond wrote:Не считая системных функций (об описании которых я говорил выше), остаются Kernel/ru, EmbeddedKOS/ru, User:Art_zh, PCIDEV.
    Это "всё" определённо является довольно небольшим подмножеством всей вики, интересным всё тому же очень ограниченному контингенту, которому и без вики всё известно, а если неизвестно, то только вики в любом случае будет недостаточно. Вики несколько больше, чем множество вышеупомянутых страниц, а ОСь не ограничивается ядром.
    Весьма показательный ответ на вполне конкретные вопросы.
    Очень легко не считать почти сотню статей с десятками перекрестных ссылок, на которые мы втроем ухлопали почти месяц.
    Еще легче объявить EmbeddedKOS и PCIDEV (210 и 120 просмотров за 2 месяца) "интересными очень ограниченному контингенту".
    Но насчет Kernel/ru - это неуважение к самому себе.
    Если корифею влом самому подкорректировать собственные откровения (хотя бы здесь) - пусть не возмущается соавторством чайников.
    Евангелие от Иоанна: стих 1

    Code: Select all

    ; В начале было Слово:
    B32:        mov     ax, os_stack       ; Selector for os
    [/size]
  • Не примите за человека, сующего нос в не свои дела, но я за локальную (автономную) справку. Потому что пользоватся wiki я не могу, т.к. скорость инета у меня мизерная, а движок на котором работает вики довольно тормознутый. Поэтому, чтение wiki превращается в долгий и нудный процесс. Да и я уверен, что у многих пользователей Колибри, нет круглостучного доступа в интернет. Собственно, поэтому я все это и затеял.

    P.S. Я не против wiki.kolibrios.org, и всем кто её правит отдельный респект :)
    ушёл...
  • art_zh wrote:Абсолютно неубедительная демонстрация на совершенно несущественном примере.
    Если это было бы единичным случаем, то да. Но это далеко не единичный случай.
    Чтобы далеко не ходить: в svn log sysfuncr.txt есть запись о r1220 от 2009-10-19 (довольно давно, не так ли?), svn diff -c1220 sysfuncr.txt показывает, что добавилось замечание "Предварительно следует инициализировать кучу процесса вызовом подфункции 11" в 68.22. Смотрим в klbr_doc.chm (из 0.7.7.0 или из последней ночной сборки, неважно) и видим там это замечание. Смотрим на http://wiki.kolibrios.org/wiki/SysFn68/ru и, во-первых, не видим там этого замечания, а во-вторых, видим кучу надругательств над русским языком, таких как пропущенную букву 'н' прямо в заголовке и отсутствие кучи знаков препинания в описании. И ещё уточняю на всякий случай: нет, это всё ещё не единственная ошибка, оставшаяся в описании системных функций с вики.
    art_zh wrote:Не вижу противоречия. Обновление идет; третьестепенные темы тоже дождутся своей очереди
    Описываю ход дискуссии:
    Nasarus: вот моя документация. За основу взят klbr_doc.chm.
    art_zh: вики рулит, "там более полная, связная и постоянно обновляемая документация". Вот, например, функции 9 и 62.
    diamond: вики - отстой, там куча лажи. Вот, например, функция 18.13. А единственная замеченная ошибка в klbr_doc.chm уже исправлена.
    art_zh: ну да, есть лажа, но вики всё равно рулит.
    Мне видится противоречие между "таки есть лажа" ("Сразу всего не охватишь") и "таки вики рулит".
    art_zh wrote:Очень легко не считать почти сотню статей с десятками перекрестных ссылок, на которые мы втроем ухлопали почти месяц.
    Мне жаль, что вы ухлопали целый месяц вашего времени и создали такую лажу притом, что существует нормальная правильная документация по системным функциям. Меня возмущает, что вы рекомендуете эту лажу взамен нормальной доки. Кроме того, мне непонятно, с каких пор и почему качество документации измеряется временем, потраченным на её создание, так что я по-прежнему буду оценивать результат. А он плачевный.
    art_zh wrote:Еще легче объявить EmbeddedKOS и PCIDEV (210 и 120 просмотров за 2 месяца) "интересными очень ограниченному контингенту".
    Но насчет Kernel/ru - это неуважение к самому себе.
    Мне Kernel/ru неинтересна, я и так знаю, что там написано. Прикладникам она тоже неинтересна. А потенциальные ядерщики составляют действительно очень ограниченный контингент. В чём здесь "неуважение к самому себе"?
    art_zh wrote:Если корифею влом самому подкорректировать собственные откровения (хотя бы здесь) - пусть не возмущается соавторством чайников.
    Это не откровения. А отдельно взятая страница Kernel/ru меня не задевает - я же говорил, что на вики есть и правильная информация тоже.
  • О чём вообще спор?
    diamond и art_zh

    Попробуйте выражать свои мысли, не используя жёстких терминов типа "лажа" и я уверен, что взаимопонимание будет достигнуто. Тем более, что информация по API на wiki, взята скорее всего из более ранней версии sysfuncr.txt документации, но это не сколько не уменьшает важности работы по созданию онлайн документации. Чем в большем количестве форматов информация будет представлена, тем лучше.
    В то же время запросы программистов на информацию растут. Им уже недостаточно доки по API, нужно документировать библиотеки, вот где непаханное поле для деятельности. :)
    P.S. А работу по развитию и совершенствованию wiki нужно продолжать.
  • Хотелось бы узнать мнение тех, кому не безразлично:
    1)Делать ли юзвер-ламмер-пак для тех, кто еще слабо знаком с компьютером и не имеет работы с опёрационными системами, прикладным/системным ПО?
    2)Включать ли в сборник описание приложений?
    3)Что вам не нравится в нынешней комплектации?
    3)Что еще надо включить в DocPack+ (не беря во внимание вышеперечисленное и описание API библиотек) ?
    ушёл...
  • 1) ИМХО, не стОит
    2) думаю, да
    на 3) и 4) ответить пока не могу
  • Нынишняя документация, меня и так вполне устраевает . Да вобщем-то, согласен с Albom'ом, можно 2) , а остальное хрен его знает, решать тебе. Ну а если времени и сил не жалко, можно включить доки по другим языкам программирования (например: C--,TCC, ну и т.д., на что сил хватит), для высокоуровневых кодеров. Ну а лично мне чего не хватает, это хорошего описания мнемоник. :D
  • Сравниваю документацию из последней ночной сборки с вики. Чтобы несоответствия устранить, разумеется.
    Иду по номерам.

    Итак, из неочевидного.

    На вики:
    SysFn05/ru (пауза)
    При текущей реализации произойдет немедленный возврат из функции, если сложение ebx с текущим значением счетчика времени вызовет 32-битное переполнение.

    В доке из ночной сборки этого нет.
    Как на самом деле обстоят сейчас дела, кто знает?

    Возможно, будут еще вопросы.
  • Переполнения не происходит. Правильная информация в доке из ночной сборки. Тоже подправил DocPack+.
    ушёл...
  • По пункту 4.

    Посмотри E-Zine там много интересной информации, особенно много полезной информации в первом выпуске. Правда некоторая информация могла устареть, тут надо будет узнавать подробнее.

    Ещё можно было бы написать несколько новых статей, типа таких:

    1.) системные:
    "Пишем драйвер для аудио карты"
    "Пишем драйвер для видео карты"
    "Пишем драйвер для сетевой карты"
    и т.д.

    "Описание материнской платы компьютера" (С описанием северного и южного мостов, шин и т.д., при этом не нужно сильно вдаваться в детали достаточно просто объяснить где какое устройство сидит, ну и вкратце описать его функциальное назначение. Не помешает при этом приводить примеры из Колибри, типа "это устройство поддерживается в системе, с помощью такого-то драйвера, который работает с такими-то функциями данного устройства" и "а поддержка этого устройства включена в состав ядра ОС, планируется вынос данного кода в отдельный драйвер(а)", "вынести код поддержки данного устройства из ядра невозможно, потому что ...", ну и т.д.).

    2.) прикладные:
    "Разработка приложений с использованием такой-то библиотеки" (На примере какого-нибудь приложения, либо уже существующего, либо написанного автором специально для статьи).
    "О портировании программ в KolibriOS" (Такую статью кстати, когда-то начал писать barsuk, но хотя информация в ней и правильная, её всё же мало для неопытного программиста, неплохо было бы расписать пункты в статье поподробнее и приводя при этом примеры из кода).
    "Отладка программы в KolibriOS" (небольшая статья посвященная отладке программ).
    "Рекомендации по написанию кода на ассемблере под KolibriOS" (тут можно написать некоторые рекомендации по оформлению кода с целью сделать его более читабильным, чтобы в разработке могли принять участие другие программисты с наименьшими затратами времени на понимание вашего кода, или с другой стороны по созданию высокооптимизированных программ, распространенные методики, антирекомендации и т.д.).

    и т.д.

    3.) общего плана:
    "О ветках Колибри" :) (можно описать существующие ветки Колибри, для чего они создавались (в качестве исследовательской работы, для специфичного применения, для портирования на другие архитектуры и т.д.)), каково их состояние на текущий момент времени (разработка продолжается, прекращена, заморожена), % выполнения от поставленной цели, включение наработок отдельных ветвей в trunk, т.е. в основную ветвь системы.
    "Сеть в КолибриОС" (поддерживаемые протоколы, сетевые карты, настройка подключения, конфигурирование, прикладные программы).

    и т.д.
  • Who is online

    Users browsing this forum: No registered users and 2 guests