Linux kernel coding style (оцените перевод)

[Phobos]

Недавно начал знакомится с миром Unix, в связи с этим возникла острая потребность в изучении английского языка (хотя бы на уровне чтения технической документации), будущее свое связываю с программированием под замечательную операционную систему Linux (интересует преимущественно системное: ядро, модули и т. п.). Считаю что лучший способ изучить английский - переводить технические тексты. Первый переведенный мною текст "Linux kernel coding style", автора которого я, к сожалению, не знаю. Прошу тех у кого есть время оценить перевод (правильно ли переведен, замечания по стилю перевода) и, возможно, кто нибудь знает автора этого текста. Далее привожу исходный текст и перевод.


-----------------------------------------------------------------------------------------
|
|Исправил вроде все, переписал последний абзац и нормально оформил
|
-----------------------------------------------------------------------------------------



Linux kernel coding style

This is a short document describing the preferred coding style for the linux kernel. Coding style is very personal, and I won't force my views on anybody, but this is what goes for anything that I have to be able to maintain, and I'd prefer it for most other things too. Please at least consider the points made here.

First off, I'd suggest printing out a copy of the GNU coding standards, and not read it. Burn them, it's a great symbolic gesture.

Anyway, here goes:
Chapter 1: Indentation

Tabs are 8 characters, and thus indentations are also 8 characters. There are heretic movements that try to make indentations 4 (or even 2!) characters deep, and that is akin to trying to define the value of PI to be 3.

Rationale: The whole idea behind indentation is to clearly define where a block of control starts and ends. Especially when you've been looking at your screen for 20 straight hours, you'll find it a lot easier to see how the indentation works if you have large indentations.

Now, some people will claim that having 8-character indentations makes the code move too far to the right, and makes it hard to read on a 80-character terminal screen. The answer to that is that if you need more than 3 levels of indentation, you're screwed anyway, and should fix your program.

In short, 8-char indents make things easier to read, and have the added benefit of warning you when you're nesting your functions too deep. Heed that warning.
Chapter 2: Placing Braces

The other issue that always comes up in C styling is the placement of braces. Unlike the indent size, there are few technical reasons to choose one placement strategy over the other, but the preferred way, as shown to us by the prophets Kernighan and Ritchie, is to put the opening brace last on the line, and put the closing brace first, thusly:

if (x is true) {
we do y
}

However, there is one special case, namely functions: they have the opening brace at the beginning of the next line, thus:

int function(int x)
{
body of function
}

