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 00/22] list.3: New page forked from queue.3
Date: Tue, 20 Oct 2020 21:33:14 +0200 [thread overview]
Message-ID: <d7c7d213-a9bf-deb6-a19c-4505e9389812@gmail.com> (raw)
In-Reply-To: <7ce58fe0-3564-ac04-34d2-d866a33c7777@gmail.com>
Hi Alex,
On 10/20/20 9:21 PM, Alejandro Colomar wrote:
>
>
> On 2020-10-20 20:57, Michael Kerrisk (man-pages) wrote:
>> Hi Alex,
>>
>> On 10/20/20 4:21 PM, Alejandro Colomar wrote:
>>> Hi Michael,
>>>
>>> I finished one of the pages: list.3
>>>
>>> Would you maybe call the page LIST.3 instead?
>>
>> I think list.3 is okay.
>>
>>> I didn't write the link pages yet in case we call it differently.
>>>
>>> Please comment any improvements you may find.
>>
>> Overall, I think the result is fine, but:
>>
>>> There are too many patches, so you may prefer to pull from my repo,
>>> where I created the tag 'list_v1' for this patchset:
>>>
>>> https://github.com/alejandro-colomar/man-pages.git list_v1
>>>
>>> As you can probably guess, if you prefer to pull from the repo,
>>> I'll create similar tags for revisions of this patchset (e.g., 'list_v2').
>>
>> I suppose if I was doing this work I would chunk it up into bigger
>> pieces. I appreciate that you are trying to meticulously show the
>> steps that you took to build the page, but 22 patches does
>> really feel like too much. And I would have combined the
>> "Use man markup" patches into one step at the end, and I'd prefer
>> you do that for future patches (but I can live with things as they
>> are in this patch series).
>>
>> In terms of fewer patches, how would you feel about squashing the
>> patches as per the blank line separators below (and consequently
>> having bigger commit messages):
>>
>>> Alejandro Colomar (22):
>>> list.3: New page that will hold the (list) contents of queue.3
>>
>>> list.3, queue.3: NAME: Move code from queue.3 to list.3
>>> list.3: NAME: ffix: Use man markup
>>> list.3: NAME: Add description
>>
>>> list.3, queue.3: SYNOPSIS: Move code from queue.3 to list.3
>>> list.3: SYNOPSIS: Copy include from queue.3
>>> list.3: SYNOPSIS: ffix: Use man markup
>>
>>> list.3: DESCRIPTION: Add short description
>>> list.3: DESCRIPTION: Copy description about naming of macros from
>>> queue.3
>>> list.3: DESCRIPTION: Remove unrelated code to adapt to this page
>>> list.3: DESCRIPTION: ffix: Use man markup
>>
>>> list.3, queue.3: DESCRIPTION: Move list specific code from queue.3 to
>>> list.3
>>> list.3: DESCRIPTION: ffix: Use man markup
>>> list.3: DESCRIPTION: Remove line pointing to the EXAMPLES
>>
>>> list.3: CONFORMING TO: Copy from queue.3
>>> list.3: CONFORMING TO: Adapt to this page
>>> list.3: CONFORMING TO: ffix: Use man markup
>>
>>> list.3: SEE ALSO: Add insque(3) and queue(3)
>>
>>> list.3, queue.3: EXAMPLES: Move example program from queue.3 to list.3
>>> list.3: EXAMPLES: ffix: Use man markup
>>
>>> list.3: BUGS: Note LIST_FOREACH() limitations
>>
>>> list.3: RETURN VALUE: Add details about the return value of those
>>> macros that "return" a value
>>
>> Squashing as above would yield 10 patches, and I'd kind of prefer
>> that so as to avoid quite so many commits in the history.
>> (For future patches though, I would prefer to split out the
>> "Use man markup" into a single patch at the end of the series.)
>
>
> I can't find the source
> (I think it was some kernel guide for sending patches),
> but I read some time ago that I should separate code movement
> from any other changes;
> otherwise git might not be able to follow that movement.
>
> So I would reorder and squash the commits as:
>
>
> Alejandro Colomar (22):
> list.3: New page that will hold the (list) contents of queue.3
>
> list.3, queue.3: NAME: Move code from queue.3 to list.3
>
> list.3, queue.3: SYNOPSIS: Move code from queue.3 to list.3
>
> list.3, queue.3: DESCRIPTION: Move list specific code from queue.3 to
> list.3
>
> list.3, queue.3: EXAMPLES: Move example program from queue.3 to list.3
>
> list.3: SYNOPSIS: Copy include from queue.3
> list.3: DESCRIPTION: Copy description about naming of macros from
> queue.3
> list.3: CONFORMING TO: Copy from queue.3
> list.3: DESCRIPTION: Remove unrelated code to adapt to this page
> list.3: DESCRIPTION: Remove line pointing to the EXAMPLES
> list.3: CONFORMING TO: Adapt to this page
> squash as list.3: Copy and adapt code from queue.3
>
> list.3: NAME: ffix: Use man markup
> list.3: SYNOPSIS: ffix: Use man markup
> list.3: DESCRIPTION: ffix: Use man markup
> list.3: DESCRIPTION: ffix: Use man markup
> list.3: CONFORMING TO: ffix: Use man markup
> list.3: EXAMPLES: ffix: Use man markup
> squash as list.3: ffix: Use man markup
>
> list.3: NAME: Add description
> list.3: DESCRIPTION: Add short description
> list.3: SEE ALSO: Add insque(3) and queue(3)
> list.3: BUGS: Note LIST_FOREACH() limitations
> list.3: RETURN VALUE: Add details about the return value of those
> macros that "return" a value
> squash as list.3: Add details
>
>
> I'll keep the messages of the squashed commits inside the commit msg.
> This would mean 8 patches.
>
> Sounds good?
I think that would be fine, but I suspect you might have to fix
a lot of conflicts if you reorder the patches so much, I wanted
to save you having to do that work. I could live with either way,
but I'd prefer to minimize the effort you need to invest to make the
change.
Thanks,
Michael
--
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
prev parent reply other threads:[~2020-10-20 19:33 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-20 14:21 [PATCH 00/22] list.3: New page forked from queue.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 01/22] list.3: New page that will hold the (list) contents of queue.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 02/22] list.3, queue.3: NAME: Move code from queue.3 to list.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 03/22] list.3: NAME: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 04/22] list.3: NAME: Add description Alejandro Colomar
2020-10-20 14:21 ` [PATCH 05/22] list.3, queue.3: SYNOPSIS: Move code from queue.3 to list.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 06/22] list.3: SYNOPSIS: Copy include from queue.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 07/22] list.3: SYNOPSIS: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 08/22] list.3: DESCRIPTION: Add short description Alejandro Colomar
2020-10-20 14:21 ` [PATCH 09/22] list.3: DESCRIPTION: Copy description about naming of macros from queue.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 10/22] list.3: DESCRIPTION: Remove unrelated code to adapt to this page Alejandro Colomar
2020-10-20 14:21 ` [PATCH 11/22] list.3: DESCRIPTION: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 12/22] list.3, queue.3: DESCRIPTION: Move list specific code from queue.3 to list.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 13/22] list.3: DESCRIPTION: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 14/22] list.3: DESCRIPTION: Remove line pointing to the EXAMPLES Alejandro Colomar
2020-10-20 14:21 ` [PATCH 15/22] list.3: CONFORMING TO: Copy from queue.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 16/22] list.3: CONFORMING TO: Adapt to this page Alejandro Colomar
2020-10-20 14:21 ` [PATCH 17/22] list.3: CONFORMING TO: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 18/22] list.3: SEE ALSO: Add insque(3) and queue(3) Alejandro Colomar
2020-10-20 14:21 ` [PATCH 19/22] list.3, queue.3: EXAMPLES: Move example program from queue.3 to list.3 Alejandro Colomar
2020-10-20 14:21 ` [PATCH 20/22] list.3: EXAMPLES: ffix: Use man markup Alejandro Colomar
2020-10-20 14:21 ` [PATCH 21/22] list.3: BUGS: Note LIST_FOREACH() limitations Alejandro Colomar
2020-10-20 14:21 ` [PATCH 22/22] list.3: RETURN VALUE: Add details about the return value of those macros that "return" a value Alejandro Colomar
2020-10-20 21:30 ` [PATCH v2 00/10] list.3: New page forked from queue.3 Alejandro Colomar
2020-10-21 4:52 ` Michael Kerrisk (man-pages)
2020-10-20 21:30 ` [PATCH v2 01/10] list.3: New page that will hold the (list) contents of queue.3 Alejandro Colomar
2020-10-20 21:31 ` [PATCH v2 02/10] list.3, queue.3: NAME: Move code from queue.3 to list.3 Alejandro Colomar
2020-10-20 21:31 ` [PATCH v2 03/10] list.3, queue.3: SYNOPSIS: " Alejandro Colomar
2020-10-20 21:31 ` [PATCH v2 04/10] list.3, queue.3: DESCRIPTION: Move list specific " Alejandro Colomar
2020-10-20 21:31 ` [PATCH v2 05/10] list.3, queue.3: EXAMPLES: Move example program " Alejandro Colomar
2020-10-20 21:31 ` [PATCH v2 06/10] list.3: Copy and adapt code from queue.3 Alejandro Colomar
2020-10-20 21:31 ` [PATCH v2 07/10] list.3: ffix: Use man markup Alejandro Colomar
2020-10-20 21:31 ` [PATCH v2 08/10] list.3: Add details Alejandro Colomar
2020-10-20 21:31 ` [PATCH v2 09/10] LIST_EMPTY.3, LIST_ENTRY.3, LIST_FIRST.3, LIST_FOREACH.3, LIST_HEAD.3, LIST_HEAD_INITIALIZER.3, LIST_INIT.3, LIST_INSERT_AFTER.3, LIST_INSERT_BEFORE.3, LIST_INSERT_HEAD.3, LIST_NEXT.3, LIST_REMOVE.3: Link to the new list.3 page instead of queue.3 Alejandro Colomar
2020-10-20 21:31 ` [PATCH v2 10/10] queue.3: SEE ALSO: Add list(3) Alejandro Colomar
2020-10-20 18:57 ` [PATCH 00/22] list.3: New page forked from queue.3 Michael Kerrisk (man-pages)
2020-10-20 19:21 ` Alejandro Colomar
2020-10-20 19:33 ` Michael Kerrisk (man-pages) [this message]
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=d7c7d213-a9bf-deb6-a19c-4505e9389812@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).