[LTP] [PATCH 1/1] statx04: Remove kernel comments in docparse
Li Wang
liwang@redhat.com
Fri Aug 19 14:36:38 CEST 2022
Hi Petr,
On Fri, Aug 19, 2022 at 5:07 PM Petr Vorel <pvorel@suse.cz> wrote:
> They are defined in .tags, having in docparse results into poor
> formating in metadata.{html,pdf}.
>
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
> Hi Li,
>
> I've done cleanup like this in the past, but sending a patch just to
> make consensus about it. If we prefer to have git commits like this in
> the code (i.e. if being in .tags is not enough), they should be in
> normal comments /* ... */ so that they aren't in docparse.
> IMHO docparse can mention some commit if wanted to add some description,
> but just as 5f955f26f3d4 or 5f955f26f3d4 ("xfs: report crtime and
> attribute flags to statx") if the commit subject is a description
> itself.
>
Good to know this. I agree to remove those commit info as you
did in this patch. To be honest, I don't think that helps people in
code reading, they are just as reductant info pointer to the feature's
commit id.
Reviewed-by: Li Wang <liwang@redhat.com>
--
Regards,
Li Wang
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.linux.it/pipermail/ltp/attachments/20220819/5789dba2/attachment.htm>
More information about the ltp
mailing list