[devel] Путаница в терминологии и названиях в документации

Andrey Savchenko bircoph на altlinux.org
Ср Май 20 10:00:56 MSK 2020


Доброго времени суток всем!

On Tue, 19 May 2020 17:31:05 +0300 Aleksey Cheusov wrote:
> Привет всем. Заделом для этих замечаний и предложений явилась короткая offlist дискуссия с mike@
> о давнишнем разделе git.alt на части. То, что ниже -- немного дискуссий на эту же тему в телеграм
> канале и мой ответ Черепанову. Конструктив -- в двух первых моих постах в телеграме.
> В принципе, дальше уже лирика, разжевывания и примеры (скукота).
>
> Aleksey Cheusov, [17.05.20 16:11]
> Риторический вопрос. А зачем, когда распиливали git.alt на части, не сделали так: git.alt оставить как
> набор git репозиториев (на что компонент git в названии как бы и намекает), а сборочницу назвать
> просто и банально build.alt (о чем и говорит компонент build в названии). Вместо этого ввели две
> непонятных сущности на букву g. Если что, это идея Шигорина, я не сам придумал, но она мне кажется
> Очень Логичной. gitery и gyle -- просто лишние названия, которые все усложняют. Кстати, в некоторых
> Вики сборочницу ещё называют girar. В общем, кто в лес, кто по дрова, а сущности
> всего лишь две: место, где хранятся репы, и сборочница
> 
> Wladmis, [17.05.20 16:20]
> И всё ещё чуть-чуть сложнее.
> 
> Aleksey Cheusov, [17.05.20 16:23]
> git.altlinux.org:2222 -- репы, build.altlinux.org:2222 -- сборочница. Чего-то не хватает?
> Если эти порты заняты, можно взять другие
> 
> Aleksey Cheusov, [17.05.20 16:37]
> Рекомендовать настройки .ssh/config можно было *бы* такие: git.alt и build.alt,
> что я у себя и сделал. Очень просто, и очень понятно.

Я понял так: когда решили разбить git.alt на гитовницу
и сборочницу, прежний git.alt оставили для совместимости на долгое
время и полностью прибили буквально на днях. Поэтому для гитовницы
нужно было выбрать новое имя и взяли gitery. На тот момент это было
оправданное решение, но сейчас пора бы вернуть обратно. И вот тут
начинается нытьё: мы уже привыкли к gitery, у нас же не только
гиты (хотя из srpm сборочница всё равно делает гиты), так
исторически сложилось и т.д. и т.п.

Со сборочницей всё ещё хуже: название gyle крайне запутывающее, на
мой взгляд. Я давно ругаюсь на эту тему; ldv как-то IRL пояснил мне,
что gyle — это котелок, в котором всё варится и поэтому всё
понятно, а build — непонятное название, потому что сборочница не
только пакеты собирает, а верифицирует репозиторий, индексы создаёт
и всё такое. Безусловно, это так, но основная задача сборочницы
с точки зрения мейнтенеров пакетов — это сборка пакетов
в репозиторий.

Girar — это название софта сборочницы, которое в дальнейшем
разделилось на girar и girar-builder. Не знаю, было ли это
синхронно с разделением git на git и build, но думаю, что это
вероятный сценарий. Здесь авторы могут называть свой софт как
угодно, хоть тумбочкой и табуреткой. Но зачем использовать это
на.звание в описаниях интерфейсов git и build для мейнтенеров
пакетов — непонятно.

Когда я только пришёл в Альт, меня самого эти gitery, gyle, girar
вымораживали и была вечная путаница, пока mike не показал пример
конфига с понятными git.alt и build.alt. За что ему огромное
спасибо.

Что я предлагаю:

1. Нужно ориентироваться на понятные новым мейнтенерам названия
сервисов: git и build. Разумеется, устаревшие названия gitery
и gyle можно и нужно будет сохранить (лет на 5?) чтоб ничего не
сломать действующим мейнтенерам. Это легко сделать через алиасы, ну
тот же CNAME.

Решение о переименовании, похоже, должно быть организационным, т.к.
разногласия и распри по этому поводу могут идти долго.

2. После решения вопроса о переименовании нужно приступить к правке
документации, а то будет ещё хуже.

Зачем использовать название girar в документации — мне не понятно,
это только запутывает и мейнтенеру пакетов оно не нужно от слова
совсем. Видимо, «так исторически сложилось»©™ со времён, когда git
был единым сервисом и git и girar во многом были синонимичны.

Если очень хочется рассказать про girar, можно сделать отдельные
страницы на эту тему. На intranet уже сейчас есть детальное
руководство по эксплуатации для администратора сборочницы для e2k.
Можно его взять за основу.

P.S. Вообще, проблема с «напиши себе конфиг/скрипты» типична
в Альте, речь не только про конфиг ssh для сборочницы: например,
hasher непрактично использовать без того или иного вида обёрток:
нужна куча ключей и настроек просто для выполнения повседневной
типовой работы, нет механизма логирования сборки и приходится
изобретать свой велосипед; и такие велосипеды в том или ином виде
у каждого разработчика и это не очень хорошо. Хотелось бы, чтоб из
коробки уже можно было более-менее пользоваться.

Best regards,
Andrew Savchenko
----------- следующая часть -----------
Было удалено вложение не в текстовом формате...
Имя     : отсутствует
Тип     : application/pgp-signature
Размер  : 833 байтов
Описание: отсутствует
Url     : <http://lists.altlinux.org/pipermail/devel/attachments/20200520/2dd3941f/attachment-0001.bin>


Подробная информация о списке рассылки Devel