[prac] [новая команда] (документация QBE)

[Vladislav Ivanishin]

Игорь Анфёров <igor-anferov at mail.ru> writes:
> Добрый день!

Добрый день,

> Хотелось бы уточнить более детально, что включает в себя задача
> составления документации.

Я вижу следующие возможные направления:

1) Документация основных структур данных и фукнций QBE -- т.е. по сути
   написание к ним комментариев, описывающих их
   предназначение/поведение. Возможно, лучше делать это отдельно от
   исходного кода, поскольку при обновлении upstream-ового QBE нам бы
   хотелось иметь возможность обновлять и нашу версию и при этом не
   заниматься каждый раз merge'м этих комментариев.

2) То, что я назвал web-based тэгами. Здесь нужно выбрать какую-нибудь
   систему, имеющую нужную функциональность (это должно быть свободное
   ПО), и развернуть её где-нибудь так, чтобы мы могли посмотреть и
   затем перенести на compilers.ispras.ru.
   Под нужной функциональностью подразумевается просмотр исходного кода
   в браузере и возможность перехода к определению каждого (насколько
   это возможно) символа и желательно, ко всем его
   использованиям. (Повсюду, где символ встречается, он становится
   гиперссылкой.) Примеры можно посмотреть вот тут: [1] (лицензия этого
   ПО несвободная, но это хорошая иллюстрация того, что хотелось бы
   иметь), [2], [3].

3) Например, написание статей/туториалов или настройка системы
   документирования под несколько форматов (HTML/PDF).

И прочие вещи, которые вы можете предложить для облегчения преодоления
входного порога в QBE для ваших последователей.

Если вы с командой уже определились, это обсуждение нужно переносить в
выделенный список рассылки, который я собираюсь сегодня создать.

[1]: https://code.woboq.org/gcc/gcc/alias.c.html 
[2]: http://llvm.org/doxygen/IRBuilder_8cpp_source.html
[3]: https://dxr.mozilla.org/mozilla-central/source/js/src/gc/Zone.cpp
-- 
Влад