Re: [PATCH] queue.3: Replace incomplete example by a complete example

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

 



Hello Alex,

On 10/11/20 11:03 AM, Alejandro Colomar wrote:
> 
> 
> On 2020-10-11 08:00, Michael Kerrisk (man-pages) wrote:
>> Hello Alex:
>>
>> On 10/10/20 9:02 PM, Alejandro Colomar wrote:
>>> I added the EXAMPLES section.
>>> The examples in this page are incomplete
>>> (you can't copy&paste&compile&run).
>>> I fixed the one about TAILQ first,
>>> and the rest should follow.
>>>
>>> Signed-off-by: Alejandro Colomar <colomar.6.4.3@xxxxxxxxx>
>>
>> I have not (yet) applied this patch, because...
> 
> 
> Hi Michael,
> 
> I thought that we could do it in the following steps:
> 
> 1) Fix the current page:
> 	- Complete examples
> 	- Use standard sections (such as EXAMPLES)
> 2) Move the code from this page to new separate pages
> 3) Fix the code in all of those pages to use "man" macros
> 
> This way, the history can be easily followed in git,
> instead of having a few commits breaking everything.
> 
> Also, I think this way it might be easier,
> and the improvements (such as better examples)
> can be seen from the beginning.
> Part 1 could be applied directly,
> while parts 2 & 3 should be applied at once.
> 
> If the change was done abruptly, you couldn't apply any commits
> until all of the work is finished
> (otherwise, you would have broken pages).
> 
> So I think this patch can be applied as part of this change.
Thanks for the excellent clarification. Patch applied!

Cheers,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/



[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