[dpdk-dev] [PATCH 1/8] vhost: add security model documentation to vhost_user.c

[Kovacevic, Marko]

<...>

> > This is a useful comment but I don't know if it makes sense to include it in
> the vhost_user.c file.
> >
> > Particularly at the top where it looks like a general descriptive comment for
> the file.
> >
> > It would probably be better in the vhost-user section of the programmer's
> guide:
> >
> > http://dpdk.org/doc/guides/prog_guide/vhost_lib.html
> 
> That is the public API documentation for users of the library.  They don't
> parse VhostUserMsg so I'm not sure the comment would be relevant there.
> 
> > Also, the subject line shouldn't include an underscore.
> 
> Do you mean the "vhost_user.c" filename in the subject line?
> 
> Please explain why this isn't allowed.
> 
> Stefan


You can run this command to check the git log.

./devtools/check-git-log.sh -1

Running git check log on HEAD~1:  34962
======================================
Wrong headline format:
        vhost: add security model documentation to vhost_user.c