Re: [PATCH] man-pages.7: STYLE GUIDE: Mention UNIX for Beginners

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Peter and Branden,

On 6/10/22 15:55, Peter Xu wrote:
Thanks for adding this!

There's a little bit of a pity though on that the PDF version will IMHO
loose one very important aspect of being an live example of how to do
semantics newlines itself.  Personally after I read the format I don't even
need to read the groff man page because the example is the best to describe
that this rule means.

I meant the possibility to quote the thing behind generated PDF just as you
did in the commit message:

---8<---
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.
]
---8<---

So I was wondering whether this section (along with its newline formats,
which is IMHO even more helpful) can be quoted altogether, because both the
content and format could help the reader in this case.

Sure, I was thinking of adding that to man-pages(7)::EXAMPLES after your comment. But I didn't know how to properly quote it, so I waited to see Branden's great advise first :)

Branden, might you want to send a patch yourself. I have no idea of how to correctly quote someone :/

Cheers,

Alex


Thanks,



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

Attachment: OpenPGP_signature
Description: OpenPGP digital signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux