diff options
Diffstat (limited to '.git-hooks')
| -rw-r--r-- | .git-hooks/README | 22 | ||||
| -rwxr-xr-x | .git-hooks/commit-msg | 135 | ||||
| -rwxr-xr-x | .git-hooks/post-merge | 12 | ||||
| -rwxr-xr-x | .git-hooks/pre-commit | 451 |
4 files changed, 620 insertions, 0 deletions
diff --git a/.git-hooks/README b/.git-hooks/README new file mode 100644 index 0000000000..62a16c1de6 --- /dev/null +++ b/.git-hooks/README @@ -0,0 +1,22 @@ +Git hooks are executable scripts you can place in $GIT_DIR/hooks directory to trigger action at certain points. + +To install manually, run: + + cd .git/hooks && ln -s ../../.git-hooks/* ./ + +When you using GIT for Windows, you need Windows links +Open a Dos-Box with admin rights then + cd .git/hooks + FOR /F " usebackq " %i IN (`dir /b ..\..\.git-hooks`) DO del /as /f %i & del %i & mklink %i ..\..\.git-hooks\%i +the error 'Could Not Find ...' can be ignore + +There are two groups of these hooks: client side and server side. + +The client-side hooks: +are for client operations such as committing and merging. + +The server-side hooks: +are for Git server operations such as receiving pushed commits. + +See Also [ http://git-scm.com/book/en/Customizing-Git-Git-Hooks ] + diff --git a/.git-hooks/commit-msg b/.git-hooks/commit-msg new file mode 100755 index 0000000000..950a6b709d --- /dev/null +++ b/.git-hooks/commit-msg @@ -0,0 +1,135 @@ +#!/bin/sh +# +# Called by git-commit with one argument, the name of the file +# that has the commit message. The hook should exit with non-zero +# status after issuing an appropriate message if it wants to stop the +# commit. The hook is allowed to edit the commit message file. +# +# To enable this hook, make this file executable. + +# avoid [[ which is not POSIX sh. + +if test "$#" != 1 ; then + echo "$0 requires an argument." + exit 1 +fi + +if test ! -f "$1" ; then + echo "file does not exist: $1" + exit 1 +fi + +abort() { + cp $1 $1.save + cat >&2 <<EOF +Commit aborted, your commit message was saved as '$1.save'. + +Reason: $2 + +EOF + exit 1 +} + +test "" = "$(grep '^Signed-off-by: ' "$1" | + sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || { + abort "$1" "Duplicate Signed-off-by lines." +} + +# Check that the first line exists, and is not an asterisk + +if [ -z "`head -n 1 $1 | grep -v '^[[:blank:]]*\*$'`" ] ; then + abort "$1" "Please provide the general description on the first line." +fi + +# ...and that it is not too long + +len="`head -n 1 $1 | tr -d '\n' | wc -c`" +if [ "$len" -gt 79 ] ; then + abort "$1" "The first line is $len characters, please try to fit into 79 characters." +fi + +fdo_regex='fdo#[0-9]+' +if grep -E -q "$fdo_regex" $1; then + for bugid in `head -n 1 $1 | grep -E -o "$fdo_regex" |sed 's/fdo#//'` + do + if [ "`echo $bugid |sed 's/fdo#//'`" -gt 88775 ]; then + abort "$1" "The first line contains a suspicious fdo# rereference: 'fdo#$bugid', did you mean tdf#?" + fi + done +fi + +# ...and that it does not continue on the second line +if [ "`wc -l < $1`" -gt 1 -a -n "`head -n 2 $1 | tail -n 1 | sed 's/^#.*//'`" ] ; then + abort "$1" "The second line is not empty - maybe the first line continues there?" +fi + +# Check that the message is not a ChangeLog-like one + +if [ -n "`head -n 1 $1 | grep '^[0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}.*<.*@.*>'`" ] ; then + abort "$1" "The commit message looks like ChangeLog, please use the git form." +fi + +# Check that lines do not start with '#<something>' (possibly accidental commit, +# such as starting the message with '#ifdef', git commits start with '#<whitespace>'. + +if [ -n "`grep '^#[^[:blank:]]' $1`" ] ; then + abort "$1" "Possible accidental comment in the commit message (leading # without space)." +fi + +# From Gerrit Code Review 2.16.15 +# +# Part of Gerrit Code Review (https://www.gerritcodereview.com/) +# +# Copyright (C) 2009 The Android Open Source Project +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Do not create a change id if requested +if test "false" = "`git config --bool --get gerrit.createChangeId`" ; then + exit 0 +fi + +# $RANDOM will be undefined if not using bash, so don't use set -u +random=$( (whoami ; hostname ; date; cat $1 ; echo $RANDOM) | git hash-object --stdin) +dest="$1.tmp.${random}" + +trap 'rm -f "${dest}"' EXIT + +if ! git stripspace --strip-comments < "$1" > "${dest}" ; then + echo "cannot strip comments from $1" + exit 1 +fi + +if test ! -s "${dest}" ; then + echo "file is empty: $1" + exit 1 +fi + +# Avoid the --in-place option which only appeared in Git 2.8 +# Avoid the --if-exists option which only appeared in Git 2.15 +if ! git -c trailer.ifexists=doNothing interpret-trailers \ + --trailer "Change-Id: I${random}" < "$1" > "${dest}" ; then + echo "cannot insert change-id line in $1" + exit 1 +fi + +if ! mv "${dest}" "$1" ; then + echo "cannot mv ${dest} to $1" + exit 1 +fi + +#------------------ copied gerrit commit-msg hook to handle ChangeId <-- + +exit 0 + +# vi:set shiftwidth=4 expandtab: diff --git a/.git-hooks/post-merge b/.git-hooks/post-merge new file mode 100755 index 0000000000..b1be51202a --- /dev/null +++ b/.git-hooks/post-merge @@ -0,0 +1,12 @@ +#!/bin/sh + +# Do not warn if there were no real merge +git rev-parse -q --verify HEAD^2 >/dev/null || exit + +echo +echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!" +echo "! You probably used 'git pull' instead of 'git pull -r' !" +echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!" +echo +echo "You can still fix it - please do 'git pull -r' now." +echo diff --git a/.git-hooks/pre-commit b/.git-hooks/pre-commit new file mode 100755 index 0000000000..521ed202b9 --- /dev/null +++ b/.git-hooks/pre-commit @@ -0,0 +1,451 @@ +#!/usr/bin/env perl + +# A hook script to verify what is about to be committed. +# Called by "git commit" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message +# if it wants to stop the commit. + +use strict; +use lib "solenv/clang-format"; +#use File::Copy; +#use Cwd; + +$ENV{LC_ALL} = "C"; + +sub check_whitespaces($) +{ + my ($h) = @_; + my $src_limited = "bas|c|cpp|cxx|h|hrc|hxx|idl|inl|java|swift|map|MK|mm|pmk|pl|pm|sdi|sh|src|tab|ui|vb|xcu|xml|xsl|py"; + my $src_full = "bas|c|cpp|cxx|h|hrc|hxx|idl|inl|java|swift|map|mk|MK|mm|pmk|pl|pm|sdi|sh|src|tab|ui|vb|xcu|xml|xsl|py"; + + my %modules = (basctl=>'basctl', chart2=>'chart', cui=>'cui', dbaccess=>'dba', desktop=>'dkt', editeng=>'editeng', + extensions=>'pcr', filter=>'flt', formula=>'for', fpicker=>'fps', framework=>'fwk', reportdesign=>'rpt', + sc=>'sc', sd=>'sd', sfx2=>'sfx', starmath=>'sm', svtools=>'svt', svx=>'svx', sw=>'sw', uui=>'uui', + vcl=>'vcl', writerperfect=>'wpt', xmlsecurity=>'xsc'); + + my $found_bad = 0; + my $filename; + my $reported_filename = ""; + my $lineno; + sub bad_line + { + my ($why, $line, $file_filter) = @_; + if (!defined $file_filter || $filename =~ /\.($file_filter)$/) + { + if (!$found_bad) + { + print STDERR "*\n"; + print STDERR "* You have some suspicious patch lines:\n"; + print STDERR "*\n"; + $found_bad = 1; + } + if ($reported_filename ne $filename) + { + print STDERR "* In $filename\n"; + $reported_filename = $filename; + } + print STDERR "* $why (line $lineno)\n"; + print STDERR "$filename:$lineno:$line\n"; + } + } + open( FILES, "git diff-index -p -M --cached $h |" ) || die "Cannot run git diff-index."; + while (<FILES>) + { + if (m|^diff --git a/(.*) b/\1$|) + { + $filename = $1; + next; + } + if (/^@@ -\S+ \+(\d+)/) + { + $lineno = $1 - 1; + next; + } + if (/^ /) + { + $lineno++; + next; + } + if (s/^\+//) + { + $lineno++; + chomp; + if (/\s$/) + { + bad_line("trailing whitespace", $_ , $src_limited); + } + if (/\r$/) + { + bad_line("DOS lineends", $_ , $src_limited); + } + if (/\s* /) + { + bad_line("indent with Tab", $_, $src_limited); + } + if (/^(?:[<>=]){7}$/) + { + bad_line("unresolved merge conflict", $src_full); + } + if (/SAL_DEBUG/) + { + bad_line("temporary debug in commit", $_, $src_limited); + } + if ((/OOXMLIMPORT/) and ($filename =~ /ooxmlexport/)) + { + bad_line("OOXMLIMPORT definition used in a ooxmlexport file", $_, "cxx"); + } + if ((/OOXMLEXPORT/) and ($filename =~ /ooxmlimport/)) + { + bad_line("OOXMLEXPORT definition used in a ooxmlimport file", $_, "cxx"); + } + if ((/<toolbar:toolbaritem/) and not(/\/>/)) + { + bad_line("Use /> to close toolbar:toolbaritem", $_, "xml"); + } + if (/<property name="use[-_]markup">True<\/property>/) + { + bad_line("use font attributes instead of use-markup", $_, "ui"); + } + if (/<property name="tooltip[-_]markup"/ ) + { + bad_line("use tooltip-text instead of tooltip_markup", $_, "ui"); + } + if (/<property name="margin[-_]left"/ ) + { + bad_line("use margin-start instead of margin-left", $_, "ui"); + } + if (/<property name="margin[-_]right"/ ) + { + bad_line("use margin-end instead of margin-right", $_, "ui"); + } + if (/<object class="GtkAlignment"/) + { + bad_line("use margin-start (etc) on child instead of a GtkAlignment", $_, "ui"); + } + if (/<property name="use[-_]stock"/ ) + { + bad_line("use translation context 'stock' and the English string as button label instead", $_, "ui"); + } + if (/<property name="stock[-_]id"/ ) + { + bad_line("use an icon-name listed at https://developer.gnome.org/gtk3/stable/gtk3-Stock-Items.html", $_, "ui"); + } + if (/<property name="stock"/ ) + { + bad_line("use an icon-name listed at https://developer.gnome.org/gtk3/stable/gtk3-Stock-Items.html", $_, "ui"); + } + if ((/translatable="yes"/) and not(/context=/)) + { + bad_line("translatable .ui file line without context", $_, "ui"); + } + if ((/requires/) and (/lib="gtk+/) and not (/version="3.20/)) + { + bad_line("min supported version of gtk3 is 3.20", $_, "ui"); + } + if ((/<interface/) and not(/domain=/)) + { + bad_line(".ui file without translation domain", $_, "ui"); + } + if (/<interface domain=/) + { + foreach my $key (keys %modules) { + if ((rindex($filename, $key, 0) == 0) and not (/$modules{$key}/)) + { + bad_line("interface domain should be '$modules{$key}'", $_, "ui"); + } + } + } + } + } + if ( $found_bad) + { + exit($found_bad); + } +} + +sub check_author() +{ + my $author = `git var GIT_AUTHOR_IDENT`; + chomp $author; + if ($author =~ /^Your Name <you\@example.com>/) + { + print("ERROR: You have a suspicious author identity: '$author'\n"); + exit(1); + } +} + +sub check_style($) +{ + if (! -e "solenv/clang-format/ClangFormat.pm") + { + # Commit happens in a submodule. + return; + } + + require ClangFormat; + ClangFormat->import(); + + my ($h) = @_; + my $src = ClangFormat::get_extension_regex(); + my @bad_names = (); + my @bad_renames = (); + my $clang_format = ClangFormat::find(); + + ## Check if ClangFormat has get_excludelist or the old + ## get_blacklist + my $excluded_list_names; + eval { ClangFormat::get_excludelist() }; + if ($@) { $excluded_list_names = ClangFormat::get_blacklist(); } + else { $excluded_list_names = ClangFormat::get_excludelist(); } + + # Get a list of renamed files. + my %renames; # key is target pathname, value is source pathname + open (IN, "git diff-index --cached --find-renames --diff-filter=R --name-status $h |") + || die "Cannot run git diff."; + while (my $line = <IN>) + { + chomp $line; + $line =~ /^[^\t]+\t([^\t]+)\t([^\t]+)$/ || die "Unexpected response line: $line"; + $renames{$2} = $1; + } + + # Get a list of non-deleted changed files. + open (FILES, "git diff-index --cached --diff-filter=AM --name-only $h |") || die "Cannot run git diff."; + while (my $filename = <FILES>) + { + chomp $filename; + if ($filename =~ /\.($src)$/ and !exists($excluded_list_names->{$filename})) + { + if (!defined($clang_format)) + { + my $version = ClangFormat::get_wanted_version(); + my $opt_lo = ClangFormat::get_own_directory(); + + print("\nWARNING: Commit touches new (non-excluded) files, but no clang-format" + . " ${version}\n"); + print(" found (via CLANG_FORMAT or PATH env vars, or in ${opt_lo}).\n\n"); + + my $platform = "linux64"; + my $download = "wget"; + if ($^O eq "cygwin") + { + $platform = "win.exe"; + } + elsif ($^O eq "darwin") + { + $platform = "mac"; + $download = "curl -O"; + } + + print("To get a suitable binary, please do:\n\n"); + print("mkdir -p $opt_lo\n"); + print("cd $opt_lo\n"); + print("$download https://dev-www.libreoffice.org/bin/clang-format-$version-$platform\n"); + print("cp clang-format-$version-$platform clang-format\n"); + print("chmod +x clang-format\n\n"); + + print("(Or read solenv/clang-format/README on how to build it yourself.\n"); + return; + } + if (!ClangFormat::check_style($clang_format, $filename)) + { + if (defined($renames{$filename})) + { + push @bad_renames, $filename; + } + else + { + push @bad_names, $filename; + } + } + } + } + + # Enforce style. + if (scalar @bad_names || scalar @bad_renames) + { + my $autostyle = `git config libreoffice.autostyle`; + chomp $autostyle; + if ($autostyle ne "true" or scalar @bad_renames) + { + print("\nThe above differences were found between the code to commit \n"); + print("and the clang-format rules.\n"); + if (scalar @bad_names) + { + print("You can apply these changes with:\n"); + print("\n$clang_format -i " . join(" ", @bad_names) . "\n\n"); + } + if (scalar @bad_renames) + { + print("\nATTENTION: Of files detected as renamed by git, the following ones are\n"); + print("not clang-format'ed and are not listed in the excludelist. If they are\n"); + print("renames of previously excluded files, they should be added to the\n"); + print("excludelist:\n\n"); + foreach my $name (@bad_renames) + { + if (exists($excluded_list_names->{$renames{$name}})) + { + print("* $name got renamed from $renames{$name},\n"); + print(" which is even still listed in the excludelist!\n"); + } + else + { + print("* $name\n"); + } + } + print("\n"); + } + print("Aborting commit. Apply changes and commit again or skip checking\n"); + print("with --no-verify (not recommended).\n"); + exit(1); + } + else + { + # 'git config libreoffice.autostyle true' was invoked to run + # clang-format automatically. + print("\nThe above differences were found between the code to commit \n"); + print("and the clang-format rules. Fixing these now automatically.\n"); + print("Running '$clang_format -i " . join(" ", @bad_names) . "' for you...\n"); + system("$clang_format -i " . join(" ", @bad_names)); + # TODO this stages all local modifications, staging originally + # unstaged hunks. + system("git add " . join(" ", @bad_names)); + print("Done.\n"); + } + } +} + +sub check_submodules($) +{ + my ($h) = @_; + + my $toplevel = `git rev-parse --show-toplevel`; + chomp $toplevel; + + # trick to get a list of submodules - directly read from the .gitmodules + open(SUBMODULES, "git config --file '$toplevel'/.gitmodules --get-regexp path | awk '{ print \$2 }' |" ) || die "Cannot run git config on the .gitmodules."; + while (<SUBMODULES>) + { + chomp; + + my $ignore = `git config submodule.$_.ignore`; + chomp $ignore; + if ($ignore eq 'all') + { + print <<EOM; +Error: Your git configuration has submodule.$_.ignore set to 'all'. + +This is dangerous and can lead to accidentally pushing unwanted changes to +submodules. + +To fix it, please do: + + git config --unset submodule.$_.ignore + +EOM + exit(1); + } + + my $diff = `git diff --cached --name-only -z $h -- $_`; + chomp $diff; + if ($diff ne '') + { + print <<EOM; +Error: You are trying to commit changes to submodule $_ from the main repo. + +Please do not do that, commit only to the submodule, the git hook on the +server will make sure the appropriate change is mirrored in the main repo. + +To remove the change, you can do: + + git submodule update $_ + +If it fails with 'error: Server does not allow request for unadvertised object', +run the following: + + git submodule sync + git submodule update $_ + +EOM + exit(1); + } + } +} + +# Do the work :-) + +# Initial commit: diff against an empty tree object +my $against="4b825dc642cb6eb9a060e54bf8d69288fbee4904"; +if ( system( "git rev-parse --verify HEAD >/dev/null 2>&1" ) == 0 ) +{ + $against="HEAD" +} + +# If you want to allow non-ascii filenames set this variable to true. +my $allownonascii=`git config hooks.allownonascii`; +chomp $allownonascii; + +# Cross platform projects tend to avoid non-ascii filenames; prevent +# them from being added to the repository. We exploit the fact that the +# printable range starts at the space character and ends with tilde. +if ( $allownonascii ne "true" && + # Note that the use of brackets around a tr range is ok here, (it's + # even required, for portability to Solaris 10's /usr/bin/tr), since + # the square bracket bytes happen to fall in the designated range. + `git diff --cached --name-only --diff-filter=A -z $against | \ + LC_ALL=C tr -d '[ -~]\\0'` ne "" ) +{ + print <<EOM; +Error: Attempt to add a non-ascii file name. + +This can cause problems if you want to work +with people on other platforms. + +To be portable it is advisable to rename the file ... + +If you know what you are doing you can disable this +check using: + + git config hooks.allownonascii true + +EOM + exit( 1 ); +} + +# Block large files. +open( FILES, "git diff --cached --name-only --diff-filter=A -z $against |" ) || die "Cannot run git diff-index."; +while (<FILES>) +{ + if (/\.ui$/) # .ui files can get large + { + continue; + } + if (/\.xsl$/) # XSLT + { + continue; + } + my $size = `git cat-file -s :$_`; + # For now let's say large is 500KB + my $limit = 500; + if ($size > $limit * 1024) + { + print "Error: Attempt to add a large file: $_, pleasy try to fit into $limit KB.\n"; + exit( 1 ); + } +} + +# fix whitespace in code +check_whitespaces( $against); + +# fix style in code +check_style($against); + +# catch missing author info +check_author(); + +# catch commits to the submodules +check_submodules($against); + +# all OK +exit( 0 ); +# vi:set shiftwidth=4 expandtab: |