Heretic people all over the world have claimed that this inconsistency is ... well ... inconsistent, but all right-thinking people know that (a) K&R are right and (B) K&R are right. Besides, functions are special anyway (you can't nest them in C).

Note that the closing brace is empty on a line of its own, except in the cases where it is followed by a continuation of the same statement, ie a "while" in a do-statement or an "else" in an if-statement, like this:

do {
body of do-loop
} while (condition);

and

if (x == y) {
..
} else if (x > y) {
...
} else {
....
}

Rationale: K&R.

Also, note that this brace-placement also minimizes the number of empty (or almost empty) lines, without any loss of readability. Thus, as the supply of new-lines on your screen is not a renewable resource (think 25-line terminal screens here), you have more empty lines to put comments on.
Chapter 3: Naming

C is a Spartan language, and so should your naming be. Unlike Modula-2 and Pascal programmers, C programmers do not use cute names like ThisVariableIsATemporaryCounter. A C programmer would call that variable "tmp", which is much easier to write, and not the least more difficult to understand.

However, while mixed-case names are frowned upon, descriptive names for global variables are a must. To call a global function "foo" is a shooting offense.

Global variables (to be used only if you really need them) need to have descriptive names, as do global functions. If you have a function that counts the number of active users, you should call that "count_active_users()" or similar, you should not call it "cntusr()".

Encoding the type of a function into the name (so-called Hungarian notation) is brain damaged - the compiler knows the types anyway and can check those, and it only confuses the programmer. No wonder MicroSoft makes buggy programs.

Local variable names should be short, and to the point. If you have some random integer loop counter, it should probably be called "i". Calling it "loop_counter" is non-productive, if there is no chance of it being mis-understood. Similarly, "tmp" can be just about any type of variable that is used to hold a temporary value.

If you are afraid to mix up your local variable names, you have another problem, which is called the function-growth-hormone-imbalance syndrome. See next chapter.
Chapter 4: Functions

Functions should be short and sweet, and do just one thing. They should fit on one or two screenfuls of text (the ISO/ANSI screen size is 80x24, as we all know), and do one thing and do that well.

The maximum length of a function is inversely proportional to the complexity and indentation level of that function. So, if you have a conceptually simple function that is just one long (but simple) case-statement, where you have to do lots of small things for a lot of different cases, it's ok to have a longer function.

However, if you have a complex function, and you suspect that a less-than-gifted first-year high-school student might not even understand what the function is all about, you should adhere to the maximum limits all the more closely. Use helper functions with descriptive names (you can ask the compiler to in-line them if you think it's performance-critical, and it will probably do a better job of it that you would have done).

Another measure of the function is the number of local variables. They shouldn't exceed 5-10, or you're doing something wrong. Re-think the function, and split it into smaller pieces. A human brain can generally easily keep track of about 7 different things, anything more and it gets confused. You know you're brilliant, but maybe you'd like to understand what you did 2 weeks from now.
Chapter 5: Commenting

Comments are good, but there is also a danger of over-commenting. Never try to explain how your code works in a comment: it's much better to write the code so that the working is obvious, and it's a waste of time to explain badly written code.

Generally, you want your comments to tell what your code does, not how. Also, try to avoid putting comments inside a function body: if the function is so complex that you need to separately comment parts of it, you should probably go back to chapter 4 for a while. You can make small comments to note or warn about something particularly clever (or ugly), but try to avoid excess. Instead, put the comments at the head of the function, telling people what it does, and possibly why it does it.
Chapter 6: You've made a mess of it

That's ok, we all do. You've probably been told by your long-time unix user helper that "GNU emacs" automatically formats the C sources for you, and you've noticed that yes, it does do that, but the defaults it uses are less than desirable (in fact, they are worse than random typing - a infinite number of monkeys typing into GNU emacs would never make a good program).

So, you can either get rid of GNU emacs, or change it to use saner values. To do the latter, you can stick the following in your .emacs file:

(defun linux-c-mode ()
"C mode with adjusted defaults for use with the Linux kernel."
(interactive)
(c-mode)
(setq c-indent-level 8)
(setq c-brace-imaginary-offset 0)
(setq c-brace-offset -8)
(setq c-argdecl-indent 8)
(setq c-label-offset -8)
(setq c-continued-statement-offset 8)
(setq indent-tabs-mode nil)
(setq tab-width 8))

This will define the M-x linux-c-mode command. When hacking on a module, if you put the string -*- linux-c -*- somewhere on the first two lines, this mode will be automatically invoked. Also, you may want to add

(setq auto-mode-alist (cons '("/usr/src/linux.*/.*\\.[ch]$" . linux-c-mode)
auto-mode-alist))

to your .emacs file if you want to have linux-c-mode switched on automagically when you edit source files under /usr/src/linux.

But even if you fail in getting emacs to do sane formatting, not everything is lost: use "indent".

Now, again, GNU indent has the same brain dead settings that GNU emacs has, which is why you need to give it a few command line options. However, that's not too bad, because even the makers of GNU indent recognize the authority of K&R (the GNU people aren't evil, they are just severely misguided in this matter), so you just give indent the options "-kr -i8" (stands for "K&R, 8 character indents").

"indent" has a lot of options, and especially when it comes to comment re-formatting you may want to take a look at the manual page. But remember: "indent" is not a fix for bad programming.

[Wegman]

Ай молодец!

Если есть желание могу скинуть перевод этого же текста(но только в субботу-воскресенье). Ибо он есть у меня в бумажном варианте из "Разработка ядра линукс. Роберт Лав" этого года издания.

[deninok]

Если кому интересно, то автором оригинала Linux kernel coding style является Линус Торвальдс. Написано со свойственным ему юмором.

[Phobos]

Что автор Линус я конешно догадывался, но были сомнения спасибо что подсказали
перевод прошу скинуть на
phobos <at> xsecurity <dot> org
заранее благодарен

[csx]

Извини, но буду резать правду-матку.
Переведено хорошо, но по-русски ты говорить не умеешь На самом деле это закономерно для новичков - посторение русской фразы по английским принципам построения предложений. От этого необходимо избавляться.
Итак.
1. coding style - обязательно надо перевести (стиль программирования)! Или сократить до CS (с упоминанием в начале).
Иначе фразы типа "Какого coding style придерживаться личное дело каждого и я не хочу кому-либо навязывать свой стиль" режут глаз. Можно здесь заменить "стиль" на "мнение", но это не выход.

2. " но это то что я могу посоветовать и придерживаюсь этого (coding style) в большинстве своих вещей." -- русские так не говорят!!!
Например, можно так: "я могу лишь советовать вам и придерживаться такого стиля программирования в большинстве своих работ." КСТАТИ! По моему, даже переведено неправильно, там смысл другой.

3. "Сначала я должен предложить распечатать копию стандартов кода GNU, и не читать это. Сожгите их, это будет большой символический жест." Прочитай это вслух человеку, который будет рядом и спроси его мнение......
Я бы перевел так: "Сначала я советую вам напечатать себе копию стандартов кода GNU но не читать. Сожгите их, это великолепный символический жест"

4. ( прим. перев.) - это что? Кстати - Еретик это отступник,.... Я бы перевел, но можно и Еретик....

5. "попытке определить величину PI" - попытке установить!!! а не определить.

6. "Особенно хорошо можно увидеть как большие отступы облегчают работу после 20 часов" - корявенько... В принципе и так все понятно, но корявенько.
Я бы сделал так: "После 20 часов непрерывной работы перед монитором удобство больших отступов особенно хорошо заметно".

7. "Now, some people will claim" - переводится как "сейчас кто-то может возразить, что..."

В общем и так далее.....

Извини, но 3.
Еще у тебя с запятыми проблемы, но здесь я сам часто ошибки делаю, поэтому помочь не смогу.
Надеюсь мой пост будет понят правильно, тем более, что ни одного смайлика в нем нет (почти ).

[Phobos]

Извини, но буду резать правду-матку.

Вот спасибо, грамотная критика, я и разместил здесь перевод чтобы ее услышать, все замечания учту и постараюсь исправить.

ps Еще раз спасибо

[nerezus]

ткрывающая скобка в конце строки, закрывающая в начале, таким образом:
if (x is true) {
we do y
}
Тем не менее, есть одно исключение: функции: открывающая скобка в них располагается в начале следующей строки, таким образом:
int function(int x)
{
body of function
}
Еретики всего мира объявляют что это несовместимо

Ничего несовместимого, и, кстати, это офиц. стандарт PHP

[Phobos]

1. fixed
2. fixed, смысл действительно был другой
3. fixed
4. учитывая то, что речь идет об отступах я не решился исправлять, чтобы избежать тафтологии, к тому же я думаю что Линус имел в виду именно еретиков, т.к. далее встречаются слова пророки (prorhets), правоверные (right-thinking)
5. fixed
6. fixed
7. fixed, также исправлено предложение, в котором использовалась эта фраза, оно несколько поменяло смысл
Переработал вчера весь текст, большую часть переделал, чтобы он был совместим с правилами русского языка.

[eduard_pustobaev]

if (x is true) {
we do y
}
Скажите, кто разбрается такая вот расстановка скобок, это для фолдинга?
А то мне как-то удобнее читать, когда:
if (x is true)
{
we do y
}

[Phobos]

if (x is true) {
we do y
}
Скажите, кто разбрается такая вот расстановка скобок, это для фолдинга?
А то мне как-то удобнее читать, когда:
if (x is true)
{
we do y
}

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

ps Вторую версию перевода кто-нибудь читал? что можете сказать о ней?

[edo]

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

[Minotaurus]

edo - парень молодец, пусть тренируется и не УЖАС совсем...
Phobos:
"Кроме того, функции - это специальные конструкции (их нельзя вкладывать в C)."
я бы заменил "(их нельзя вкладывать в C)" на "(к их форманиторванию нельзя подходить с точки зрения С)" так будет более по русски, а то получается что функции в С код нельзя вкладывать...

"Заметьте также, что закрывающая скобка должна находится на пустой строке, за исключением тех случаев, когда она является продолжением какой либо конструкции, т.е. "while" в операторе do или "else" в операторе if (возможно это переводится как ""while" в do-оператор или "else" в if-оператор" прим. перев.), нечто вроде:"
Первоночальный вариант правильный - в скобках не правильно.

[VladimirP]

Phobos:
"Кроме того, функции - это специальные конструкции (их нельзя вкладывать в C)."
я бы заменил "(их нельзя вкладывать в C)" на "(к их форманиторванию нельзя подходить с точки зрения С)" так будет более по русски, а то получается что функции в С код нельзя вкладывать...

Лучше так:
"Кроме того, функции - это особенные конструкции (в языке C их нельзя вкладывать друг в друга)"
или
"(язык C не допускает вложения функций)".

[Phobos]

ок, постараюсь все поправить, просто сейчас инета нет да и занят освоением k&r