[dpdk-dev] [PATCH v2] scripts: add git hook scripts for checkpatch and auto doc generation

[Ferruh Yigit]

On Thu, Dec 03, 2015 at 11:09:30AM -0800, Thomas Monjalon wrote:
> Ferruh,
> I have a lot of questions :)
> 
> 2015-11-27 14:34, Ferruh Yigit:
> > --- a/scripts/checkpatches.sh
> > +++ b/scripts/checkpatches.sh
> > @@ -43,6 +43,7 @@ length=${DPDK_CHECKPATCH_LINE_LENGTH:-80}
> >  
> >  # override default Linux options
> >  options="--no-tree"
> > +options="$options ${GIT_HOOK_OPTIONS}"
> 
> What is the purpose of this variable?
> Why adding some options would be specific to git hooks?
> 
When you use "commit -s", sign-off msg added after this script run,
also when you do "commit --ammend" that piece of patch does not have sign-off part,
so pre-commit hook can have problems with sign-off check and git hook specific option is to pass --no-signoff option.

> > +++ b/scripts/git-hooks/deploy.sh
> > @@ -0,0 +1,20 @@
> > +
> > +SELF=$(basename $0)
> > +
> > +if [ ! -f ${SELF} ]; then
> > +	echo "Please run script from folder where script is"
> > +	exit 1
> > +fi
> 
> You do not need to exit. Just cd $(dirname $0).
> 
Thanks, I will do that.


> > +for f in ${FILES}; do
> > +	ln -sf ${SCRIPT_FOLDER}/${f} ${TARGET_FOLDER}/${f}
> > +done;
> 
> You do not need the ;
> 
OK

> > --- /dev/null
> > +++ b/scripts/git-hooks/post-commit
> > +if [ -n "$RTE_DOC_OUT" ]; then
> > +	OUT_CMD="O=${RTE_DOC_OUT}"
> > +fi
> 
> How to pass RTE_DOC_OUT to the hook?
> Why not use load-devel-config.sh?
> 
It is possbile pass by exporting it as environment variable,
but since load-devel-config is already there, I will use it.

> > +make ${OUT_CMD} doc-guides-html 2>&1 > /dev/null
> > +make ${OUT_CMD} doc-api-html 2>&1 > /dev/null
> 
> Why hiding the errors?
> 
To prevent noise, but I double check and enabling error messages not noisy, so I will enable it.

> > --- /dev/null
> > +++ b/scripts/git-hooks/post-merge
> 
> Does it work for "git pull --rebase"?

No, it is not working, for that pre-rebase is required,
easy to create a link for that but I am not sure about increasing number of hooks,
with pre-rebase hook, an internal rebase too will trigger doc generation, which is not good I believe.

> 
> > --- /dev/null
> > +++ b/scripts/git-hooks/pre-commit
> > +# If "git commit" called with "--no-verify" option, pre-commit hooks
> > +# bypassed and this script not called, checkpatch bypassed
> 
> Possible reword: It is skipped with the option "--no-verify" of "git commit".
> 
OK, thanks.

> > +RTE_CHECKPATCH=$PWD/scripts/checkpatches.sh
> 
> What is PWD when calling the hook. May it be a subdir?
> 
Even you call git commands from a subdir, git hooks scripts run from root dir, so this will be always correct.


> > +PATCH=/tmp/dpdk-git-auto-checkpatch-$$.patch
> 
> You need to remove this temporary file when exiting.
> But it would be better to use stdin.
> It may need a patch on checkpatches.sh wrapper.
> In chekpatch.pl: "When FILE is - read standard input".
> 
I also prefer using stdin, and previous patch was like that,
but checkpatches.sh requires a file, let me check possible update in checkpatches.sh

> > +export GIT_HOOK_OPTIONS=--no-signoff
> 
> This variable is wrongly named.
> 
Will rename.

> > +git diff --cached > ${PATCH}
> > +exec ${RTE_CHECKPATCH} ${PATCH}
> 
> When the new "make install" will be applied, I think we should skip
> these files. Please consider patching mk/rte.sdkinstall.mk.

ok, I will update skdinstall.mk


Thanks for the review.

ferruh