lkml.org 
[lkml]   [2021]   [Nov]   [22]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH v2 00/20] Add memberof(), split headers, and simplify code
From


On 11/22/21 12:17, Andy Shevchenko wrote:
>
> What happens to the indentation in your emails?!
> It looks like a bad poem :-)

Ahh, hehe!

It's a habit of writing manual pages source code. It makes it easier to
edit the ideas while writing.

Recently, I learned that this goes back to Kernighan:

Brian W. Kernighan, 1974 [UNIX For Beginners]:

[
Hints for Preparing Documents

Most documents go through several versions
(always more than you expected)
before they are finally finished.
Accordingly,
you should do whatever possible
to make the job of changing them easy.

First,
when you do the purely mechanical operations of typing,
type so subsequent editing will be easy.
Start each sentence on a new line.
Make lines short,
and break lines at natural places,
such as after commas and semicolons,
rather than randomly.
Since most people change documents
by rewriting phrases and
adding, deleting and rearranging sentences,
these precautions simplify any editing you have to do later.
]

See <https://rhodesmill.org/brandon/2012/one-sentence-per-line/>.

>
> On top of that, never start a new thread inside the previous one.
>

ACK.

Thanks,
Alex

--
Alejandro Colomar
Linux man-pages comaintainer; http://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/

\
 
 \ /
  Last update: 2021-11-22 13:09    [W:0.192 / U:0.072 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site