From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
To: Alejandro Colomar <colomar.6.4.3@gmail.com>
Cc: mtk.manpages@gmail.com, linux-man@vger.kernel.org,
libc-alpha@sourceware.org
Subject: Re: [PATCH] queue.3: Replace incomplete example by a complete example
Date: Sun, 11 Oct 2020 14:24:42 +0200 [thread overview]
Message-ID: <0ddfc89e-66c6-267a-c482-d2e59da1d07a@gmail.com> (raw)
In-Reply-To: <9bc990f9-1605-b1c3-09d0-0a2dd68bd8f2@gmail.com>
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@gmail.com>
>>
>> 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/
next prev parent reply other threads:[~2020-10-11 12:24 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-10 19:02 [PATCH] queue.3: Replace incomplete example by a complete example Alejandro Colomar
2020-10-10 19:08 ` Alejandro Colomar
2020-10-11 6:00 ` Michael Kerrisk (man-pages)
2020-10-11 9:03 ` Alejandro Colomar
2020-10-11 12:24 ` Michael Kerrisk (man-pages) [this message]
2020-10-12 12:53 ` Zack Weinberg
2020-10-12 18:47 ` Michael Kerrisk (man-pages)
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=0ddfc89e-66c6-267a-c482-d2e59da1d07a@gmail.com \
--to=mtk.manpages@gmail.com \
--cc=colomar.6.4.3@gmail.com \
--cc=libc-alpha@sourceware.org \
--cc=linux-man@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).