[LTP] [PATCH 1/1] statx04: Remove kernel comments in docparse

[Li Wang]

Hi Xu, Petr,

Petr Vorel <pvorel@suse.cz> wrote:

> I remember Amir also added a similar feature[1] to xfstests when he
> > become xfs 5.10 stable kernel maintainer.
>
> > So maybe we can add a third colume in tst_test struct's tag field  to
> > cover kernel commit title? Then this kernel comment can be removed.
>

We can achieve that but the complexity outweighs the benefits (for LTP).


>
> Amir got inspiration from LTP, but I'm not a big fan of adding manually git
> subject which is now added by script.  Also I'd like to address the change
> we
> agree also in fanotify sources.


> > Also, I don't have strong obejection to this patch because it seems
> > duplicate, but I just want to keep kernel commit title by using simple
> way.
>
> I also wonder why people add commits in this verbose form:
>

That's legacy way in writing comments, but obviously it need unify in format
for better management in future.



>
>  *  commit 93bc420ed41df63a18ae794101f7cbf45226a6ef
>  *  Author: yangerkun <yangerkun@huawei.com>
>  *  Date:   Mon Feb 18 09:07:02 2019 +0800
>  *
>  *  ext2: support statx syscall
>
> If commits are really necessary I'd add them inline, i.e.:
>
> $ git log --pretty=format:'%h ("%s")' -1 93bc420ed41d
> 93bc420ed41d ("ext2: support statx syscall")
>

+1, at most we add this format in normal C comments.
https://github.com/linux-test-project/ltp/blob/master/testcases/kernel/syscalls/fanotify/fanotify14.c#L17



> But again, having git hash at the bottom and then full commit on the top
> looks
> to me just a redundancy (I often want to see changes in kernel thus run
> git show
> hash anyway + there is that link in docparse.
>

me as well.

-- 
Regards,
Li Wang
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.linux.it/pipermail/ltp/attachments/20220820/487138fa/attachment.htm>