Как восхитить наладчика

[spamsink]

Вчера я по почте объяснял наладчику (field application engineer), почему наш компилятор-синтезатор моделей цифровой аппаратуры по умолчанию ведет себя определенным образом, а с установленной опцией — другим по причине срезания некоторых углов в деталях реализуемого языка с целью ускорения. Я написал примерно так:

Так как [деталь языка] по умолчанию не поддерживается, компилятор сообщает об ошибке, если встречает использование этой детали (а не просто игнорирует ее -- S.), чтобы обратить внимание пользователя на это.

Использование опции означает: "Дорогой [компилятор], я понимаю, что полная семантика [детали языка] не поддерживается, но, возможно, она мне и не нужна; пожалуйста^{(b0p0h0k: ты понял, что я в этот момент вспомнил?)}, попробуй, как сумеешь, сделать преобразование, пусть и с некоторой потерей семантики, в то, что ты можешь синтезировать, а я потом проверю, получилось ли у тебя то, что я хотел".

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

Comments

[sab123.livejournal.com]

Он прав. Это очень хорошее сообщение об ошибке. Проблемы начинаются, когда сообщения (и вообще любую документацию) начинают писать формальным языком.

[spamsink]

Это было бы не сообщение об ошибке, а описание смысла опции, но я попытался представить себе, как gcc --help выдавал бы что-то подобное, и не смог.

[sab123.livejournal.com]

Почему нет?

[spamsink]

Уж очень многословно получалось бы. Вот, скажем,
-felide-constructors This switch lacks documentation

Ну и как это в том же стиле корректно описать и уложить в одну-две строчки?

[sab123.livejournal.com]

Не укладывать в одну-две строчки. Это атавизм.

[spamsink]

По-моему, наоборот. "tl;dr" - недавний мем.

[sab123.livejournal.com]

Но на ту же тему. "tl;dr" - это краткое популярное изложение. В отличие от нечитаемого запутанного наукообразного. Меня особо убивают люди, которые вырезают из руководств примеры. Пусть лучше вырежут свои объяснения и оставят примеры.

[spamsink]

Насчет примеров я согласен, но в краткой справке, в отличие от мануала, должно быть объяснение в одну-две строки для всего.

[cema.livejournal.com]

"См. стр. такую-то мануала".

[spamsink]

Вот пользователи спасибо-то скажут!

[archaicos.livejournal.com]

За просто примерами порой не видно логики. Нужно много примеров на замену об'яснений. В т.ч. примеров того, как делать нельзя. Например, компилятор жрет твой код без сообщений об ошибках, а результат получается неожиданный. Но не всегда. Почему? Таки нужно об'яснение или об'яснение плюс пример.

[spamsink]

ОТ: У тебя солдаты РККА из наборной кассы букву ер изъяли?

[archaicos.livejournal.com]

Не у меня, а у Апфеля.

[spamsink]

На телефоне? А если на мягкий знак нажать и подержать?

[archaicos.livejournal.com]

Факъ. Интуитивненький интерфейсъ.

[archaicos.livejournal.com]

Неформальным уже пробовали. С переменным успехом:
comp.compilers: Error-handling if your compiler had an attitude.

[spamsink]

Один известный мне компилятор, склонный диагностировать массу наведенных ошибок, в конце компиляции сообщал "In X lines Y errors". Когда количество ошибок превышало количество строк, это напоминало анекдот про 4 ошибки в слове "ещё".

[sab123.livejournal.com]

Ну все-таки не надо путать нормальное неформальное описание (т.е. такое, где не "все должно быть в третьем числе и использовать научные слова") с приколизмами.

Ну вот чтобы прочувствовать разницу, могу привести в пример юниксный и виндовсный API. В виндовсе все системные вызовы названы исключительно формально (и пауэршелл - еще более отдельная история), в юниксе - неформально. Одна только история о том, какую попаболь вызывал вызов kill() у IBM когда она таки решилась делать AIX, чего стоят. Но приколизмов в юниксе нет.

[spamsink]

Про kill() у IBM я не видел. Где?

[sab123.livejournal.com]

В книге "A quarter century of Unix", если я правильно помню.

[archaicos.livejournal.com]

Да ладно, нет приколизмов.
http://en.wikipedia.org/wiki/Easter_egg_%28media%29#Software

[i_eron]

Нельзя язвить на работе! Для этого есть ЖЖ.

[spamsink]

Раз оказывается, что я не съязвил, то можно. :)

[i_eron]

Если поймут правильно - могут обидеться. Если неправильно - могут, например, "отрядить писать все сообщения о предупреждениях и ошибках". Но может и повезти, конечно.

[spamsink]

Это был а) израильтянин, и б) мы с ним уже довольно долго работаем, так что я мог себе позволить. :) Отрядить не отрядят — компания достаточно большая, чтобы для этого в ней были специальные люди.

[fatoff.livejournal.com]

Dear compiler, on behalf of our company I am very glad to clarify for your convenience...

А приведи точный текст. Может тогда станет яснее, это сарказм, или вдруг им стало понятно.

[spamsink]

Ровно то же, что по-русски:

As it is not supported, by default synthesis will fail if a MOS/RMOS gate is encountered to alert the user to that fact.

Setting the ConvertMOS attribute to true means "Dear [compiler], I understand that full MOS/RMOS semantics is not supported, but maybe I don't really need it; please try *converting* it as best you currently can, potentially losing some semantics, into something you can synthesize; I'll check if it works as I expect".

[fatoff.livejournal.com]

And the word 'maybe' in docs is a sign of a good literature. As well as 'dear'. :)

[archaicos.livejournal.com]

Dearest creature in creation,
Studying circuit compilation,
I will teach you in my verse
Things like MOS, CMOS and RMOS...

[fatoff.livejournal.com]

Some semantics
Can potentially we loose

[spamsink]

I will keep you, Suzy, busy, till your head with VHDL grows dizzy for sure.

[archaicos.livejournal.com]

:)

[iime.livejournal.com]

Да, жестковато.
Может быть, это было не первое письмо)

[spamsink]

Не первое, да. :)

[real-big-shish.livejournal.com]

За такое world wide респект от нас, наладчиков !

[spamsink]

Спасибо, но оно само получилось.