diff options
| author | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2024-09-30 17:34:25 +0200 |
|---|---|---|
| committer | Benedikt Peetz <benedikt.peetz@b-peetz.de> | 2024-09-30 17:34:25 +0200 |
| commit | 05672f7435cfa419893b4282d49254390181833e (patch) | |
| tree | b99ab6849e2f3851c593a593b58d3b7d840ddfcf | |
| parent | build(cog.toml): Format *before* checking the formatting (diff) | |
| download | flake-templates-05672f7435cfa419893b4282d49254390181833e.tar.gz flake-templates-05672f7435cfa419893b4282d49254390181833e.zip | |
chore(version): v0.7.0 v0.7.0
Diffstat (limited to '')
128 files changed, 5639 insertions, 394 deletions
diff --git a/NEWS.md b/NEWS.md index 50ec250..ce70e16 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,6 +2,80 @@ All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines. - - - +## [v0.7.0](https://git.vhack.eu/soispha/flake-templates/compare/cf1f1262bdf2155495df682f121654b2aba04288..v0.7.0) - 2024-09-30 +#### Bug Fixes +- **(README)** Remove the `.md` suffix - ([2abc618](https://git.vhack.eu/soispha/flake-templates/commit/2abc618fa26da15be0e3a4843858e5a65a4ff6d6)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(cog.toml)** Update to the newest state - ([14f36c6](https://git.vhack.eu/soispha/flake-templates/commit/14f36c67265ecee14b55a477e8cfbd57c3580021)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Also remove the shipped `git_template`, after it's used - ([842dcd2](https://git.vhack.eu/soispha/flake-templates/commit/842dcd2298d20cb6067cf0f91e257dacf1f0cf3b)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Be smarter, when suggesting an owner name - ([f779704](https://git.vhack.eu/soispha/flake-templates/commit/f7797042c34b45f8cf34c4dc17ef37b4a16d2d6a)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Also re-add execution permissions to the `watch.sh` script - ([3cf777b](https://git.vhack.eu/soispha/flake-templates/commit/3cf777be092ebc83ec99db6d6398c9d5c6632dad)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Ensure that the template is properly formatted - ([cf174dc](https://git.vhack.eu/soispha/flake-templates/commit/cf174dc192c089fd1b57cf46322d963536346f0c)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Detect latex project by the `watch.sh` file - ([7fd2ba6](https://git.vhack.eu/soispha/flake-templates/commit/7fd2ba674dd3a83599680ea885a4c8c1a26fa2b4)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Also delete the init.local file, if it exists - ([daef614](https://git.vhack.eu/soispha/flake-templates/commit/daef61498396d6357db1da429b3cb5fbd0f639f5)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Don't delete the init file, if the exit reason was a missing dependency - ([5843e3d](https://git.vhack.eu/soispha/flake-templates/commit/5843e3d2a5ec1bb7cd4b802a2e3625ff9eb5e304)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Actually ask the user for the license ident - ([04a683a](https://git.vhack.eu/soispha/flake-templates/commit/04a683a66c01947142c1d26cdf9330ce1645e62a)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** State which binaries are required to run it - ([925feee](https://git.vhack.eu/soispha/flake-templates/commit/925feeeebd03024ab518c07b578c1892370ee985)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Don't try to assign the reuse template, replace it instead directly - ([807bf01](https://git.vhack.eu/soispha/flake-templates/commit/807bf019bad5c6fe7dc3e1dea953a3e69b41fbbb)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Add missing pipe - ([04e9339](https://git.vhack.eu/soispha/flake-templates/commit/04e93391f8f809cf1e9664bf2b054e0d0f18b70c)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/scripts/cprh.sh)** Remove - ([f9f9d37](https://git.vhack.eu/soispha/flake-templates/commit/f9f9d3741ad95a998a3073c3a824c83f3a98bef9)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/scripts/renew_copyright_header.sh)** Add further file extensions - ([ebff92d](https://git.vhack.eu/soispha/flake-templates/commit/ebff92daac2068a3745713e023878bd5dea1333f)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/treefmt.nix)** Improve the prettier formatting configuration - ([3fad714](https://git.vhack.eu/soispha/flake-templates/commit/3fad7144b1917878d8a2f2d1d54c539df2bc0f31)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(instantiate_templates.sh)** Ensure that the `./build` dir matches reality - ([7028841](https://git.vhack.eu/soispha/flake-templates/commit/7028841b501e3411d3f446d2bcde99c0382085ce)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates)** Replace licensure by reuse - ([0e5fe03](https://git.vhack.eu/soispha/flake-templates/commit/0e5fe03143ae24763139ee04c9de5c62c4900516)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates)** Remove now unneeded licenses - ([52ae069](https://git.vhack.eu/soispha/flake-templates/commit/52ae069a44df653b5263c7f8802435e0c94e527e)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates)** Remove last remnants of the old in-place instantiating system - ([cd9f8c3](https://git.vhack.eu/soispha/flake-templates/commit/cd9f8c3ea26803b9730aa98e78d9cd7e57bd3bff)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates.nix)** Adapt to new latex academia subdirectory - ([ed06a62](https://git.vhack.eu/soispha/flake-templates/commit/ed06a62fe747c5927c59a0d3e7e4e100f2304194)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates.nix)** Use better wording regarding `./init` - ([6a26c22](https://git.vhack.eu/soispha/flake-templates/commit/6a26c2200367686532f553f8a06548c98d106b73)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/c)** Support multiple input files in makefile - ([6801029](https://git.vhack.eu/soispha/flake-templates/commit/6801029214469b0d94a134220fa2fdacf26ee747)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/latex)** Switch to lpm's new upstream - ([4f939eb](https://git.vhack.eu/soispha/flake-templates/commit/4f939eb9d74b16488d36adee8bc9a350e4112710)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/latex)** Change the `lpm.toml` to use new features - ([a96b91a](https://git.vhack.eu/soispha/flake-templates/commit/a96b91a5d8fb17b35adc179679f5eda67741d946)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/latex/academia)** Also use the init variables in the title - ([7505fed](https://git.vhack.eu/soispha/flake-templates/commit/7505fed575d85b9a5ab67dd48ce43a766cac1ab0)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/latex/letter)** Improve standard latex settings - ([115b83d](https://git.vhack.eu/soispha/flake-templates/commit/115b83d1d9e76d98440ac3970a6126c1b636d857)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/latex/letter)** Also expose `init.local` - ([b9372c8](https://git.vhack.eu/soispha/flake-templates/commit/b9372c89cac00c7e5afa075e0a722c5c81697844)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/rust/cog.toml)** Update to perform new `reuse lint` - ([72e196d](https://git.vhack.eu/soispha/flake-templates/commit/72e196d31ddebdf7a517f5661d56cf955095e104)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/rust/update.sh)** Frist `upgrade` then `update` - ([52a2e38](https://git.vhack.eu/soispha/flake-templates/commit/52a2e385bd5fcc94a5cc2fce780e24b904499dba)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/{awk,c,latex,shell})** Use one shared `cog.toml` - ([cfa3e6c](https://git.vhack.eu/soispha/flake-templates/commit/cfa3e6ce5d8bce3ead72a2dfc81875bbd896d5f9)) - [@bpeetz](https://git.vhack.eu/bpeetz) +#### Build system +- **(cog.toml)** Format *before* checking the formatting - ([c8dc7db](https://git.vhack.eu/soispha/flake-templates/commit/c8dc7db0d3cd16592e54ecf220bbe44b59402d9e)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(instantiate_templates.sh)** Actually also copy directory symlinks - ([3439005](https://git.vhack.eu/soispha/flake-templates/commit/343900545bd04cfdb97f80386635500131238ec3)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(instantiate_templates.sh)** Only copy files tracked by git - ([103e6dd](https://git.vhack.eu/soispha/flake-templates/commit/103e6ddb061248bff57e1df2cd737dfc6dc9bdb5)) - [@bpeetz](https://git.vhack.eu/bpeetz) +#### Documentation +- **(README)** Specify the formatting language - ([1bfb98d](https://git.vhack.eu/soispha/flake-templates/commit/1bfb98db7532e6b9984be5fbc4f255fd37026152)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(README)** init - ([7307e6c](https://git.vhack.eu/soispha/flake-templates/commit/7307e6c94d9558dc19dfaea0871d2a3095b4e957)) - [@bpeetz](https://git.vhack.eu/bpeetz) +#### Features +- **(common)** Replace the hand-crafted licensing approach with reuse - ([6596697](https://git.vhack.eu/soispha/flake-templates/commit/65966971a298f00303dae4783402cbb827798a7f)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Perform the first run of `reuse` on init - ([474d732](https://git.vhack.eu/soispha/flake-templates/commit/474d732b61673c311b212262fc4fee88430bbced)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Ship a full git_template - ([e0d14f7](https://git.vhack.eu/soispha/flake-templates/commit/e0d14f7b20a6e859a988206b4e16981d6a67bf87)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Support template specific drop-in scripts - ([1145865](https://git.vhack.eu/soispha/flake-templates/commit/11458653d356642cd6d89accefe0bb4027175cc1)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Set `git.vhack.eu` as default git upstream - ([57f1f80](https://git.vhack.eu/soispha/flake-templates/commit/57f1f80f8cfb2bf19e5c7efe903ee4123daded97)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/init)** Add basic handling of licenses - ([58078de](https://git.vhack.eu/soispha/flake-templates/commit/58078de0ca0ad563b90caec78190dc17f492678d)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/latex)** Add a `watch.sh` script - ([0837aab](https://git.vhack.eu/soispha/flake-templates/commit/0837aab929e88947d47a1a8c1492641169ee7127)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/latex)** Name the `main.tex` file after the project - ([ea08ac6](https://git.vhack.eu/soispha/flake-templates/commit/ea08ac63b52bdb4356921efcc145582bc412ad9f)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/latex/academia)** Support changing the language - ([86de16d](https://git.vhack.eu/soispha/flake-templates/commit/86de16dd27c67732a0e163c46c23314fcddfce5f)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/latex/letter)** Init - ([87f57f8](https://git.vhack.eu/soispha/flake-templates/commit/87f57f8fd676d37b6aa5d1b3a85197ac59cb1eb4)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/rust/Cargo.toml)** Add the required meta-data for `crates.io` - ([3584d8e](https://git.vhack.eu/soispha/flake-templates/commit/3584d8ecaa996f884b0cf2ae0b2c157a03a6c47c)) - [@bpeetz](https://git.vhack.eu/bpeetz) +#### Miscellaneous Chores +- **(COPYING)** Add a license - ([8e1eb4f](https://git.vhack.eu/soispha/flake-templates/commit/8e1eb4f46d33c6d2c0991ea51dfd5760d70b0721)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(build)** Update - ([0f4e169](https://git.vhack.eu/soispha/flake-templates/commit/0f4e1699e7eeaf393cebfd4b35a3be3b5a58fc75)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(build)** Regenerate - ([b241b00](https://git.vhack.eu/soispha/flake-templates/commit/b241b009646b36891e6b6c9d336357ed595d4dc7)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(build)** Regenerate - ([d4c8bfd](https://git.vhack.eu/soispha/flake-templates/commit/d4c8bfd6f9fc4617b8abf7296cf65bcf5f7cc395)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(build)** Update - ([4f2b735](https://git.vhack.eu/soispha/flake-templates/commit/4f2b735472eb921b5edd91c502e0a47d5e4d0cd2)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates)** Add the new `git_template` directory - ([88b91f0](https://git.vhack.eu/soispha/flake-templates/commit/88b91f0b28b172eabb6479c6c8e2aaaa9d9320be)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates)** Use new common files - ([15e4da6](https://git.vhack.eu/soispha/flake-templates/commit/15e4da626124710c58acb156c668cd5fb2733710)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/rust)** Quickly Update [THIS WILL BE REBASED] - ([cf1f126](https://git.vhack.eu/soispha/flake-templates/commit/cf1f1262bdf2155495df682f121654b2aba04288)) - [@bpeetz](https://git.vhack.eu/bpeetz) +#### Refactoring +- **(common)** Use symlinks to state, which files should be replaced - ([e4a3342](https://git.vhack.eu/soispha/flake-templates/commit/e4a334234b91f230571b5111a2b698230b27c660)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(common/)** Remove the `files` subdirectory - ([edc2a12](https://git.vhack.eu/soispha/flake-templates/commit/edc2a126900a7df96a1c7f1f6c96b6d8ad4f041b)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/)** Move `LICENSE.spdx` and `README.md` to `common` - ([9ffcfb2](https://git.vhack.eu/soispha/flake-templates/commit/9ffcfb2197bd5b721d18a730afb8eadfec9d41e7)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/latex)** Declare as an academia template - ([629bb89](https://git.vhack.eu/soispha/flake-templates/commit/629bb898769c8580db340078a8296fe551035a79)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(templates/latex/academia)** Use more common files - ([73d09bb](https://git.vhack.eu/soispha/flake-templates/commit/73d09bb9b771f0fbbb60cd4f91623db8fa4709d3)) - [@bpeetz](https://git.vhack.eu/bpeetz) +#### Style +- **(common/init)** Run through `nix fmt` - ([464cde4](https://git.vhack.eu/soispha/flake-templates/commit/464cde4508622057b621d68e8970a2f881b08c3a)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(instantiate_templates)** Use a function invocation - ([6de5196](https://git.vhack.eu/soispha/flake-templates/commit/6de519643b5fcbf188a3172e57d123917e8648b5)) - [@bpeetz](https://git.vhack.eu/bpeetz) +- **(treewide)** Re-format - ([01aea01](https://git.vhack.eu/soispha/flake-templates/commit/01aea01154b0ec1a9a87f6995b34f3638908313b)) - [@bpeetz](https://git.vhack.eu/bpeetz) + +- - - + ## [v0.6.2](https://codeberg.org/soispha/flake-templates/compare/daabd7681c082f944b0a20599f72a6793a7bc9eb..v0.6.2) - 2024-04-02 #### Bug Fixes - **(common/files/init)** Correctly add the man page chapter after name - ([daabd76](https://codeberg.org/soispha/flake-templates/commit/daabd7681c082f944b0a20599f72a6793a7bc9eb)) - [@bpeetz](https://codeberg.org/bpeetz) diff --git a/build/awk/README.md b/build/awk/README.md index 9c5c6da..6dad42c 100644 --- a/build/awk/README.md +++ b/build/awk/README.md @@ -3,6 +3,7 @@ > %INIT_DESCRIPTION ## Licensing + This project complies with the REUSE v3.2 specification. This means that every file clearly states its copyright. Please run `./scripts/cprh.sh contributer NAME EMAIL FILES..` after you diff --git a/build/awk/cog.toml b/build/awk/cog.toml index ea1b5e3..ebb3a5d 100644 --- a/build/awk/cog.toml +++ b/build/awk/cog.toml @@ -3,10 +3,10 @@ branch_whitelist = ["main", "prime"] ignore_merge_commits = false pre_bump_hooks = [ - "nix flake check", # verify the project builds - "./scripts/renew_copyright_header.sh", # update the license header in each file - "nix fmt", # format - "flake_version_update --version v{{version}} --input-file flake.nix", # update the version in the flake.nix file + "reuse lint", # Check licensing status. + "nix flake check", # Verify the project builds. + "flake_version_update --version v{{version}} --input-file flake.nix", # Bump the version in the flake.nix file + "nix fmt", # Format. ] post_bump_hooks = [ "git push", diff --git a/build/awk/git_template/config b/build/awk/git_template/config new file mode 100644 index 0000000..f0c8d31 --- /dev/null +++ b/build/awk/git_template/config @@ -0,0 +1,7 @@ +[remote "origin"] + url = %INIT_CLONE_URL + fetch = +refs/heads/*:refs/remotes/origin/* + pushurl = %INIT_PUSH_URL +[branch "%INIT_MAIN_BRANCH"] + remote = origin + merge = refs/heads/%INIT_MAIN_BRANCH diff --git a/build/awk/git_template/description b/build/awk/git_template/description new file mode 100644 index 0000000..bf2d1bf --- /dev/null +++ b/build/awk/git_template/description @@ -0,0 +1 @@ +%INIT_DESCRIPTION diff --git a/build/awk/git_template/hooks/applypatch-msg.sample b/build/awk/git_template/hooks/applypatch-msg.sample new file mode 100644 index 0000000..e6c87c6 --- /dev/null +++ b/build/awk/git_template/hooks/applypatch-msg.sample @@ -0,0 +1,15 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message taken by +# applypatch from an e-mail 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, rename this file to "applypatch-msg". + +. git-sh-setup +commitmsg="$(git rev-parse --git-path hooks/commit-msg)" +test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"} +: diff --git a/build/awk/git_template/hooks/commit-msg.sample b/build/awk/git_template/hooks/commit-msg.sample new file mode 100644 index 0000000..5604587 --- /dev/null +++ b/build/awk/git_template/hooks/commit-msg.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message. +# 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, rename this file to "commit-msg". + +# Uncomment the below to add a Signed-off-by line to the message. +# Doing this in a hook is a bad idea in general, but the prepare-commit-msg +# hook is more suited to it. +# +# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1" + +# This example catches duplicate Signed-off-by lines. + +test "" = "$(grep '^Signed-off-by: ' "$1" | + sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || { + echo >&2 Duplicate Signed-off-by lines. + exit 1 +} diff --git a/build/awk/git_template/hooks/fsmonitor-watchman.sample b/build/awk/git_template/hooks/fsmonitor-watchman.sample new file mode 100644 index 0000000..367d462 --- /dev/null +++ b/build/awk/git_template/hooks/fsmonitor-watchman.sample @@ -0,0 +1,174 @@ +#!/usr/bin/env perl + +use strict; +use warnings; +use IPC::Open2; + +# An example hook script to integrate Watchman +# (https://facebook.github.io/watchman/) with git to speed up detecting +# new and modified files. +# +# The hook is passed a version (currently 2) and last update token +# formatted as a string and outputs to stdout a new update token and +# all files that have been modified since the update token. Paths must +# be relative to the root of the working tree and separated by a single NUL. +# +# To enable this hook, rename this file to "query-watchman" and set +# 'git config core.fsmonitor .git/hooks/query-watchman' +# +my ($version, $last_update_token) = @ARGV; + +# Uncomment for debugging +# print STDERR "$0 $version $last_update_token\n"; + +# Check the hook interface version +if ($version ne 2) { + die "Unsupported query-fsmonitor hook version '$version'.\n" . + "Falling back to scanning...\n"; +} + +my $git_work_tree = get_working_dir(); + +my $retry = 1; + +my $json_pkg; +eval { + require JSON::XS; + $json_pkg = "JSON::XS"; + 1; +} or do { + require JSON::PP; + $json_pkg = "JSON::PP"; +}; + +launch_watchman(); + +sub launch_watchman { + my $o = watchman_query(); + if (is_work_tree_watched($o)) { + output_result($o->{clock}, @{$o->{files}}); + } +} + +sub output_result { + my ($clockid, @files) = @_; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # binmode $fh, ":utf8"; + # print $fh "$clockid\n@files\n"; + # close $fh; + + binmode STDOUT, ":utf8"; + print $clockid; + print "\0"; + local $, = "\0"; + print @files; +} + +sub watchman_clock { + my $response = qx/watchman clock "$git_work_tree"/; + die "Failed to get clock id on '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + + return $json_pkg->new->utf8->decode($response); +} + +sub watchman_query { + my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty') + or die "open2() failed: $!\n" . + "Falling back to scanning...\n"; + + # In the query expression below we're asking for names of files that + # changed since $last_update_token but not from the .git folder. + # + # To accomplish this, we're using the "since" generator to use the + # recency index to select candidate nodes and "fields" to limit the + # output to file names only. Then we're using the "expression" term to + # further constrain the results. + my $last_update_line = ""; + if (substr($last_update_token, 0, 1) eq "c") { + $last_update_token = "\"$last_update_token\""; + $last_update_line = qq[\n"since": $last_update_token,]; + } + my $query = <<" END"; + ["query", "$git_work_tree", {$last_update_line + "fields": ["name"], + "expression": ["not", ["dirname", ".git"]] + }] + END + + # Uncomment for debugging the watchman query + # open (my $fh, ">", ".git/watchman-query.json"); + # print $fh $query; + # close $fh; + + print CHLD_IN $query; + close CHLD_IN; + my $response = do {local $/; <CHLD_OUT>}; + + # Uncomment for debugging the watch response + # open ($fh, ">", ".git/watchman-response.json"); + # print $fh $response; + # close $fh; + + die "Watchman: command returned no output.\n" . + "Falling back to scanning...\n" if $response eq ""; + die "Watchman: command returned invalid output: $response\n" . + "Falling back to scanning...\n" unless $response =~ /^\{/; + + return $json_pkg->new->utf8->decode($response); +} + +sub is_work_tree_watched { + my ($output) = @_; + my $error = $output->{error}; + if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) { + $retry--; + my $response = qx/watchman watch "$git_work_tree"/; + die "Failed to make watchman watch '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + $output = $json_pkg->new->utf8->decode($response); + $error = $output->{error}; + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # close $fh; + + # Watchman will always return all files on the first query so + # return the fast "everything is dirty" flag to git and do the + # Watchman query just to get it over with now so we won't pay + # the cost in git to look up each individual file. + my $o = watchman_clock(); + $error = $output->{error}; + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + output_result($o->{clock}, ("/")); + $last_update_token = $o->{clock}; + + eval { launch_watchman() }; + return 0; + } + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + return 1; +} + +sub get_working_dir { + my $working_dir; + if ($^O =~ 'msys' || $^O =~ 'cygwin') { + $working_dir = Win32::GetCwd(); + $working_dir =~ tr/\\/\//; + } else { + require Cwd; + $working_dir = Cwd::cwd(); + } + + return $working_dir; +} diff --git a/build/awk/git_template/hooks/post-update.sample b/build/awk/git_template/hooks/post-update.sample new file mode 100644 index 0000000..e3b3f9f --- /dev/null +++ b/build/awk/git_template/hooks/post-update.sample @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare a packed repository for use over +# dumb transports. +# +# To enable this hook, rename this file to "post-update". + +exec git update-server-info diff --git a/build/awk/git_template/hooks/pre-applypatch.sample b/build/awk/git_template/hooks/pre-applypatch.sample new file mode 100644 index 0000000..c414f0e --- /dev/null +++ b/build/awk/git_template/hooks/pre-applypatch.sample @@ -0,0 +1,14 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed +# by applypatch from an e-mail message. +# +# The hook should exit with non-zero status after issuing an +# appropriate message if it wants to stop the commit. +# +# To enable this hook, rename this file to "pre-applypatch". + +. git-sh-setup +precommit="$(git rev-parse --git-path hooks/pre-commit)" +test -x "$precommit" && exec "$precommit" ${1+"$@"} +: diff --git a/build/awk/git_template/hooks/pre-commit.sample b/build/awk/git_template/hooks/pre-commit.sample new file mode 100644 index 0000000..55f180d --- /dev/null +++ b/build/awk/git_template/hooks/pre-commit.sample @@ -0,0 +1,49 @@ +#!/usr/bin/env bash +# +# An example 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. +# +# To enable this hook, rename this file to "pre-commit". + +if git rev-parse --verify HEAD >/dev/null 2>&1 +then + against=HEAD +else + # Initial commit: diff against an empty tree object + against=$(git hash-object -t tree /dev/null) +fi + +# If you want to allow non-ASCII filenames set this variable to true. +allownonascii=$(git config --type=bool hooks.allownonascii) + +# Redirect output to stderr. +exec 1>&2 + +# 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" != "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. + test $(git diff-index --cached --name-only --diff-filter=A -z $against | + LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0 +then + cat <<\EOF +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 +EOF + exit 1 +fi + +# If there are whitespace errors, print the offending file names and fail. +exec git diff-index --check --cached $against -- diff --git a/build/awk/git_template/hooks/pre-merge-commit.sample b/build/awk/git_template/hooks/pre-merge-commit.sample new file mode 100644 index 0000000..0ed3c36 --- /dev/null +++ b/build/awk/git_template/hooks/pre-merge-commit.sample @@ -0,0 +1,13 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed. +# Called by "git merge" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message to +# stderr if it wants to stop the merge commit. +# +# To enable this hook, rename this file to "pre-merge-commit". + +. git-sh-setup +test -x "$GIT_DIR/hooks/pre-commit" && + exec "$GIT_DIR/hooks/pre-commit" +: diff --git a/build/awk/git_template/hooks/pre-push.sample b/build/awk/git_template/hooks/pre-push.sample new file mode 100644 index 0000000..cb27ddb --- /dev/null +++ b/build/awk/git_template/hooks/pre-push.sample @@ -0,0 +1,53 @@ +#!/usr/bin/env bash + +# An example hook script to verify what is about to be pushed. Called by "git +# push" after it has checked the remote status, but before anything has been +# pushed. If this script exits with a non-zero status nothing will be pushed. +# +# This hook is called with the following parameters: +# +# $1 -- Name of the remote to which the push is being done +# $2 -- URL to which the push is being done +# +# If pushing without using a named remote those arguments will be equal. +# +# Information about the commits which are being pushed is supplied as lines to +# the standard input in the form: +# +# <local ref> <local oid> <remote ref> <remote oid> +# +# This sample shows how to prevent push of commits where the log message starts +# with "WIP" (work in progress). + +remote="$1" +url="$2" + +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') + +while read local_ref local_oid remote_ref remote_oid +do + if test "$local_oid" = "$zero" + then + # Handle delete + : + else + if test "$remote_oid" = "$zero" + then + # New branch, examine all commits + range="$local_oid" + else + # Update to existing branch, examine new commits + range="$remote_oid..$local_oid" + fi + + # Check for WIP commit + commit=$(git rev-list -n 1 --grep '^WIP' "$range") + if test -n "$commit" + then + echo >&2 "Found WIP commit in $local_ref, not pushing" + exit 1 + fi + fi +done + +exit 0 diff --git a/build/awk/git_template/hooks/pre-rebase.sample b/build/awk/git_template/hooks/pre-rebase.sample new file mode 100644 index 0000000..d062617 --- /dev/null +++ b/build/awk/git_template/hooks/pre-rebase.sample @@ -0,0 +1,169 @@ +#!/usr/bin/env bash +# +# Copyright (c) 2006, 2008 Junio C Hamano +# +# The "pre-rebase" hook is run just before "git rebase" starts doing +# its job, and can prevent the command from running by exiting with +# non-zero status. +# +# The hook is called with the following parameters: +# +# $1 -- the upstream the series was forked from. +# $2 -- the branch being rebased (or empty when rebasing the current branch). +# +# This sample shows how to prevent topic branches that are already +# merged to 'next' branch from getting rebased, because allowing it +# would result in rebasing already published history. + +publish=next +basebranch="$1" +if test "$#" = 2 +then + topic="refs/heads/$2" +else + topic=`git symbolic-ref HEAD` || + exit 0 ;# we do not interrupt rebasing detached HEAD +fi + +case "$topic" in +refs/heads/??/*) + ;; +*) + exit 0 ;# we do not interrupt others. + ;; +esac + +# Now we are dealing with a topic branch being rebased +# on top of master. Is it OK to rebase it? + +# Does the topic really exist? +git show-ref -q "$topic" || { + echo >&2 "No such branch $topic" + exit 1 +} + +# Is topic fully merged to master? +not_in_master=`git rev-list --pretty=oneline ^master "$topic"` +if test -z "$not_in_master" +then + echo >&2 "$topic is fully merged to master; better remove it." + exit 1 ;# we could allow it, but there is no point. +fi + +# Is topic ever merged to next? If so you should not be rebasing it. +only_next_1=`git rev-list ^master "^$topic" ${publish} | sort` +only_next_2=`git rev-list ^master ${publish} | sort` +if test "$only_next_1" = "$only_next_2" +then + not_in_topic=`git rev-list "^$topic" master` + if test -z "$not_in_topic" + then + echo >&2 "$topic is already up to date with master" + exit 1 ;# we could allow it, but there is no point. + else + exit 0 + fi +else + not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"` + /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -e ' + my $topic = $ARGV[0]; + my $msg = "* $topic has commits already merged to public branch:\n"; + my (%not_in_next) = map { + /^([0-9a-f]+) /; + ($1 => 1); + } split(/\n/, $ARGV[1]); + for my $elem (map { + /^([0-9a-f]+) (.*)$/; + [$1 => $2]; + } split(/\n/, $ARGV[2])) { + if (!exists $not_in_next{$elem->[0]}) { + if ($msg) { + print STDERR $msg; + undef $msg; + } + print STDERR " $elem->[1]\n"; + } + } + ' "$topic" "$not_in_next" "$not_in_master" + exit 1 +fi + +<<\DOC_END + +This sample hook safeguards topic branches that have been +published from being rewound. + +The workflow assumed here is: + + * Once a topic branch forks from "master", "master" is never + merged into it again (either directly or indirectly). + + * Once a topic branch is fully cooked and merged into "master", + it is deleted. If you need to build on top of it to correct + earlier mistakes, a new topic branch is created by forking at + the tip of the "master". This is not strictly necessary, but + it makes it easier to keep your history simple. + + * Whenever you need to test or publish your changes to topic + branches, merge them into "next" branch. + +The script, being an example, hardcodes the publish branch name +to be "next", but it is trivial to make it configurable via +$GIT_DIR/config mechanism. + +With this workflow, you would want to know: + +(1) ... if a topic branch has ever been merged to "next". Young + topic branches can have stupid mistakes you would rather + clean up before publishing, and things that have not been + merged into other branches can be easily rebased without + affecting other people. But once it is published, you would + not want to rewind it. + +(2) ... if a topic branch has been fully merged to "master". + Then you can delete it. More importantly, you should not + build on top of it -- other people may already want to + change things related to the topic as patches against your + "master", so if you need further changes, it is better to + fork the topic (perhaps with the same name) afresh from the + tip of "master". + +Let's look at this example: + + o---o---o---o---o---o---o---o---o---o "next" + / / / / + / a---a---b A / / + / / / / + / / c---c---c---c B / + / / / \ / + / / / b---b C \ / + / / / / \ / + ---o---o---o---o---o---o---o---o---o---o---o "master" + + +A, B and C are topic branches. + + * A has one fix since it was merged up to "next". + + * B has finished. It has been fully merged up to "master" and "next", + and is ready to be deleted. + + * C has not merged to "next" at all. + +We would want to allow C to be rebased, refuse A, and encourage +B to be deleted. + +To compute (1): + + git rev-list ^master ^topic next + git rev-list ^master next + + if these match, topic has not merged in next at all. + +To compute (2): + + git rev-list master..topic + + if this is empty, it is fully merged to "master". + +DOC_END diff --git a/build/awk/git_template/hooks/pre-receive.sample b/build/awk/git_template/hooks/pre-receive.sample new file mode 100644 index 0000000..0bf2643 --- /dev/null +++ b/build/awk/git_template/hooks/pre-receive.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to make use of push options. +# The example simply echoes all push options that start with 'echoback=' +# and rejects all pushes when the "reject" push option is used. +# +# To enable this hook, rename this file to "pre-receive". + +if test -n "$GIT_PUSH_OPTION_COUNT" +then + i=0 + while test "$i" -lt "$GIT_PUSH_OPTION_COUNT" + do + eval "value=\$GIT_PUSH_OPTION_$i" + case "$value" in + echoback=*) + echo "echo from the pre-receive-hook: ${value#*=}" >&2 + ;; + reject) + exit 1 + esac + i=$((i + 1)) + done +fi diff --git a/build/awk/git_template/hooks/prepare-commit-msg.sample b/build/awk/git_template/hooks/prepare-commit-msg.sample new file mode 100644 index 0000000..24283a0 --- /dev/null +++ b/build/awk/git_template/hooks/prepare-commit-msg.sample @@ -0,0 +1,42 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare the commit log message. +# Called by "git commit" with the name of the file that has the +# commit message, followed by the description of the commit +# message's source. The hook's purpose is to edit the commit +# message file. If the hook fails with a non-zero status, +# the commit is aborted. +# +# To enable this hook, rename this file to "prepare-commit-msg". + +# This hook includes three examples. The first one removes the +# "# Please enter the commit message..." help message. +# +# The second includes the output of "git diff --name-status -r" +# into the message, just before the "git status" output. It is +# commented because it doesn't cope with --amend or with squashed +# commits. +# +# The third example adds a Signed-off-by line to the message, that can +# still be edited. This is rarely a good idea. + +COMMIT_MSG_FILE=$1 +COMMIT_SOURCE=$2 +SHA1=$3 + +/nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE" + +# case "$COMMIT_SOURCE,$SHA1" in +# ,|template,) +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe ' +# print "\n" . `git diff --cached --name-status -r` +# if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;; +# *) ;; +# esac + +# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE" +# if test -z "$COMMIT_SOURCE" +# then +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE" +# fi diff --git a/build/awk/git_template/hooks/push-to-checkout.sample b/build/awk/git_template/hooks/push-to-checkout.sample new file mode 100644 index 0000000..07fa538 --- /dev/null +++ b/build/awk/git_template/hooks/push-to-checkout.sample @@ -0,0 +1,78 @@ +#!/usr/bin/env bash + +# An example hook script to update a checked-out tree on a git push. +# +# This hook is invoked by git-receive-pack(1) when it reacts to git +# push and updates reference(s) in its repository, and when the push +# tries to update the branch that is currently checked out and the +# receive.denyCurrentBranch configuration variable is set to +# updateInstead. +# +# By default, such a push is refused if the working tree and the index +# of the remote repository has any difference from the currently +# checked out commit; when both the working tree and the index match +# the current commit, they are updated to match the newly pushed tip +# of the branch. This hook is to be used to override the default +# behaviour; however the code below reimplements the default behaviour +# as a starting point for convenient modification. +# +# The hook receives the commit with which the tip of the current +# branch is going to be updated: +commit=$1 + +# It can exit with a non-zero status to refuse the push (when it does +# so, it must not modify the index or the working tree). +die () { + echo >&2 "$*" + exit 1 +} + +# Or it can make any necessary changes to the working tree and to the +# index to bring them to the desired state when the tip of the current +# branch is updated to the new commit, and exit with a zero status. +# +# For example, the hook can simply run git read-tree -u -m HEAD "$1" +# in order to emulate git fetch that is run in the reverse direction +# with git push, as the two-tree form of git read-tree -u -m is +# essentially the same as git switch or git checkout that switches +# branches while keeping the local changes in the working tree that do +# not interfere with the difference between the branches. + +# The below is a more-or-less exact translation to shell of the C code +# for the default behaviour for git's push-to-checkout hook defined in +# the push_to_deploy() function in builtin/receive-pack.c. +# +# Note that the hook will be executed from the repository directory, +# not from the working tree, so if you want to perform operations on +# the working tree, you will have to adapt your code accordingly, e.g. +# by adding "cd .." or using relative paths. + +if ! git update-index -q --ignore-submodules --refresh +then + die "Up-to-date check failed" +fi + +if ! git diff-files --quiet --ignore-submodules -- +then + die "Working directory has unstaged changes" +fi + +# This is a rough translation of: +# +# head_has_history() ? "HEAD" : EMPTY_TREE_SHA1_HEX +if git cat-file -e HEAD 2>/dev/null +then + head=HEAD +else + head=$(git hash-object -t tree --stdin </dev/null) +fi + +if ! git diff-index --quiet --cached --ignore-submodules $head -- +then + die "Working directory has staged changes" +fi + +if ! git read-tree -u -m "$commit" +then + die "Could not update working tree to new HEAD" +fi diff --git a/build/awk/git_template/hooks/sendemail-validate.sample b/build/awk/git_template/hooks/sendemail-validate.sample new file mode 100644 index 0000000..52aa61c --- /dev/null +++ b/build/awk/git_template/hooks/sendemail-validate.sample @@ -0,0 +1,77 @@ +#!/usr/bin/env bash + +# An example hook script to validate a patch (and/or patch series) before +# sending it via email. +# +# The hook should exit with non-zero status after issuing an appropriate +# message if it wants to prevent the email(s) from being sent. +# +# To enable this hook, rename this file to "sendemail-validate". +# +# By default, it will only check that the patch(es) can be applied on top of +# the default upstream branch without conflicts in a secondary worktree. After +# validation (successful or not) of the last patch of a series, the worktree +# will be deleted. +# +# The following config variables can be set to change the default remote and +# remote ref that are used to apply the patches against: +# +# sendemail.validateRemote (default: origin) +# sendemail.validateRemoteRef (default: HEAD) +# +# Replace the TODO placeholders with appropriate checks according to your +# needs. + +validate_cover_letter () { + file="$1" + # TODO: Replace with appropriate checks (e.g. spell checking). + true +} + +validate_patch () { + file="$1" + # Ensure that the patch applies without conflicts. + git am -3 "$file" || return + # TODO: Replace with appropriate checks for this patch + # (e.g. checkpatch.pl). + true +} + +validate_series () { + # TODO: Replace with appropriate checks for the whole series + # (e.g. quick build, coding style checks, etc.). + true +} + +# main ------------------------------------------------------------------------- + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = 1 +then + remote=$(git config --default origin --get sendemail.validateRemote) && + ref=$(git config --default HEAD --get sendemail.validateRemoteRef) && + worktree=$(mktemp --tmpdir -d sendemail-validate.XXXXXXX) && + git worktree add -fd --checkout "$worktree" "refs/remotes/$remote/$ref" && + git config --replace-all sendemail.validateWorktree "$worktree" +else + worktree=$(git config --get sendemail.validateWorktree) +fi || { + echo "sendemail-validate: error: failed to prepare worktree" >&2 + exit 1 +} + +unset GIT_DIR GIT_WORK_TREE +cd "$worktree" && + +if grep -q "^diff --git " "$1" +then + validate_patch "$1" +else + validate_cover_letter "$1" +fi && + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = "$GIT_SENDEMAIL_FILE_TOTAL" +then + git config --unset-all sendemail.validateWorktree && + trap 'git worktree remove -ff "$worktree"' EXIT && + validate_series +fi diff --git a/build/awk/git_template/hooks/update.sample b/build/awk/git_template/hooks/update.sample new file mode 100644 index 0000000..1910758 --- /dev/null +++ b/build/awk/git_template/hooks/update.sample @@ -0,0 +1,128 @@ +#!/usr/bin/env bash +# +# An example hook script to block unannotated tags from entering. +# Called by "git receive-pack" with arguments: refname sha1-old sha1-new +# +# To enable this hook, rename this file to "update". +# +# Config +# ------ +# hooks.allowunannotated +# This boolean sets whether unannotated tags will be allowed into the +# repository. By default they won't be. +# hooks.allowdeletetag +# This boolean sets whether deleting tags will be allowed in the +# repository. By default they won't be. +# hooks.allowmodifytag +# This boolean sets whether a tag may be modified after creation. By default +# it won't be. +# hooks.allowdeletebranch +# This boolean sets whether deleting branches will be allowed in the +# repository. By default they won't be. +# hooks.denycreatebranch +# This boolean sets whether remotely creating branches will be denied +# in the repository. By default this is allowed. +# + +# --- Command line +refname="$1" +oldrev="$2" +newrev="$3" + +# --- Safety check +if [ -z "$GIT_DIR" ]; then + echo "Don't run this script from the command line." >&2 + echo " (if you want, you could supply GIT_DIR then run" >&2 + echo " $0 <ref> <oldrev> <newrev>)" >&2 + exit 1 +fi + +if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then + echo "usage: $0 <ref> <oldrev> <newrev>" >&2 + exit 1 +fi + +# --- Config +allowunannotated=$(git config --type=bool hooks.allowunannotated) +allowdeletebranch=$(git config --type=bool hooks.allowdeletebranch) +denycreatebranch=$(git config --type=bool hooks.denycreatebranch) +allowdeletetag=$(git config --type=bool hooks.allowdeletetag) +allowmodifytag=$(git config --type=bool hooks.allowmodifytag) + +# check for no description +projectdesc=$(sed -e '1q' "$GIT_DIR/description") +case "$projectdesc" in +"Unnamed repository"* | "") + echo "*** Project description file hasn't been set" >&2 + exit 1 + ;; +esac + +# --- Check types +# if $newrev is 0000...0000, it's a commit to delete a ref. +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') +if [ "$newrev" = "$zero" ]; then + newrev_type=delete +else + newrev_type=$(git cat-file -t $newrev) +fi + +case "$refname","$newrev_type" in + refs/tags/*,commit) + # un-annotated tag + short_refname=${refname##refs/tags/} + if [ "$allowunannotated" != "true" ]; then + echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2 + echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2 + exit 1 + fi + ;; + refs/tags/*,delete) + # delete tag + if [ "$allowdeletetag" != "true" ]; then + echo "*** Deleting a tag is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/tags/*,tag) + # annotated tag + if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1 + then + echo "*** Tag '$refname' already exists." >&2 + echo "*** Modifying a tag is not allowed in this repository." >&2 + exit 1 + fi + ;; + refs/heads/*,commit) + # branch + if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then + echo "*** Creating a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/heads/*,delete) + # delete branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/remotes/*,commit) + # tracking branch + ;; + refs/remotes/*,delete) + # delete tracking branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a tracking branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + *) + # Anything else (is there anything else?) + echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2 + exit 1 + ;; +esac + +# --- Finished +exit 0 diff --git a/build/awk/git_template/info/exclude b/build/awk/git_template/info/exclude new file mode 100644 index 0000000..a5196d1 --- /dev/null +++ b/build/awk/git_template/info/exclude @@ -0,0 +1,6 @@ +# git ls-files --others --exclude-from=.git/info/exclude +# Lines that start with '#' are comments. +# For a project mostly in C, the following would be a good set of +# exclude patterns (uncomment them if you want to use them): +# *.[oa] +# *~ diff --git a/build/awk/init b/build/awk/init index 1ea1603..f8c8bb3 100644 --- a/build/awk/init +++ b/build/awk/init @@ -10,13 +10,18 @@ trap "cleanup; remove_self" EXIT cleanup() { rm "$replacement_file" } +avoid_cleanup="false" remove_self() { - rm "$(realpath "$0")" - rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + if [ "$avoid_cleanup" = "false" ]; then + rm "$(realpath "$0")" + rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + [ -f "$(realpath "$(dirname "$0")")/init.local" ] && rm "$(realpath "$(dirname "$0")")/init.local" + fi } require() { program="$1" if ! command -v "$program" >/dev/null; then + avoid_cleanup="true" echo "Please install '$program' for this init script to work." 1>&2 exit 1 fi @@ -64,8 +69,6 @@ require mv require sed require chmod -git init - # necessary meta data prompt APPLICATION_NAME "The name of the application" "$(basename "$PWD")" prompt APPLICATION_NAME_STYLIZED "The stylized name of the application (for documentation)" "$(echo "$APPLICATION_NAME" | sed 's/[_-]/ /g' | sed 's/^\(\w\)/\U\1/g' | sed 's/ \(\w\)/ \U\1/g')" @@ -78,7 +81,15 @@ prompt AUTHOR_EMAIL "The email of the author (or authors)" "$(git config --get u # cog change-log variables prompt REMOTE "The remote, this project will be pushed to" "git.vhack.eu" prompt REPOSITORY "The path of the repository on the remote" "$APPLICATION_NAME" -prompt OWNER "The name of owner of the repository" "$AUTHOR_NAME" + +owner1="$(printf "%.1s" "$AUTHOR_NAME")" +owner2="${AUTHOR_NAME#* }" +if [ "$owner2" = "$AUTHOR_NAME" ]; then + owner_build="$(echo "$AUTHOR_NAME" | tr '[:upper:]' '[:lower:]')" +else + owner_build="$(echo "$owner1$owner2" | tr '[:upper:]' '[:lower:]')" +fi +prompt OWNER "The name of owner of the repository" "$owner_build" # nice meta data prompt DESCRIPTION "The description of this project" "" @@ -88,7 +99,12 @@ prompt APPLICATION_SOURCE_CODE_REPOSITORY "The package's source code repository prompt HOME_PAGE "The home page URL of the project" "https://$REPOSITORY.org/" prompt BUG_URL "The URL people should report bugs to" "$APPLICATION_SOURCE_CODE_REPOSITORY/issues" -if [ -e ./lpm.toml ]; then +# git stuff +prompt PUSH_URL "The url used to push this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt CLONE_URL "The url used to clone this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt MAIN_BRANCH "The name of the main branch" "$(git config init.defaultbranch)" + +if [ -e ./watch.sh ]; then # Use a different default license in latex projects. init_default_license="CC-BY-SA-4.0" else @@ -105,7 +121,7 @@ fi prompt LICENSE_URL "The url of the license" "$default_license_url" if [ -e ./.reuse/templates/default.jinja2 ]; then - cat <<EOF | fmt --uniform-spacing --width=75 >./.reuse/templates/default.jinja2 + cat <<EOF | fmt --uniform-spacing --width=85 --split-only >./.reuse/templates/default.jinja2 {% for copyright_line in copyright_lines %} {{ copyright_line }} {% endfor %} @@ -120,14 +136,14 @@ This file is part of $APPLICATION_NAME_STYLIZED - $DESCRIPTION. You should have received a copy of the License along with this program. If not, see <$LICENSE_URL>. -<!-- vim: ft=htmldjango --> EOF fi # Allow templates to add template specific prompts [ -e init.local ] && . ./init.local -echo "$DESCRIPTION" >.git/description +git init --initial-branch "$MAIN_BRANCH" --template="./git_template" +rm --recursive ./git_template while read -r var; do var_name="${var%=*}" @@ -148,5 +164,19 @@ done <"$replacement_file" chmod +x scripts/* chmod +x update.sh [ -f ./build.sh ] && chmod +x build.sh +[ -f ./watch.sh ] && chmod +x build.sh + +# Do the first run of reuse annotate +reuse="$(nix build nixpkgs#reuse --no-link --print-out-paths)" +[ "$(echo "$reuse" | wc -l)" -ne 1 ] && die "Something is wrong with the nixpkgs#reuse derivation" + +git add . + +git diff --name-only --cached | + xargs -I {} "$reuse" annotate \ + --copyright "$AUTHOR_NAME <$AUTHOR_EMAIL>" \ + --copyright-style string-c \ + --template default \ + --license "$SPDX_LICENSE_IDENTIFIER" "{}" # vim: ft=sh diff --git a/build/c/README.md b/build/c/README.md index 9c5c6da..6dad42c 100644 --- a/build/c/README.md +++ b/build/c/README.md @@ -3,6 +3,7 @@ > %INIT_DESCRIPTION ## Licensing + This project complies with the REUSE v3.2 specification. This means that every file clearly states its copyright. Please run `./scripts/cprh.sh contributer NAME EMAIL FILES..` after you diff --git a/build/c/cog.toml b/build/c/cog.toml index ccca764..ebb3a5d 100644 --- a/build/c/cog.toml +++ b/build/c/cog.toml @@ -3,10 +3,10 @@ branch_whitelist = ["main", "prime"] ignore_merge_commits = false pre_bump_hooks = [ - "nix flake check", # verify the project builds - "./scripts/renew_copyright_header.sh", # update the license header in each file - "flake_version_update --version v{{version}} --input-file flake.nix", # update the version in the flake.nix file - "nix fmt", # format + "reuse lint", # Check licensing status. + "nix flake check", # Verify the project builds. + "flake_version_update --version v{{version}} --input-file flake.nix", # Bump the version in the flake.nix file + "nix fmt", # Format. ] post_bump_hooks = [ "git push", diff --git a/build/c/git_template/config b/build/c/git_template/config new file mode 100644 index 0000000..f0c8d31 --- /dev/null +++ b/build/c/git_template/config @@ -0,0 +1,7 @@ +[remote "origin"] + url = %INIT_CLONE_URL + fetch = +refs/heads/*:refs/remotes/origin/* + pushurl = %INIT_PUSH_URL +[branch "%INIT_MAIN_BRANCH"] + remote = origin + merge = refs/heads/%INIT_MAIN_BRANCH diff --git a/build/c/git_template/description b/build/c/git_template/description new file mode 100644 index 0000000..bf2d1bf --- /dev/null +++ b/build/c/git_template/description @@ -0,0 +1 @@ +%INIT_DESCRIPTION diff --git a/build/c/git_template/hooks/applypatch-msg.sample b/build/c/git_template/hooks/applypatch-msg.sample new file mode 100644 index 0000000..e6c87c6 --- /dev/null +++ b/build/c/git_template/hooks/applypatch-msg.sample @@ -0,0 +1,15 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message taken by +# applypatch from an e-mail 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, rename this file to "applypatch-msg". + +. git-sh-setup +commitmsg="$(git rev-parse --git-path hooks/commit-msg)" +test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"} +: diff --git a/build/c/git_template/hooks/commit-msg.sample b/build/c/git_template/hooks/commit-msg.sample new file mode 100644 index 0000000..5604587 --- /dev/null +++ b/build/c/git_template/hooks/commit-msg.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message. +# 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, rename this file to "commit-msg". + +# Uncomment the below to add a Signed-off-by line to the message. +# Doing this in a hook is a bad idea in general, but the prepare-commit-msg +# hook is more suited to it. +# +# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1" + +# This example catches duplicate Signed-off-by lines. + +test "" = "$(grep '^Signed-off-by: ' "$1" | + sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || { + echo >&2 Duplicate Signed-off-by lines. + exit 1 +} diff --git a/build/c/git_template/hooks/fsmonitor-watchman.sample b/build/c/git_template/hooks/fsmonitor-watchman.sample new file mode 100644 index 0000000..367d462 --- /dev/null +++ b/build/c/git_template/hooks/fsmonitor-watchman.sample @@ -0,0 +1,174 @@ +#!/usr/bin/env perl + +use strict; +use warnings; +use IPC::Open2; + +# An example hook script to integrate Watchman +# (https://facebook.github.io/watchman/) with git to speed up detecting +# new and modified files. +# +# The hook is passed a version (currently 2) and last update token +# formatted as a string and outputs to stdout a new update token and +# all files that have been modified since the update token. Paths must +# be relative to the root of the working tree and separated by a single NUL. +# +# To enable this hook, rename this file to "query-watchman" and set +# 'git config core.fsmonitor .git/hooks/query-watchman' +# +my ($version, $last_update_token) = @ARGV; + +# Uncomment for debugging +# print STDERR "$0 $version $last_update_token\n"; + +# Check the hook interface version +if ($version ne 2) { + die "Unsupported query-fsmonitor hook version '$version'.\n" . + "Falling back to scanning...\n"; +} + +my $git_work_tree = get_working_dir(); + +my $retry = 1; + +my $json_pkg; +eval { + require JSON::XS; + $json_pkg = "JSON::XS"; + 1; +} or do { + require JSON::PP; + $json_pkg = "JSON::PP"; +}; + +launch_watchman(); + +sub launch_watchman { + my $o = watchman_query(); + if (is_work_tree_watched($o)) { + output_result($o->{clock}, @{$o->{files}}); + } +} + +sub output_result { + my ($clockid, @files) = @_; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # binmode $fh, ":utf8"; + # print $fh "$clockid\n@files\n"; + # close $fh; + + binmode STDOUT, ":utf8"; + print $clockid; + print "\0"; + local $, = "\0"; + print @files; +} + +sub watchman_clock { + my $response = qx/watchman clock "$git_work_tree"/; + die "Failed to get clock id on '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + + return $json_pkg->new->utf8->decode($response); +} + +sub watchman_query { + my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty') + or die "open2() failed: $!\n" . + "Falling back to scanning...\n"; + + # In the query expression below we're asking for names of files that + # changed since $last_update_token but not from the .git folder. + # + # To accomplish this, we're using the "since" generator to use the + # recency index to select candidate nodes and "fields" to limit the + # output to file names only. Then we're using the "expression" term to + # further constrain the results. + my $last_update_line = ""; + if (substr($last_update_token, 0, 1) eq "c") { + $last_update_token = "\"$last_update_token\""; + $last_update_line = qq[\n"since": $last_update_token,]; + } + my $query = <<" END"; + ["query", "$git_work_tree", {$last_update_line + "fields": ["name"], + "expression": ["not", ["dirname", ".git"]] + }] + END + + # Uncomment for debugging the watchman query + # open (my $fh, ">", ".git/watchman-query.json"); + # print $fh $query; + # close $fh; + + print CHLD_IN $query; + close CHLD_IN; + my $response = do {local $/; <CHLD_OUT>}; + + # Uncomment for debugging the watch response + # open ($fh, ">", ".git/watchman-response.json"); + # print $fh $response; + # close $fh; + + die "Watchman: command returned no output.\n" . + "Falling back to scanning...\n" if $response eq ""; + die "Watchman: command returned invalid output: $response\n" . + "Falling back to scanning...\n" unless $response =~ /^\{/; + + return $json_pkg->new->utf8->decode($response); +} + +sub is_work_tree_watched { + my ($output) = @_; + my $error = $output->{error}; + if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) { + $retry--; + my $response = qx/watchman watch "$git_work_tree"/; + die "Failed to make watchman watch '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + $output = $json_pkg->new->utf8->decode($response); + $error = $output->{error}; + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # close $fh; + + # Watchman will always return all files on the first query so + # return the fast "everything is dirty" flag to git and do the + # Watchman query just to get it over with now so we won't pay + # the cost in git to look up each individual file. + my $o = watchman_clock(); + $error = $output->{error}; + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + output_result($o->{clock}, ("/")); + $last_update_token = $o->{clock}; + + eval { launch_watchman() }; + return 0; + } + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + return 1; +} + +sub get_working_dir { + my $working_dir; + if ($^O =~ 'msys' || $^O =~ 'cygwin') { + $working_dir = Win32::GetCwd(); + $working_dir =~ tr/\\/\//; + } else { + require Cwd; + $working_dir = Cwd::cwd(); + } + + return $working_dir; +} diff --git a/build/c/git_template/hooks/post-update.sample b/build/c/git_template/hooks/post-update.sample new file mode 100644 index 0000000..e3b3f9f --- /dev/null +++ b/build/c/git_template/hooks/post-update.sample @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare a packed repository for use over +# dumb transports. +# +# To enable this hook, rename this file to "post-update". + +exec git update-server-info diff --git a/build/c/git_template/hooks/pre-applypatch.sample b/build/c/git_template/hooks/pre-applypatch.sample new file mode 100644 index 0000000..c414f0e --- /dev/null +++ b/build/c/git_template/hooks/pre-applypatch.sample @@ -0,0 +1,14 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed +# by applypatch from an e-mail message. +# +# The hook should exit with non-zero status after issuing an +# appropriate message if it wants to stop the commit. +# +# To enable this hook, rename this file to "pre-applypatch". + +. git-sh-setup +precommit="$(git rev-parse --git-path hooks/pre-commit)" +test -x "$precommit" && exec "$precommit" ${1+"$@"} +: diff --git a/build/c/git_template/hooks/pre-commit.sample b/build/c/git_template/hooks/pre-commit.sample new file mode 100644 index 0000000..55f180d --- /dev/null +++ b/build/c/git_template/hooks/pre-commit.sample @@ -0,0 +1,49 @@ +#!/usr/bin/env bash +# +# An example 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. +# +# To enable this hook, rename this file to "pre-commit". + +if git rev-parse --verify HEAD >/dev/null 2>&1 +then + against=HEAD +else + # Initial commit: diff against an empty tree object + against=$(git hash-object -t tree /dev/null) +fi + +# If you want to allow non-ASCII filenames set this variable to true. +allownonascii=$(git config --type=bool hooks.allownonascii) + +# Redirect output to stderr. +exec 1>&2 + +# 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" != "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. + test $(git diff-index --cached --name-only --diff-filter=A -z $against | + LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0 +then + cat <<\EOF +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 +EOF + exit 1 +fi + +# If there are whitespace errors, print the offending file names and fail. +exec git diff-index --check --cached $against -- diff --git a/build/c/git_template/hooks/pre-merge-commit.sample b/build/c/git_template/hooks/pre-merge-commit.sample new file mode 100644 index 0000000..0ed3c36 --- /dev/null +++ b/build/c/git_template/hooks/pre-merge-commit.sample @@ -0,0 +1,13 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed. +# Called by "git merge" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message to +# stderr if it wants to stop the merge commit. +# +# To enable this hook, rename this file to "pre-merge-commit". + +. git-sh-setup +test -x "$GIT_DIR/hooks/pre-commit" && + exec "$GIT_DIR/hooks/pre-commit" +: diff --git a/build/c/git_template/hooks/pre-push.sample b/build/c/git_template/hooks/pre-push.sample new file mode 100644 index 0000000..cb27ddb --- /dev/null +++ b/build/c/git_template/hooks/pre-push.sample @@ -0,0 +1,53 @@ +#!/usr/bin/env bash + +# An example hook script to verify what is about to be pushed. Called by "git +# push" after it has checked the remote status, but before anything has been +# pushed. If this script exits with a non-zero status nothing will be pushed. +# +# This hook is called with the following parameters: +# +# $1 -- Name of the remote to which the push is being done +# $2 -- URL to which the push is being done +# +# If pushing without using a named remote those arguments will be equal. +# +# Information about the commits which are being pushed is supplied as lines to +# the standard input in the form: +# +# <local ref> <local oid> <remote ref> <remote oid> +# +# This sample shows how to prevent push of commits where the log message starts +# with "WIP" (work in progress). + +remote="$1" +url="$2" + +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') + +while read local_ref local_oid remote_ref remote_oid +do + if test "$local_oid" = "$zero" + then + # Handle delete + : + else + if test "$remote_oid" = "$zero" + then + # New branch, examine all commits + range="$local_oid" + else + # Update to existing branch, examine new commits + range="$remote_oid..$local_oid" + fi + + # Check for WIP commit + commit=$(git rev-list -n 1 --grep '^WIP' "$range") + if test -n "$commit" + then + echo >&2 "Found WIP commit in $local_ref, not pushing" + exit 1 + fi + fi +done + +exit 0 diff --git a/build/c/git_template/hooks/pre-rebase.sample b/build/c/git_template/hooks/pre-rebase.sample new file mode 100644 index 0000000..d062617 --- /dev/null +++ b/build/c/git_template/hooks/pre-rebase.sample @@ -0,0 +1,169 @@ +#!/usr/bin/env bash +# +# Copyright (c) 2006, 2008 Junio C Hamano +# +# The "pre-rebase" hook is run just before "git rebase" starts doing +# its job, and can prevent the command from running by exiting with +# non-zero status. +# +# The hook is called with the following parameters: +# +# $1 -- the upstream the series was forked from. +# $2 -- the branch being rebased (or empty when rebasing the current branch). +# +# This sample shows how to prevent topic branches that are already +# merged to 'next' branch from getting rebased, because allowing it +# would result in rebasing already published history. + +publish=next +basebranch="$1" +if test "$#" = 2 +then + topic="refs/heads/$2" +else + topic=`git symbolic-ref HEAD` || + exit 0 ;# we do not interrupt rebasing detached HEAD +fi + +case "$topic" in +refs/heads/??/*) + ;; +*) + exit 0 ;# we do not interrupt others. + ;; +esac + +# Now we are dealing with a topic branch being rebased +# on top of master. Is it OK to rebase it? + +# Does the topic really exist? +git show-ref -q "$topic" || { + echo >&2 "No such branch $topic" + exit 1 +} + +# Is topic fully merged to master? +not_in_master=`git rev-list --pretty=oneline ^master "$topic"` +if test -z "$not_in_master" +then + echo >&2 "$topic is fully merged to master; better remove it." + exit 1 ;# we could allow it, but there is no point. +fi + +# Is topic ever merged to next? If so you should not be rebasing it. +only_next_1=`git rev-list ^master "^$topic" ${publish} | sort` +only_next_2=`git rev-list ^master ${publish} | sort` +if test "$only_next_1" = "$only_next_2" +then + not_in_topic=`git rev-list "^$topic" master` + if test -z "$not_in_topic" + then + echo >&2 "$topic is already up to date with master" + exit 1 ;# we could allow it, but there is no point. + else + exit 0 + fi +else + not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"` + /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -e ' + my $topic = $ARGV[0]; + my $msg = "* $topic has commits already merged to public branch:\n"; + my (%not_in_next) = map { + /^([0-9a-f]+) /; + ($1 => 1); + } split(/\n/, $ARGV[1]); + for my $elem (map { + /^([0-9a-f]+) (.*)$/; + [$1 => $2]; + } split(/\n/, $ARGV[2])) { + if (!exists $not_in_next{$elem->[0]}) { + if ($msg) { + print STDERR $msg; + undef $msg; + } + print STDERR " $elem->[1]\n"; + } + } + ' "$topic" "$not_in_next" "$not_in_master" + exit 1 +fi + +<<\DOC_END + +This sample hook safeguards topic branches that have been +published from being rewound. + +The workflow assumed here is: + + * Once a topic branch forks from "master", "master" is never + merged into it again (either directly or indirectly). + + * Once a topic branch is fully cooked and merged into "master", + it is deleted. If you need to build on top of it to correct + earlier mistakes, a new topic branch is created by forking at + the tip of the "master". This is not strictly necessary, but + it makes it easier to keep your history simple. + + * Whenever you need to test or publish your changes to topic + branches, merge them into "next" branch. + +The script, being an example, hardcodes the publish branch name +to be "next", but it is trivial to make it configurable via +$GIT_DIR/config mechanism. + +With this workflow, you would want to know: + +(1) ... if a topic branch has ever been merged to "next". Young + topic branches can have stupid mistakes you would rather + clean up before publishing, and things that have not been + merged into other branches can be easily rebased without + affecting other people. But once it is published, you would + not want to rewind it. + +(2) ... if a topic branch has been fully merged to "master". + Then you can delete it. More importantly, you should not + build on top of it -- other people may already want to + change things related to the topic as patches against your + "master", so if you need further changes, it is better to + fork the topic (perhaps with the same name) afresh from the + tip of "master". + +Let's look at this example: + + o---o---o---o---o---o---o---o---o---o "next" + / / / / + / a---a---b A / / + / / / / + / / c---c---c---c B / + / / / \ / + / / / b---b C \ / + / / / / \ / + ---o---o---o---o---o---o---o---o---o---o---o "master" + + +A, B and C are topic branches. + + * A has one fix since it was merged up to "next". + + * B has finished. It has been fully merged up to "master" and "next", + and is ready to be deleted. + + * C has not merged to "next" at all. + +We would want to allow C to be rebased, refuse A, and encourage +B to be deleted. + +To compute (1): + + git rev-list ^master ^topic next + git rev-list ^master next + + if these match, topic has not merged in next at all. + +To compute (2): + + git rev-list master..topic + + if this is empty, it is fully merged to "master". + +DOC_END diff --git a/build/c/git_template/hooks/pre-receive.sample b/build/c/git_template/hooks/pre-receive.sample new file mode 100644 index 0000000..0bf2643 --- /dev/null +++ b/build/c/git_template/hooks/pre-receive.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to make use of push options. +# The example simply echoes all push options that start with 'echoback=' +# and rejects all pushes when the "reject" push option is used. +# +# To enable this hook, rename this file to "pre-receive". + +if test -n "$GIT_PUSH_OPTION_COUNT" +then + i=0 + while test "$i" -lt "$GIT_PUSH_OPTION_COUNT" + do + eval "value=\$GIT_PUSH_OPTION_$i" + case "$value" in + echoback=*) + echo "echo from the pre-receive-hook: ${value#*=}" >&2 + ;; + reject) + exit 1 + esac + i=$((i + 1)) + done +fi diff --git a/build/c/git_template/hooks/prepare-commit-msg.sample b/build/c/git_template/hooks/prepare-commit-msg.sample new file mode 100644 index 0000000..24283a0 --- /dev/null +++ b/build/c/git_template/hooks/prepare-commit-msg.sample @@ -0,0 +1,42 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare the commit log message. +# Called by "git commit" with the name of the file that has the +# commit message, followed by the description of the commit +# message's source. The hook's purpose is to edit the commit +# message file. If the hook fails with a non-zero status, +# the commit is aborted. +# +# To enable this hook, rename this file to "prepare-commit-msg". + +# This hook includes three examples. The first one removes the +# "# Please enter the commit message..." help message. +# +# The second includes the output of "git diff --name-status -r" +# into the message, just before the "git status" output. It is +# commented because it doesn't cope with --amend or with squashed +# commits. +# +# The third example adds a Signed-off-by line to the message, that can +# still be edited. This is rarely a good idea. + +COMMIT_MSG_FILE=$1 +COMMIT_SOURCE=$2 +SHA1=$3 + +/nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE" + +# case "$COMMIT_SOURCE,$SHA1" in +# ,|template,) +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe ' +# print "\n" . `git diff --cached --name-status -r` +# if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;; +# *) ;; +# esac + +# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE" +# if test -z "$COMMIT_SOURCE" +# then +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE" +# fi diff --git a/build/c/git_template/hooks/push-to-checkout.sample b/build/c/git_template/hooks/push-to-checkout.sample new file mode 100644 index 0000000..07fa538 --- /dev/null +++ b/build/c/git_template/hooks/push-to-checkout.sample @@ -0,0 +1,78 @@ +#!/usr/bin/env bash + +# An example hook script to update a checked-out tree on a git push. +# +# This hook is invoked by git-receive-pack(1) when it reacts to git +# push and updates reference(s) in its repository, and when the push +# tries to update the branch that is currently checked out and the +# receive.denyCurrentBranch configuration variable is set to +# updateInstead. +# +# By default, such a push is refused if the working tree and the index +# of the remote repository has any difference from the currently +# checked out commit; when both the working tree and the index match +# the current commit, they are updated to match the newly pushed tip +# of the branch. This hook is to be used to override the default +# behaviour; however the code below reimplements the default behaviour +# as a starting point for convenient modification. +# +# The hook receives the commit with which the tip of the current +# branch is going to be updated: +commit=$1 + +# It can exit with a non-zero status to refuse the push (when it does +# so, it must not modify the index or the working tree). +die () { + echo >&2 "$*" + exit 1 +} + +# Or it can make any necessary changes to the working tree and to the +# index to bring them to the desired state when the tip of the current +# branch is updated to the new commit, and exit with a zero status. +# +# For example, the hook can simply run git read-tree -u -m HEAD "$1" +# in order to emulate git fetch that is run in the reverse direction +# with git push, as the two-tree form of git read-tree -u -m is +# essentially the same as git switch or git checkout that switches +# branches while keeping the local changes in the working tree that do +# not interfere with the difference between the branches. + +# The below is a more-or-less exact translation to shell of the C code +# for the default behaviour for git's push-to-checkout hook defined in +# the push_to_deploy() function in builtin/receive-pack.c. +# +# Note that the hook will be executed from the repository directory, +# not from the working tree, so if you want to perform operations on +# the working tree, you will have to adapt your code accordingly, e.g. +# by adding "cd .." or using relative paths. + +if ! git update-index -q --ignore-submodules --refresh +then + die "Up-to-date check failed" +fi + +if ! git diff-files --quiet --ignore-submodules -- +then + die "Working directory has unstaged changes" +fi + +# This is a rough translation of: +# +# head_has_history() ? "HEAD" : EMPTY_TREE_SHA1_HEX +if git cat-file -e HEAD 2>/dev/null +then + head=HEAD +else + head=$(git hash-object -t tree --stdin </dev/null) +fi + +if ! git diff-index --quiet --cached --ignore-submodules $head -- +then + die "Working directory has staged changes" +fi + +if ! git read-tree -u -m "$commit" +then + die "Could not update working tree to new HEAD" +fi diff --git a/build/c/git_template/hooks/sendemail-validate.sample b/build/c/git_template/hooks/sendemail-validate.sample new file mode 100644 index 0000000..52aa61c --- /dev/null +++ b/build/c/git_template/hooks/sendemail-validate.sample @@ -0,0 +1,77 @@ +#!/usr/bin/env bash + +# An example hook script to validate a patch (and/or patch series) before +# sending it via email. +# +# The hook should exit with non-zero status after issuing an appropriate +# message if it wants to prevent the email(s) from being sent. +# +# To enable this hook, rename this file to "sendemail-validate". +# +# By default, it will only check that the patch(es) can be applied on top of +# the default upstream branch without conflicts in a secondary worktree. After +# validation (successful or not) of the last patch of a series, the worktree +# will be deleted. +# +# The following config variables can be set to change the default remote and +# remote ref that are used to apply the patches against: +# +# sendemail.validateRemote (default: origin) +# sendemail.validateRemoteRef (default: HEAD) +# +# Replace the TODO placeholders with appropriate checks according to your +# needs. + +validate_cover_letter () { + file="$1" + # TODO: Replace with appropriate checks (e.g. spell checking). + true +} + +validate_patch () { + file="$1" + # Ensure that the patch applies without conflicts. + git am -3 "$file" || return + # TODO: Replace with appropriate checks for this patch + # (e.g. checkpatch.pl). + true +} + +validate_series () { + # TODO: Replace with appropriate checks for the whole series + # (e.g. quick build, coding style checks, etc.). + true +} + +# main ------------------------------------------------------------------------- + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = 1 +then + remote=$(git config --default origin --get sendemail.validateRemote) && + ref=$(git config --default HEAD --get sendemail.validateRemoteRef) && + worktree=$(mktemp --tmpdir -d sendemail-validate.XXXXXXX) && + git worktree add -fd --checkout "$worktree" "refs/remotes/$remote/$ref" && + git config --replace-all sendemail.validateWorktree "$worktree" +else + worktree=$(git config --get sendemail.validateWorktree) +fi || { + echo "sendemail-validate: error: failed to prepare worktree" >&2 + exit 1 +} + +unset GIT_DIR GIT_WORK_TREE +cd "$worktree" && + +if grep -q "^diff --git " "$1" +then + validate_patch "$1" +else + validate_cover_letter "$1" +fi && + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = "$GIT_SENDEMAIL_FILE_TOTAL" +then + git config --unset-all sendemail.validateWorktree && + trap 'git worktree remove -ff "$worktree"' EXIT && + validate_series +fi diff --git a/build/c/git_template/hooks/update.sample b/build/c/git_template/hooks/update.sample new file mode 100644 index 0000000..1910758 --- /dev/null +++ b/build/c/git_template/hooks/update.sample @@ -0,0 +1,128 @@ +#!/usr/bin/env bash +# +# An example hook script to block unannotated tags from entering. +# Called by "git receive-pack" with arguments: refname sha1-old sha1-new +# +# To enable this hook, rename this file to "update". +# +# Config +# ------ +# hooks.allowunannotated +# This boolean sets whether unannotated tags will be allowed into the +# repository. By default they won't be. +# hooks.allowdeletetag +# This boolean sets whether deleting tags will be allowed in the +# repository. By default they won't be. +# hooks.allowmodifytag +# This boolean sets whether a tag may be modified after creation. By default +# it won't be. +# hooks.allowdeletebranch +# This boolean sets whether deleting branches will be allowed in the +# repository. By default they won't be. +# hooks.denycreatebranch +# This boolean sets whether remotely creating branches will be denied +# in the repository. By default this is allowed. +# + +# --- Command line +refname="$1" +oldrev="$2" +newrev="$3" + +# --- Safety check +if [ -z "$GIT_DIR" ]; then + echo "Don't run this script from the command line." >&2 + echo " (if you want, you could supply GIT_DIR then run" >&2 + echo " $0 <ref> <oldrev> <newrev>)" >&2 + exit 1 +fi + +if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then + echo "usage: $0 <ref> <oldrev> <newrev>" >&2 + exit 1 +fi + +# --- Config +allowunannotated=$(git config --type=bool hooks.allowunannotated) +allowdeletebranch=$(git config --type=bool hooks.allowdeletebranch) +denycreatebranch=$(git config --type=bool hooks.denycreatebranch) +allowdeletetag=$(git config --type=bool hooks.allowdeletetag) +allowmodifytag=$(git config --type=bool hooks.allowmodifytag) + +# check for no description +projectdesc=$(sed -e '1q' "$GIT_DIR/description") +case "$projectdesc" in +"Unnamed repository"* | "") + echo "*** Project description file hasn't been set" >&2 + exit 1 + ;; +esac + +# --- Check types +# if $newrev is 0000...0000, it's a commit to delete a ref. +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') +if [ "$newrev" = "$zero" ]; then + newrev_type=delete +else + newrev_type=$(git cat-file -t $newrev) +fi + +case "$refname","$newrev_type" in + refs/tags/*,commit) + # un-annotated tag + short_refname=${refname##refs/tags/} + if [ "$allowunannotated" != "true" ]; then + echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2 + echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2 + exit 1 + fi + ;; + refs/tags/*,delete) + # delete tag + if [ "$allowdeletetag" != "true" ]; then + echo "*** Deleting a tag is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/tags/*,tag) + # annotated tag + if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1 + then + echo "*** Tag '$refname' already exists." >&2 + echo "*** Modifying a tag is not allowed in this repository." >&2 + exit 1 + fi + ;; + refs/heads/*,commit) + # branch + if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then + echo "*** Creating a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/heads/*,delete) + # delete branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/remotes/*,commit) + # tracking branch + ;; + refs/remotes/*,delete) + # delete tracking branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a tracking branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + *) + # Anything else (is there anything else?) + echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2 + exit 1 + ;; +esac + +# --- Finished +exit 0 diff --git a/build/c/git_template/info/exclude b/build/c/git_template/info/exclude new file mode 100644 index 0000000..a5196d1 --- /dev/null +++ b/build/c/git_template/info/exclude @@ -0,0 +1,6 @@ +# git ls-files --others --exclude-from=.git/info/exclude +# Lines that start with '#' are comments. +# For a project mostly in C, the following would be a good set of +# exclude patterns (uncomment them if you want to use them): +# *.[oa] +# *~ diff --git a/build/c/init b/build/c/init index 1ea1603..f8c8bb3 100644 --- a/build/c/init +++ b/build/c/init @@ -10,13 +10,18 @@ trap "cleanup; remove_self" EXIT cleanup() { rm "$replacement_file" } +avoid_cleanup="false" remove_self() { - rm "$(realpath "$0")" - rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + if [ "$avoid_cleanup" = "false" ]; then + rm "$(realpath "$0")" + rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + [ -f "$(realpath "$(dirname "$0")")/init.local" ] && rm "$(realpath "$(dirname "$0")")/init.local" + fi } require() { program="$1" if ! command -v "$program" >/dev/null; then + avoid_cleanup="true" echo "Please install '$program' for this init script to work." 1>&2 exit 1 fi @@ -64,8 +69,6 @@ require mv require sed require chmod -git init - # necessary meta data prompt APPLICATION_NAME "The name of the application" "$(basename "$PWD")" prompt APPLICATION_NAME_STYLIZED "The stylized name of the application (for documentation)" "$(echo "$APPLICATION_NAME" | sed 's/[_-]/ /g' | sed 's/^\(\w\)/\U\1/g' | sed 's/ \(\w\)/ \U\1/g')" @@ -78,7 +81,15 @@ prompt AUTHOR_EMAIL "The email of the author (or authors)" "$(git config --get u # cog change-log variables prompt REMOTE "The remote, this project will be pushed to" "git.vhack.eu" prompt REPOSITORY "The path of the repository on the remote" "$APPLICATION_NAME" -prompt OWNER "The name of owner of the repository" "$AUTHOR_NAME" + +owner1="$(printf "%.1s" "$AUTHOR_NAME")" +owner2="${AUTHOR_NAME#* }" +if [ "$owner2" = "$AUTHOR_NAME" ]; then + owner_build="$(echo "$AUTHOR_NAME" | tr '[:upper:]' '[:lower:]')" +else + owner_build="$(echo "$owner1$owner2" | tr '[:upper:]' '[:lower:]')" +fi +prompt OWNER "The name of owner of the repository" "$owner_build" # nice meta data prompt DESCRIPTION "The description of this project" "" @@ -88,7 +99,12 @@ prompt APPLICATION_SOURCE_CODE_REPOSITORY "The package's source code repository prompt HOME_PAGE "The home page URL of the project" "https://$REPOSITORY.org/" prompt BUG_URL "The URL people should report bugs to" "$APPLICATION_SOURCE_CODE_REPOSITORY/issues" -if [ -e ./lpm.toml ]; then +# git stuff +prompt PUSH_URL "The url used to push this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt CLONE_URL "The url used to clone this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt MAIN_BRANCH "The name of the main branch" "$(git config init.defaultbranch)" + +if [ -e ./watch.sh ]; then # Use a different default license in latex projects. init_default_license="CC-BY-SA-4.0" else @@ -105,7 +121,7 @@ fi prompt LICENSE_URL "The url of the license" "$default_license_url" if [ -e ./.reuse/templates/default.jinja2 ]; then - cat <<EOF | fmt --uniform-spacing --width=75 >./.reuse/templates/default.jinja2 + cat <<EOF | fmt --uniform-spacing --width=85 --split-only >./.reuse/templates/default.jinja2 {% for copyright_line in copyright_lines %} {{ copyright_line }} {% endfor %} @@ -120,14 +136,14 @@ This file is part of $APPLICATION_NAME_STYLIZED - $DESCRIPTION. You should have received a copy of the License along with this program. If not, see <$LICENSE_URL>. -<!-- vim: ft=htmldjango --> EOF fi # Allow templates to add template specific prompts [ -e init.local ] && . ./init.local -echo "$DESCRIPTION" >.git/description +git init --initial-branch "$MAIN_BRANCH" --template="./git_template" +rm --recursive ./git_template while read -r var; do var_name="${var%=*}" @@ -148,5 +164,19 @@ done <"$replacement_file" chmod +x scripts/* chmod +x update.sh [ -f ./build.sh ] && chmod +x build.sh +[ -f ./watch.sh ] && chmod +x build.sh + +# Do the first run of reuse annotate +reuse="$(nix build nixpkgs#reuse --no-link --print-out-paths)" +[ "$(echo "$reuse" | wc -l)" -ne 1 ] && die "Something is wrong with the nixpkgs#reuse derivation" + +git add . + +git diff --name-only --cached | + xargs -I {} "$reuse" annotate \ + --copyright "$AUTHOR_NAME <$AUTHOR_EMAIL>" \ + --copyright-style string-c \ + --template default \ + --license "$SPDX_LICENSE_IDENTIFIER" "{}" # vim: ft=sh diff --git a/build/c/scripts/cprh.sh b/build/c/scripts/cprh.sh deleted file mode 100755 index 9582575..0000000 --- a/build/c/scripts/cprh.sh +++ /dev/null @@ -1,57 +0,0 @@ -#! /usr/bin/env sh - -die() { - echo "$@" 1>&2 - exit 1 -} - -help() { - cat <<EOF -A copyright header managment tool. - -USAGE: - cprh.sh [OPTIONS] contribute NAME EMAIL FILE.. - -OPTIONS: - --help | -h - Display this help and exit. - -ARGUMENTS: - NAME := [[git config user.name]] - Your name. - - NAME := [[git config user.email]] - Your email address. - - FILE := [[git diff --name-only --cached]] - The file you want to change. This can be given multiple times. -EOF -} - -for arg in "$@"; do - case "$arg" in - "--help" | "-h") - help - exit 0 - ;; - *) - echo "'$1' is not a recognized option. See --help for more!" 1>&2 - exit 1 - ;; - esac -done - -user_name="$1" -[ -z "$user_name" ] && die "No NAME set! See --help for more" - -user_email="$2" -[ -z "$user_email" ] && die "No EMAIL set! See --help for more" -shift 2 - -styleOne="" -styleTwo="" -[ "$COMMENT_STYLE" ] && styleOne="--style" && styleTwo="$COMMENT_STYLE" - -# The styleTwo must be unquoted to avoid adding empty args to reuse -# shellcheck disable=2086 -reuse annotate --copyright "$user_name <$user_email>" --copyright-prefix string-c --template default --multi-line $styleOne $styleTwo diff --git a/build/latex/academia/README.md b/build/latex/academia/README.md index 9c5c6da..6dad42c 100644 --- a/build/latex/academia/README.md +++ b/build/latex/academia/README.md @@ -3,6 +3,7 @@ > %INIT_DESCRIPTION ## Licensing + This project complies with the REUSE v3.2 specification. This means that every file clearly states its copyright. Please run `./scripts/cprh.sh contributer NAME EMAIL FILES..` after you diff --git a/build/latex/academia/cog.toml b/build/latex/academia/cog.toml index ccca764..ebb3a5d 100644 --- a/build/latex/academia/cog.toml +++ b/build/latex/academia/cog.toml @@ -3,10 +3,10 @@ branch_whitelist = ["main", "prime"] ignore_merge_commits = false pre_bump_hooks = [ - "nix flake check", # verify the project builds - "./scripts/renew_copyright_header.sh", # update the license header in each file - "flake_version_update --version v{{version}} --input-file flake.nix", # update the version in the flake.nix file - "nix fmt", # format + "reuse lint", # Check licensing status. + "nix flake check", # Verify the project builds. + "flake_version_update --version v{{version}} --input-file flake.nix", # Bump the version in the flake.nix file + "nix fmt", # Format. ] post_bump_hooks = [ "git push", diff --git a/build/latex/academia/git_template/config b/build/latex/academia/git_template/config new file mode 100644 index 0000000..f0c8d31 --- /dev/null +++ b/build/latex/academia/git_template/config @@ -0,0 +1,7 @@ +[remote "origin"] + url = %INIT_CLONE_URL + fetch = +refs/heads/*:refs/remotes/origin/* + pushurl = %INIT_PUSH_URL +[branch "%INIT_MAIN_BRANCH"] + remote = origin + merge = refs/heads/%INIT_MAIN_BRANCH diff --git a/build/latex/academia/git_template/description b/build/latex/academia/git_template/description new file mode 100644 index 0000000..bf2d1bf --- /dev/null +++ b/build/latex/academia/git_template/description @@ -0,0 +1 @@ +%INIT_DESCRIPTION diff --git a/build/latex/academia/git_template/hooks/applypatch-msg.sample b/build/latex/academia/git_template/hooks/applypatch-msg.sample new file mode 100644 index 0000000..e6c87c6 --- /dev/null +++ b/build/latex/academia/git_template/hooks/applypatch-msg.sample @@ -0,0 +1,15 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message taken by +# applypatch from an e-mail 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, rename this file to "applypatch-msg". + +. git-sh-setup +commitmsg="$(git rev-parse --git-path hooks/commit-msg)" +test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"} +: diff --git a/build/latex/academia/git_template/hooks/commit-msg.sample b/build/latex/academia/git_template/hooks/commit-msg.sample new file mode 100644 index 0000000..5604587 --- /dev/null +++ b/build/latex/academia/git_template/hooks/commit-msg.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message. +# 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, rename this file to "commit-msg". + +# Uncomment the below to add a Signed-off-by line to the message. +# Doing this in a hook is a bad idea in general, but the prepare-commit-msg +# hook is more suited to it. +# +# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1" + +# This example catches duplicate Signed-off-by lines. + +test "" = "$(grep '^Signed-off-by: ' "$1" | + sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || { + echo >&2 Duplicate Signed-off-by lines. + exit 1 +} diff --git a/build/latex/academia/git_template/hooks/fsmonitor-watchman.sample b/build/latex/academia/git_template/hooks/fsmonitor-watchman.sample new file mode 100644 index 0000000..367d462 --- /dev/null +++ b/build/latex/academia/git_template/hooks/fsmonitor-watchman.sample @@ -0,0 +1,174 @@ +#!/usr/bin/env perl + +use strict; +use warnings; +use IPC::Open2; + +# An example hook script to integrate Watchman +# (https://facebook.github.io/watchman/) with git to speed up detecting +# new and modified files. +# +# The hook is passed a version (currently 2) and last update token +# formatted as a string and outputs to stdout a new update token and +# all files that have been modified since the update token. Paths must +# be relative to the root of the working tree and separated by a single NUL. +# +# To enable this hook, rename this file to "query-watchman" and set +# 'git config core.fsmonitor .git/hooks/query-watchman' +# +my ($version, $last_update_token) = @ARGV; + +# Uncomment for debugging +# print STDERR "$0 $version $last_update_token\n"; + +# Check the hook interface version +if ($version ne 2) { + die "Unsupported query-fsmonitor hook version '$version'.\n" . + "Falling back to scanning...\n"; +} + +my $git_work_tree = get_working_dir(); + +my $retry = 1; + +my $json_pkg; +eval { + require JSON::XS; + $json_pkg = "JSON::XS"; + 1; +} or do { + require JSON::PP; + $json_pkg = "JSON::PP"; +}; + +launch_watchman(); + +sub launch_watchman { + my $o = watchman_query(); + if (is_work_tree_watched($o)) { + output_result($o->{clock}, @{$o->{files}}); + } +} + +sub output_result { + my ($clockid, @files) = @_; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # binmode $fh, ":utf8"; + # print $fh "$clockid\n@files\n"; + # close $fh; + + binmode STDOUT, ":utf8"; + print $clockid; + print "\0"; + local $, = "\0"; + print @files; +} + +sub watchman_clock { + my $response = qx/watchman clock "$git_work_tree"/; + die "Failed to get clock id on '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + + return $json_pkg->new->utf8->decode($response); +} + +sub watchman_query { + my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty') + or die "open2() failed: $!\n" . + "Falling back to scanning...\n"; + + # In the query expression below we're asking for names of files that + # changed since $last_update_token but not from the .git folder. + # + # To accomplish this, we're using the "since" generator to use the + # recency index to select candidate nodes and "fields" to limit the + # output to file names only. Then we're using the "expression" term to + # further constrain the results. + my $last_update_line = ""; + if (substr($last_update_token, 0, 1) eq "c") { + $last_update_token = "\"$last_update_token\""; + $last_update_line = qq[\n"since": $last_update_token,]; + } + my $query = <<" END"; + ["query", "$git_work_tree", {$last_update_line + "fields": ["name"], + "expression": ["not", ["dirname", ".git"]] + }] + END + + # Uncomment for debugging the watchman query + # open (my $fh, ">", ".git/watchman-query.json"); + # print $fh $query; + # close $fh; + + print CHLD_IN $query; + close CHLD_IN; + my $response = do {local $/; <CHLD_OUT>}; + + # Uncomment for debugging the watch response + # open ($fh, ">", ".git/watchman-response.json"); + # print $fh $response; + # close $fh; + + die "Watchman: command returned no output.\n" . + "Falling back to scanning...\n" if $response eq ""; + die "Watchman: command returned invalid output: $response\n" . + "Falling back to scanning...\n" unless $response =~ /^\{/; + + return $json_pkg->new->utf8->decode($response); +} + +sub is_work_tree_watched { + my ($output) = @_; + my $error = $output->{error}; + if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) { + $retry--; + my $response = qx/watchman watch "$git_work_tree"/; + die "Failed to make watchman watch '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + $output = $json_pkg->new->utf8->decode($response); + $error = $output->{error}; + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # close $fh; + + # Watchman will always return all files on the first query so + # return the fast "everything is dirty" flag to git and do the + # Watchman query just to get it over with now so we won't pay + # the cost in git to look up each individual file. + my $o = watchman_clock(); + $error = $output->{error}; + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + output_result($o->{clock}, ("/")); + $last_update_token = $o->{clock}; + + eval { launch_watchman() }; + return 0; + } + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + return 1; +} + +sub get_working_dir { + my $working_dir; + if ($^O =~ 'msys' || $^O =~ 'cygwin') { + $working_dir = Win32::GetCwd(); + $working_dir =~ tr/\\/\//; + } else { + require Cwd; + $working_dir = Cwd::cwd(); + } + + return $working_dir; +} diff --git a/build/latex/academia/git_template/hooks/post-update.sample b/build/latex/academia/git_template/hooks/post-update.sample new file mode 100644 index 0000000..e3b3f9f --- /dev/null +++ b/build/latex/academia/git_template/hooks/post-update.sample @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare a packed repository for use over +# dumb transports. +# +# To enable this hook, rename this file to "post-update". + +exec git update-server-info diff --git a/build/latex/academia/git_template/hooks/pre-applypatch.sample b/build/latex/academia/git_template/hooks/pre-applypatch.sample new file mode 100644 index 0000000..c414f0e --- /dev/null +++ b/build/latex/academia/git_template/hooks/pre-applypatch.sample @@ -0,0 +1,14 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed +# by applypatch from an e-mail message. +# +# The hook should exit with non-zero status after issuing an +# appropriate message if it wants to stop the commit. +# +# To enable this hook, rename this file to "pre-applypatch". + +. git-sh-setup +precommit="$(git rev-parse --git-path hooks/pre-commit)" +test -x "$precommit" && exec "$precommit" ${1+"$@"} +: diff --git a/build/latex/academia/git_template/hooks/pre-commit.sample b/build/latex/academia/git_template/hooks/pre-commit.sample new file mode 100644 index 0000000..55f180d --- /dev/null +++ b/build/latex/academia/git_template/hooks/pre-commit.sample @@ -0,0 +1,49 @@ +#!/usr/bin/env bash +# +# An example 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. +# +# To enable this hook, rename this file to "pre-commit". + +if git rev-parse --verify HEAD >/dev/null 2>&1 +then + against=HEAD +else + # Initial commit: diff against an empty tree object + against=$(git hash-object -t tree /dev/null) +fi + +# If you want to allow non-ASCII filenames set this variable to true. +allownonascii=$(git config --type=bool hooks.allownonascii) + +# Redirect output to stderr. +exec 1>&2 + +# 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" != "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. + test $(git diff-index --cached --name-only --diff-filter=A -z $against | + LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0 +then + cat <<\EOF +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 +EOF + exit 1 +fi + +# If there are whitespace errors, print the offending file names and fail. +exec git diff-index --check --cached $against -- diff --git a/build/latex/academia/git_template/hooks/pre-merge-commit.sample b/build/latex/academia/git_template/hooks/pre-merge-commit.sample new file mode 100644 index 0000000..0ed3c36 --- /dev/null +++ b/build/latex/academia/git_template/hooks/pre-merge-commit.sample @@ -0,0 +1,13 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed. +# Called by "git merge" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message to +# stderr if it wants to stop the merge commit. +# +# To enable this hook, rename this file to "pre-merge-commit". + +. git-sh-setup +test -x "$GIT_DIR/hooks/pre-commit" && + exec "$GIT_DIR/hooks/pre-commit" +: diff --git a/build/latex/academia/git_template/hooks/pre-push.sample b/build/latex/academia/git_template/hooks/pre-push.sample new file mode 100644 index 0000000..cb27ddb --- /dev/null +++ b/build/latex/academia/git_template/hooks/pre-push.sample @@ -0,0 +1,53 @@ +#!/usr/bin/env bash + +# An example hook script to verify what is about to be pushed. Called by "git +# push" after it has checked the remote status, but before anything has been +# pushed. If this script exits with a non-zero status nothing will be pushed. +# +# This hook is called with the following parameters: +# +# $1 -- Name of the remote to which the push is being done +# $2 -- URL to which the push is being done +# +# If pushing without using a named remote those arguments will be equal. +# +# Information about the commits which are being pushed is supplied as lines to +# the standard input in the form: +# +# <local ref> <local oid> <remote ref> <remote oid> +# +# This sample shows how to prevent push of commits where the log message starts +# with "WIP" (work in progress). + +remote="$1" +url="$2" + +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') + +while read local_ref local_oid remote_ref remote_oid +do + if test "$local_oid" = "$zero" + then + # Handle delete + : + else + if test "$remote_oid" = "$zero" + then + # New branch, examine all commits + range="$local_oid" + else + # Update to existing branch, examine new commits + range="$remote_oid..$local_oid" + fi + + # Check for WIP commit + commit=$(git rev-list -n 1 --grep '^WIP' "$range") + if test -n "$commit" + then + echo >&2 "Found WIP commit in $local_ref, not pushing" + exit 1 + fi + fi +done + +exit 0 diff --git a/build/latex/academia/git_template/hooks/pre-rebase.sample b/build/latex/academia/git_template/hooks/pre-rebase.sample new file mode 100644 index 0000000..d062617 --- /dev/null +++ b/build/latex/academia/git_template/hooks/pre-rebase.sample @@ -0,0 +1,169 @@ +#!/usr/bin/env bash +# +# Copyright (c) 2006, 2008 Junio C Hamano +# +# The "pre-rebase" hook is run just before "git rebase" starts doing +# its job, and can prevent the command from running by exiting with +# non-zero status. +# +# The hook is called with the following parameters: +# +# $1 -- the upstream the series was forked from. +# $2 -- the branch being rebased (or empty when rebasing the current branch). +# +# This sample shows how to prevent topic branches that are already +# merged to 'next' branch from getting rebased, because allowing it +# would result in rebasing already published history. + +publish=next +basebranch="$1" +if test "$#" = 2 +then + topic="refs/heads/$2" +else + topic=`git symbolic-ref HEAD` || + exit 0 ;# we do not interrupt rebasing detached HEAD +fi + +case "$topic" in +refs/heads/??/*) + ;; +*) + exit 0 ;# we do not interrupt others. + ;; +esac + +# Now we are dealing with a topic branch being rebased +# on top of master. Is it OK to rebase it? + +# Does the topic really exist? +git show-ref -q "$topic" || { + echo >&2 "No such branch $topic" + exit 1 +} + +# Is topic fully merged to master? +not_in_master=`git rev-list --pretty=oneline ^master "$topic"` +if test -z "$not_in_master" +then + echo >&2 "$topic is fully merged to master; better remove it." + exit 1 ;# we could allow it, but there is no point. +fi + +# Is topic ever merged to next? If so you should not be rebasing it. +only_next_1=`git rev-list ^master "^$topic" ${publish} | sort` +only_next_2=`git rev-list ^master ${publish} | sort` +if test "$only_next_1" = "$only_next_2" +then + not_in_topic=`git rev-list "^$topic" master` + if test -z "$not_in_topic" + then + echo >&2 "$topic is already up to date with master" + exit 1 ;# we could allow it, but there is no point. + else + exit 0 + fi +else + not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"` + /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -e ' + my $topic = $ARGV[0]; + my $msg = "* $topic has commits already merged to public branch:\n"; + my (%not_in_next) = map { + /^([0-9a-f]+) /; + ($1 => 1); + } split(/\n/, $ARGV[1]); + for my $elem (map { + /^([0-9a-f]+) (.*)$/; + [$1 => $2]; + } split(/\n/, $ARGV[2])) { + if (!exists $not_in_next{$elem->[0]}) { + if ($msg) { + print STDERR $msg; + undef $msg; + } + print STDERR " $elem->[1]\n"; + } + } + ' "$topic" "$not_in_next" "$not_in_master" + exit 1 +fi + +<<\DOC_END + +This sample hook safeguards topic branches that have been +published from being rewound. + +The workflow assumed here is: + + * Once a topic branch forks from "master", "master" is never + merged into it again (either directly or indirectly). + + * Once a topic branch is fully cooked and merged into "master", + it is deleted. If you need to build on top of it to correct + earlier mistakes, a new topic branch is created by forking at + the tip of the "master". This is not strictly necessary, but + it makes it easier to keep your history simple. + + * Whenever you need to test or publish your changes to topic + branches, merge them into "next" branch. + +The script, being an example, hardcodes the publish branch name +to be "next", but it is trivial to make it configurable via +$GIT_DIR/config mechanism. + +With this workflow, you would want to know: + +(1) ... if a topic branch has ever been merged to "next". Young + topic branches can have stupid mistakes you would rather + clean up before publishing, and things that have not been + merged into other branches can be easily rebased without + affecting other people. But once it is published, you would + not want to rewind it. + +(2) ... if a topic branch has been fully merged to "master". + Then you can delete it. More importantly, you should not + build on top of it -- other people may already want to + change things related to the topic as patches against your + "master", so if you need further changes, it is better to + fork the topic (perhaps with the same name) afresh from the + tip of "master". + +Let's look at this example: + + o---o---o---o---o---o---o---o---o---o "next" + / / / / + / a---a---b A / / + / / / / + / / c---c---c---c B / + / / / \ / + / / / b---b C \ / + / / / / \ / + ---o---o---o---o---o---o---o---o---o---o---o "master" + + +A, B and C are topic branches. + + * A has one fix since it was merged up to "next". + + * B has finished. It has been fully merged up to "master" and "next", + and is ready to be deleted. + + * C has not merged to "next" at all. + +We would want to allow C to be rebased, refuse A, and encourage +B to be deleted. + +To compute (1): + + git rev-list ^master ^topic next + git rev-list ^master next + + if these match, topic has not merged in next at all. + +To compute (2): + + git rev-list master..topic + + if this is empty, it is fully merged to "master". + +DOC_END diff --git a/build/latex/academia/git_template/hooks/pre-receive.sample b/build/latex/academia/git_template/hooks/pre-receive.sample new file mode 100644 index 0000000..0bf2643 --- /dev/null +++ b/build/latex/academia/git_template/hooks/pre-receive.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to make use of push options. +# The example simply echoes all push options that start with 'echoback=' +# and rejects all pushes when the "reject" push option is used. +# +# To enable this hook, rename this file to "pre-receive". + +if test -n "$GIT_PUSH_OPTION_COUNT" +then + i=0 + while test "$i" -lt "$GIT_PUSH_OPTION_COUNT" + do + eval "value=\$GIT_PUSH_OPTION_$i" + case "$value" in + echoback=*) + echo "echo from the pre-receive-hook: ${value#*=}" >&2 + ;; + reject) + exit 1 + esac + i=$((i + 1)) + done +fi diff --git a/build/latex/academia/git_template/hooks/prepare-commit-msg.sample b/build/latex/academia/git_template/hooks/prepare-commit-msg.sample new file mode 100644 index 0000000..24283a0 --- /dev/null +++ b/build/latex/academia/git_template/hooks/prepare-commit-msg.sample @@ -0,0 +1,42 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare the commit log message. +# Called by "git commit" with the name of the file that has the +# commit message, followed by the description of the commit +# message's source. The hook's purpose is to edit the commit +# message file. If the hook fails with a non-zero status, +# the commit is aborted. +# +# To enable this hook, rename this file to "prepare-commit-msg". + +# This hook includes three examples. The first one removes the +# "# Please enter the commit message..." help message. +# +# The second includes the output of "git diff --name-status -r" +# into the message, just before the "git status" output. It is +# commented because it doesn't cope with --amend or with squashed +# commits. +# +# The third example adds a Signed-off-by line to the message, that can +# still be edited. This is rarely a good idea. + +COMMIT_MSG_FILE=$1 +COMMIT_SOURCE=$2 +SHA1=$3 + +/nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE" + +# case "$COMMIT_SOURCE,$SHA1" in +# ,|template,) +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe ' +# print "\n" . `git diff --cached --name-status -r` +# if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;; +# *) ;; +# esac + +# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE" +# if test -z "$COMMIT_SOURCE" +# then +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE" +# fi diff --git a/build/latex/academia/git_template/hooks/push-to-checkout.sample b/build/latex/academia/git_template/hooks/push-to-checkout.sample new file mode 100644 index 0000000..07fa538 --- /dev/null +++ b/build/latex/academia/git_template/hooks/push-to-checkout.sample @@ -0,0 +1,78 @@ +#!/usr/bin/env bash + +# An example hook script to update a checked-out tree on a git push. +# +# This hook is invoked by git-receive-pack(1) when it reacts to git +# push and updates reference(s) in its repository, and when the push +# tries to update the branch that is currently checked out and the +# receive.denyCurrentBranch configuration variable is set to +# updateInstead. +# +# By default, such a push is refused if the working tree and the index +# of the remote repository has any difference from the currently +# checked out commit; when both the working tree and the index match +# the current commit, they are updated to match the newly pushed tip +# of the branch. This hook is to be used to override the default +# behaviour; however the code below reimplements the default behaviour +# as a starting point for convenient modification. +# +# The hook receives the commit with which the tip of the current +# branch is going to be updated: +commit=$1 + +# It can exit with a non-zero status to refuse the push (when it does +# so, it must not modify the index or the working tree). +die () { + echo >&2 "$*" + exit 1 +} + +# Or it can make any necessary changes to the working tree and to the +# index to bring them to the desired state when the tip of the current +# branch is updated to the new commit, and exit with a zero status. +# +# For example, the hook can simply run git read-tree -u -m HEAD "$1" +# in order to emulate git fetch that is run in the reverse direction +# with git push, as the two-tree form of git read-tree -u -m is +# essentially the same as git switch or git checkout that switches +# branches while keeping the local changes in the working tree that do +# not interfere with the difference between the branches. + +# The below is a more-or-less exact translation to shell of the C code +# for the default behaviour for git's push-to-checkout hook defined in +# the push_to_deploy() function in builtin/receive-pack.c. +# +# Note that the hook will be executed from the repository directory, +# not from the working tree, so if you want to perform operations on +# the working tree, you will have to adapt your code accordingly, e.g. +# by adding "cd .." or using relative paths. + +if ! git update-index -q --ignore-submodules --refresh +then + die "Up-to-date check failed" +fi + +if ! git diff-files --quiet --ignore-submodules -- +then + die "Working directory has unstaged changes" +fi + +# This is a rough translation of: +# +# head_has_history() ? "HEAD" : EMPTY_TREE_SHA1_HEX +if git cat-file -e HEAD 2>/dev/null +then + head=HEAD +else + head=$(git hash-object -t tree --stdin </dev/null) +fi + +if ! git diff-index --quiet --cached --ignore-submodules $head -- +then + die "Working directory has staged changes" +fi + +if ! git read-tree -u -m "$commit" +then + die "Could not update working tree to new HEAD" +fi diff --git a/build/latex/academia/git_template/hooks/sendemail-validate.sample b/build/latex/academia/git_template/hooks/sendemail-validate.sample new file mode 100644 index 0000000..52aa61c --- /dev/null +++ b/build/latex/academia/git_template/hooks/sendemail-validate.sample @@ -0,0 +1,77 @@ +#!/usr/bin/env bash + +# An example hook script to validate a patch (and/or patch series) before +# sending it via email. +# +# The hook should exit with non-zero status after issuing an appropriate +# message if it wants to prevent the email(s) from being sent. +# +# To enable this hook, rename this file to "sendemail-validate". +# +# By default, it will only check that the patch(es) can be applied on top of +# the default upstream branch without conflicts in a secondary worktree. After +# validation (successful or not) of the last patch of a series, the worktree +# will be deleted. +# +# The following config variables can be set to change the default remote and +# remote ref that are used to apply the patches against: +# +# sendemail.validateRemote (default: origin) +# sendemail.validateRemoteRef (default: HEAD) +# +# Replace the TODO placeholders with appropriate checks according to your +# needs. + +validate_cover_letter () { + file="$1" + # TODO: Replace with appropriate checks (e.g. spell checking). + true +} + +validate_patch () { + file="$1" + # Ensure that the patch applies without conflicts. + git am -3 "$file" || return + # TODO: Replace with appropriate checks for this patch + # (e.g. checkpatch.pl). + true +} + +validate_series () { + # TODO: Replace with appropriate checks for the whole series + # (e.g. quick build, coding style checks, etc.). + true +} + +# main ------------------------------------------------------------------------- + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = 1 +then + remote=$(git config --default origin --get sendemail.validateRemote) && + ref=$(git config --default HEAD --get sendemail.validateRemoteRef) && + worktree=$(mktemp --tmpdir -d sendemail-validate.XXXXXXX) && + git worktree add -fd --checkout "$worktree" "refs/remotes/$remote/$ref" && + git config --replace-all sendemail.validateWorktree "$worktree" +else + worktree=$(git config --get sendemail.validateWorktree) +fi || { + echo "sendemail-validate: error: failed to prepare worktree" >&2 + exit 1 +} + +unset GIT_DIR GIT_WORK_TREE +cd "$worktree" && + +if grep -q "^diff --git " "$1" +then + validate_patch "$1" +else + validate_cover_letter "$1" +fi && + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = "$GIT_SENDEMAIL_FILE_TOTAL" +then + git config --unset-all sendemail.validateWorktree && + trap 'git worktree remove -ff "$worktree"' EXIT && + validate_series +fi diff --git a/build/latex/academia/git_template/hooks/update.sample b/build/latex/academia/git_template/hooks/update.sample new file mode 100644 index 0000000..1910758 --- /dev/null +++ b/build/latex/academia/git_template/hooks/update.sample @@ -0,0 +1,128 @@ +#!/usr/bin/env bash +# +# An example hook script to block unannotated tags from entering. +# Called by "git receive-pack" with arguments: refname sha1-old sha1-new +# +# To enable this hook, rename this file to "update". +# +# Config +# ------ +# hooks.allowunannotated +# This boolean sets whether unannotated tags will be allowed into the +# repository. By default they won't be. +# hooks.allowdeletetag +# This boolean sets whether deleting tags will be allowed in the +# repository. By default they won't be. +# hooks.allowmodifytag +# This boolean sets whether a tag may be modified after creation. By default +# it won't be. +# hooks.allowdeletebranch +# This boolean sets whether deleting branches will be allowed in the +# repository. By default they won't be. +# hooks.denycreatebranch +# This boolean sets whether remotely creating branches will be denied +# in the repository. By default this is allowed. +# + +# --- Command line +refname="$1" +oldrev="$2" +newrev="$3" + +# --- Safety check +if [ -z "$GIT_DIR" ]; then + echo "Don't run this script from the command line." >&2 + echo " (if you want, you could supply GIT_DIR then run" >&2 + echo " $0 <ref> <oldrev> <newrev>)" >&2 + exit 1 +fi + +if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then + echo "usage: $0 <ref> <oldrev> <newrev>" >&2 + exit 1 +fi + +# --- Config +allowunannotated=$(git config --type=bool hooks.allowunannotated) +allowdeletebranch=$(git config --type=bool hooks.allowdeletebranch) +denycreatebranch=$(git config --type=bool hooks.denycreatebranch) +allowdeletetag=$(git config --type=bool hooks.allowdeletetag) +allowmodifytag=$(git config --type=bool hooks.allowmodifytag) + +# check for no description +projectdesc=$(sed -e '1q' "$GIT_DIR/description") +case "$projectdesc" in +"Unnamed repository"* | "") + echo "*** Project description file hasn't been set" >&2 + exit 1 + ;; +esac + +# --- Check types +# if $newrev is 0000...0000, it's a commit to delete a ref. +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') +if [ "$newrev" = "$zero" ]; then + newrev_type=delete +else + newrev_type=$(git cat-file -t $newrev) +fi + +case "$refname","$newrev_type" in + refs/tags/*,commit) + # un-annotated tag + short_refname=${refname##refs/tags/} + if [ "$allowunannotated" != "true" ]; then + echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2 + echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2 + exit 1 + fi + ;; + refs/tags/*,delete) + # delete tag + if [ "$allowdeletetag" != "true" ]; then + echo "*** Deleting a tag is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/tags/*,tag) + # annotated tag + if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1 + then + echo "*** Tag '$refname' already exists." >&2 + echo "*** Modifying a tag is not allowed in this repository." >&2 + exit 1 + fi + ;; + refs/heads/*,commit) + # branch + if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then + echo "*** Creating a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/heads/*,delete) + # delete branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/remotes/*,commit) + # tracking branch + ;; + refs/remotes/*,delete) + # delete tracking branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a tracking branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + *) + # Anything else (is there anything else?) + echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2 + exit 1 + ;; +esac + +# --- Finished +exit 0 diff --git a/build/latex/academia/git_template/info/exclude b/build/latex/academia/git_template/info/exclude new file mode 100644 index 0000000..a5196d1 --- /dev/null +++ b/build/latex/academia/git_template/info/exclude @@ -0,0 +1,6 @@ +# git ls-files --others --exclude-from=.git/info/exclude +# Lines that start with '#' are comments. +# For a project mostly in C, the following would be a good set of +# exclude patterns (uncomment them if you want to use them): +# *.[oa] +# *~ diff --git a/build/latex/academia/init b/build/latex/academia/init index 1ea1603..f8c8bb3 100644 --- a/build/latex/academia/init +++ b/build/latex/academia/init @@ -10,13 +10,18 @@ trap "cleanup; remove_self" EXIT cleanup() { rm "$replacement_file" } +avoid_cleanup="false" remove_self() { - rm "$(realpath "$0")" - rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + if [ "$avoid_cleanup" = "false" ]; then + rm "$(realpath "$0")" + rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + [ -f "$(realpath "$(dirname "$0")")/init.local" ] && rm "$(realpath "$(dirname "$0")")/init.local" + fi } require() { program="$1" if ! command -v "$program" >/dev/null; then + avoid_cleanup="true" echo "Please install '$program' for this init script to work." 1>&2 exit 1 fi @@ -64,8 +69,6 @@ require mv require sed require chmod -git init - # necessary meta data prompt APPLICATION_NAME "The name of the application" "$(basename "$PWD")" prompt APPLICATION_NAME_STYLIZED "The stylized name of the application (for documentation)" "$(echo "$APPLICATION_NAME" | sed 's/[_-]/ /g' | sed 's/^\(\w\)/\U\1/g' | sed 's/ \(\w\)/ \U\1/g')" @@ -78,7 +81,15 @@ prompt AUTHOR_EMAIL "The email of the author (or authors)" "$(git config --get u # cog change-log variables prompt REMOTE "The remote, this project will be pushed to" "git.vhack.eu" prompt REPOSITORY "The path of the repository on the remote" "$APPLICATION_NAME" -prompt OWNER "The name of owner of the repository" "$AUTHOR_NAME" + +owner1="$(printf "%.1s" "$AUTHOR_NAME")" +owner2="${AUTHOR_NAME#* }" +if [ "$owner2" = "$AUTHOR_NAME" ]; then + owner_build="$(echo "$AUTHOR_NAME" | tr '[:upper:]' '[:lower:]')" +else + owner_build="$(echo "$owner1$owner2" | tr '[:upper:]' '[:lower:]')" +fi +prompt OWNER "The name of owner of the repository" "$owner_build" # nice meta data prompt DESCRIPTION "The description of this project" "" @@ -88,7 +99,12 @@ prompt APPLICATION_SOURCE_CODE_REPOSITORY "The package's source code repository prompt HOME_PAGE "The home page URL of the project" "https://$REPOSITORY.org/" prompt BUG_URL "The URL people should report bugs to" "$APPLICATION_SOURCE_CODE_REPOSITORY/issues" -if [ -e ./lpm.toml ]; then +# git stuff +prompt PUSH_URL "The url used to push this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt CLONE_URL "The url used to clone this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt MAIN_BRANCH "The name of the main branch" "$(git config init.defaultbranch)" + +if [ -e ./watch.sh ]; then # Use a different default license in latex projects. init_default_license="CC-BY-SA-4.0" else @@ -105,7 +121,7 @@ fi prompt LICENSE_URL "The url of the license" "$default_license_url" if [ -e ./.reuse/templates/default.jinja2 ]; then - cat <<EOF | fmt --uniform-spacing --width=75 >./.reuse/templates/default.jinja2 + cat <<EOF | fmt --uniform-spacing --width=85 --split-only >./.reuse/templates/default.jinja2 {% for copyright_line in copyright_lines %} {{ copyright_line }} {% endfor %} @@ -120,14 +136,14 @@ This file is part of $APPLICATION_NAME_STYLIZED - $DESCRIPTION. You should have received a copy of the License along with this program. If not, see <$LICENSE_URL>. -<!-- vim: ft=htmldjango --> EOF fi # Allow templates to add template specific prompts [ -e init.local ] && . ./init.local -echo "$DESCRIPTION" >.git/description +git init --initial-branch "$MAIN_BRANCH" --template="./git_template" +rm --recursive ./git_template while read -r var; do var_name="${var%=*}" @@ -148,5 +164,19 @@ done <"$replacement_file" chmod +x scripts/* chmod +x update.sh [ -f ./build.sh ] && chmod +x build.sh +[ -f ./watch.sh ] && chmod +x build.sh + +# Do the first run of reuse annotate +reuse="$(nix build nixpkgs#reuse --no-link --print-out-paths)" +[ "$(echo "$reuse" | wc -l)" -ne 1 ] && die "Something is wrong with the nixpkgs#reuse derivation" + +git add . + +git diff --name-only --cached | + xargs -I {} "$reuse" annotate \ + --copyright "$AUTHOR_NAME <$AUTHOR_EMAIL>" \ + --copyright-style string-c \ + --template default \ + --license "$SPDX_LICENSE_IDENTIFIER" "{}" # vim: ft=sh diff --git a/build/latex/academia/possible_resources_for_v3_template.txt b/build/latex/academia/possible_resources_for_v3_template.txt deleted file mode 100644 index 4232d52..0000000 --- a/build/latex/academia/possible_resources_for_v3_template.txt +++ /dev/null @@ -1,15 +0,0 @@ -https://davidcarlisle.github.io/uk-tex-faq/ -https://ctan.org/tex-archive/info/knuth-pdf -https://www.ctan.org/pkg/texinfo -https://davidcarlisle.github.io/uk-tex-faq/FAQ-LaTeX2HTML.html -https://www.w3.org/Tools/Word_proc_filters.html -https://davidcarlisle.github.io/uk-tex-faq/FAQ-mathml.html --- -https://ctan.org/pkg/l3kernel -https://stackoverflow.com/questions/2918449/inlining-the-latex-input-command -https://ctan.org/tex-archive/support/flatten -https://ctan.org/tex-archive/support/flatex -http://www.math.tau.ac.il/~sariel/flatex.html -https://mirror.funkfreundelandshut.de/latex/macros/latex/required/l3kernel/expl3.pdf -https://tex.stackexchange.com/questions/24932/moving-to-latex3-for-package-authors -https://ctan.org/pkg/l3packages diff --git a/build/latex/academia/scripts/cprh.sh b/build/latex/academia/scripts/cprh.sh deleted file mode 100755 index 9582575..0000000 --- a/build/latex/academia/scripts/cprh.sh +++ /dev/null @@ -1,57 +0,0 @@ -#! /usr/bin/env sh - -die() { - echo "$@" 1>&2 - exit 1 -} - -help() { - cat <<EOF -A copyright header managment tool. - -USAGE: - cprh.sh [OPTIONS] contribute NAME EMAIL FILE.. - -OPTIONS: - --help | -h - Display this help and exit. - -ARGUMENTS: - NAME := [[git config user.name]] - Your name. - - NAME := [[git config user.email]] - Your email address. - - FILE := [[git diff --name-only --cached]] - The file you want to change. This can be given multiple times. -EOF -} - -for arg in "$@"; do - case "$arg" in - "--help" | "-h") - help - exit 0 - ;; - *) - echo "'$1' is not a recognized option. See --help for more!" 1>&2 - exit 1 - ;; - esac -done - -user_name="$1" -[ -z "$user_name" ] && die "No NAME set! See --help for more" - -user_email="$2" -[ -z "$user_email" ] && die "No EMAIL set! See --help for more" -shift 2 - -styleOne="" -styleTwo="" -[ "$COMMENT_STYLE" ] && styleOne="--style" && styleTwo="$COMMENT_STYLE" - -# The styleTwo must be unquoted to avoid adding empty args to reuse -# shellcheck disable=2086 -reuse annotate --copyright "$user_name <$user_email>" --copyright-prefix string-c --template default --multi-line $styleOne $styleTwo diff --git a/build/latex/letter/%INIT_APPLICATION_NAME.tex b/build/latex/letter/%INIT_APPLICATION_NAME.tex index 2037aa6..f85e8c7 100644 --- a/build/latex/letter/%INIT_APPLICATION_NAME.tex +++ b/build/latex/letter/%INIT_APPLICATION_NAME.tex @@ -7,43 +7,36 @@ \usepackage{url} \usepackage[%INIT_DATE_TIME_LANGUAGE, showdow]{datetime2} % make handling dates easier -\setkomafont{fromname}{\sffamily \LARGE} -\setkomafont{fromaddress}{\sffamily}%% statt \small -\setkomafont{pagenumber}{\sffamily} -\setkomafont{subject}{\bfseries} \setkomafont{backaddress}{\mdseries} \LoadLetterOption{DIN} -% \setkomavar{backaddressseparator}{\enspace\textperiodcentered\enspace} -% \setkomavar{backaddress}{%INIT_AUTHOR_NAME\\ PO Box 8421\\ Bachbrecht\\10007\\ Namibia} -\setkomavar{backaddressseparator}{ $\cdot$ } -\setkomavar{customer}{2342} -\setkomavar{date}{\DTMToday} +\setkomavar{backaddressseparator}{\enspace\textperiodcentered\enspace} \setkomavar{enclseparator}{: } + \setkomavar{fromaddress}{Musterstraße 00\\00000 Musterort} \setkomavar{fromemail}{%INIT_AUTHOR_EMAIL} \setkomavar{fromname}{%INIT_AUTHOR_NAME} \setkomavar{fromphone}{+49 0000 00\,00\,00\,0} +\setkomavar{fromzipcode}{00000} \setkomavar{place}{Musterort} + +\setkomavar{date}{\DTMToday} \setkomavar{signature}{%INIT_AUTHOR_NAME} \setkomavar{subject}{%INIT_APPLICATION_NAME_STYLIZED} - -\renewcommand*{\raggedsignature}{\raggedright} +\setkomavar{title}{Title?} \KOMAoptions{% addrfield=true, % Adress field for envelope with window backaddress=true, % Sender address in this window - enlargefirstpage=true, % More space on first page + enlargefirstpage=false, % More space on first page foldmarks=true, % Print foldmarks? footsepline=true, % separate the footer with a line on page >1 - fromalign=center, % alignment of the address - % fromalign=right, % Placement of name in letter head + fromalign=right, % Placement of name in letter head fromemail=true, % print sender e-mail address fromfax=false, % print sender fax number fromlogo=false, % print a logo (position depends on fromalign) fromphone=true, % print sender phone number - fromrule=afteraddress, % separate the address with a line? - % fromrule=aftername, % Rule after sender name in letter head + fromrule=aftername, % Rule after sender name in letter head fromurl=false, % print sender URL headsepline=true, % separate the header with a line on page >1 locfield=narrow, % Additional field for sender diff --git a/build/latex/letter/README.md b/build/latex/letter/README.md index 9c5c6da..6dad42c 100644 --- a/build/latex/letter/README.md +++ b/build/latex/letter/README.md @@ -3,6 +3,7 @@ > %INIT_DESCRIPTION ## Licensing + This project complies with the REUSE v3.2 specification. This means that every file clearly states its copyright. Please run `./scripts/cprh.sh contributer NAME EMAIL FILES..` after you diff --git a/build/latex/letter/cog.toml b/build/latex/letter/cog.toml index ccca764..ebb3a5d 100644 --- a/build/latex/letter/cog.toml +++ b/build/latex/letter/cog.toml @@ -3,10 +3,10 @@ branch_whitelist = ["main", "prime"] ignore_merge_commits = false pre_bump_hooks = [ - "nix flake check", # verify the project builds - "./scripts/renew_copyright_header.sh", # update the license header in each file - "flake_version_update --version v{{version}} --input-file flake.nix", # update the version in the flake.nix file - "nix fmt", # format + "reuse lint", # Check licensing status. + "nix flake check", # Verify the project builds. + "flake_version_update --version v{{version}} --input-file flake.nix", # Bump the version in the flake.nix file + "nix fmt", # Format. ] post_bump_hooks = [ "git push", diff --git a/build/latex/letter/git_template/config b/build/latex/letter/git_template/config new file mode 100644 index 0000000..f0c8d31 --- /dev/null +++ b/build/latex/letter/git_template/config @@ -0,0 +1,7 @@ +[remote "origin"] + url = %INIT_CLONE_URL + fetch = +refs/heads/*:refs/remotes/origin/* + pushurl = %INIT_PUSH_URL +[branch "%INIT_MAIN_BRANCH"] + remote = origin + merge = refs/heads/%INIT_MAIN_BRANCH diff --git a/build/latex/letter/git_template/description b/build/latex/letter/git_template/description new file mode 100644 index 0000000..bf2d1bf --- /dev/null +++ b/build/latex/letter/git_template/description @@ -0,0 +1 @@ +%INIT_DESCRIPTION diff --git a/build/latex/letter/git_template/hooks/applypatch-msg.sample b/build/latex/letter/git_template/hooks/applypatch-msg.sample new file mode 100644 index 0000000..e6c87c6 --- /dev/null +++ b/build/latex/letter/git_template/hooks/applypatch-msg.sample @@ -0,0 +1,15 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message taken by +# applypatch from an e-mail 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, rename this file to "applypatch-msg". + +. git-sh-setup +commitmsg="$(git rev-parse --git-path hooks/commit-msg)" +test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"} +: diff --git a/build/latex/letter/git_template/hooks/commit-msg.sample b/build/latex/letter/git_template/hooks/commit-msg.sample new file mode 100644 index 0000000..5604587 --- /dev/null +++ b/build/latex/letter/git_template/hooks/commit-msg.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message. +# 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, rename this file to "commit-msg". + +# Uncomment the below to add a Signed-off-by line to the message. +# Doing this in a hook is a bad idea in general, but the prepare-commit-msg +# hook is more suited to it. +# +# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1" + +# This example catches duplicate Signed-off-by lines. + +test "" = "$(grep '^Signed-off-by: ' "$1" | + sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || { + echo >&2 Duplicate Signed-off-by lines. + exit 1 +} diff --git a/build/latex/letter/git_template/hooks/fsmonitor-watchman.sample b/build/latex/letter/git_template/hooks/fsmonitor-watchman.sample new file mode 100644 index 0000000..367d462 --- /dev/null +++ b/build/latex/letter/git_template/hooks/fsmonitor-watchman.sample @@ -0,0 +1,174 @@ +#!/usr/bin/env perl + +use strict; +use warnings; +use IPC::Open2; + +# An example hook script to integrate Watchman +# (https://facebook.github.io/watchman/) with git to speed up detecting +# new and modified files. +# +# The hook is passed a version (currently 2) and last update token +# formatted as a string and outputs to stdout a new update token and +# all files that have been modified since the update token. Paths must +# be relative to the root of the working tree and separated by a single NUL. +# +# To enable this hook, rename this file to "query-watchman" and set +# 'git config core.fsmonitor .git/hooks/query-watchman' +# +my ($version, $last_update_token) = @ARGV; + +# Uncomment for debugging +# print STDERR "$0 $version $last_update_token\n"; + +# Check the hook interface version +if ($version ne 2) { + die "Unsupported query-fsmonitor hook version '$version'.\n" . + "Falling back to scanning...\n"; +} + +my $git_work_tree = get_working_dir(); + +my $retry = 1; + +my $json_pkg; +eval { + require JSON::XS; + $json_pkg = "JSON::XS"; + 1; +} or do { + require JSON::PP; + $json_pkg = "JSON::PP"; +}; + +launch_watchman(); + +sub launch_watchman { + my $o = watchman_query(); + if (is_work_tree_watched($o)) { + output_result($o->{clock}, @{$o->{files}}); + } +} + +sub output_result { + my ($clockid, @files) = @_; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # binmode $fh, ":utf8"; + # print $fh "$clockid\n@files\n"; + # close $fh; + + binmode STDOUT, ":utf8"; + print $clockid; + print "\0"; + local $, = "\0"; + print @files; +} + +sub watchman_clock { + my $response = qx/watchman clock "$git_work_tree"/; + die "Failed to get clock id on '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + + return $json_pkg->new->utf8->decode($response); +} + +sub watchman_query { + my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty') + or die "open2() failed: $!\n" . + "Falling back to scanning...\n"; + + # In the query expression below we're asking for names of files that + # changed since $last_update_token but not from the .git folder. + # + # To accomplish this, we're using the "since" generator to use the + # recency index to select candidate nodes and "fields" to limit the + # output to file names only. Then we're using the "expression" term to + # further constrain the results. + my $last_update_line = ""; + if (substr($last_update_token, 0, 1) eq "c") { + $last_update_token = "\"$last_update_token\""; + $last_update_line = qq[\n"since": $last_update_token,]; + } + my $query = <<" END"; + ["query", "$git_work_tree", {$last_update_line + "fields": ["name"], + "expression": ["not", ["dirname", ".git"]] + }] + END + + # Uncomment for debugging the watchman query + # open (my $fh, ">", ".git/watchman-query.json"); + # print $fh $query; + # close $fh; + + print CHLD_IN $query; + close CHLD_IN; + my $response = do {local $/; <CHLD_OUT>}; + + # Uncomment for debugging the watch response + # open ($fh, ">", ".git/watchman-response.json"); + # print $fh $response; + # close $fh; + + die "Watchman: command returned no output.\n" . + "Falling back to scanning...\n" if $response eq ""; + die "Watchman: command returned invalid output: $response\n" . + "Falling back to scanning...\n" unless $response =~ /^\{/; + + return $json_pkg->new->utf8->decode($response); +} + +sub is_work_tree_watched { + my ($output) = @_; + my $error = $output->{error}; + if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) { + $retry--; + my $response = qx/watchman watch "$git_work_tree"/; + die "Failed to make watchman watch '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + $output = $json_pkg->new->utf8->decode($response); + $error = $output->{error}; + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # close $fh; + + # Watchman will always return all files on the first query so + # return the fast "everything is dirty" flag to git and do the + # Watchman query just to get it over with now so we won't pay + # the cost in git to look up each individual file. + my $o = watchman_clock(); + $error = $output->{error}; + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + output_result($o->{clock}, ("/")); + $last_update_token = $o->{clock}; + + eval { launch_watchman() }; + return 0; + } + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + return 1; +} + +sub get_working_dir { + my $working_dir; + if ($^O =~ 'msys' || $^O =~ 'cygwin') { + $working_dir = Win32::GetCwd(); + $working_dir =~ tr/\\/\//; + } else { + require Cwd; + $working_dir = Cwd::cwd(); + } + + return $working_dir; +} diff --git a/build/latex/letter/git_template/hooks/post-update.sample b/build/latex/letter/git_template/hooks/post-update.sample new file mode 100644 index 0000000..e3b3f9f --- /dev/null +++ b/build/latex/letter/git_template/hooks/post-update.sample @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare a packed repository for use over +# dumb transports. +# +# To enable this hook, rename this file to "post-update". + +exec git update-server-info diff --git a/build/latex/letter/git_template/hooks/pre-applypatch.sample b/build/latex/letter/git_template/hooks/pre-applypatch.sample new file mode 100644 index 0000000..c414f0e --- /dev/null +++ b/build/latex/letter/git_template/hooks/pre-applypatch.sample @@ -0,0 +1,14 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed +# by applypatch from an e-mail message. +# +# The hook should exit with non-zero status after issuing an +# appropriate message if it wants to stop the commit. +# +# To enable this hook, rename this file to "pre-applypatch". + +. git-sh-setup +precommit="$(git rev-parse --git-path hooks/pre-commit)" +test -x "$precommit" && exec "$precommit" ${1+"$@"} +: diff --git a/build/latex/letter/git_template/hooks/pre-commit.sample b/build/latex/letter/git_template/hooks/pre-commit.sample new file mode 100644 index 0000000..55f180d --- /dev/null +++ b/build/latex/letter/git_template/hooks/pre-commit.sample @@ -0,0 +1,49 @@ +#!/usr/bin/env bash +# +# An example 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. +# +# To enable this hook, rename this file to "pre-commit". + +if git rev-parse --verify HEAD >/dev/null 2>&1 +then + against=HEAD +else + # Initial commit: diff against an empty tree object + against=$(git hash-object -t tree /dev/null) +fi + +# If you want to allow non-ASCII filenames set this variable to true. +allownonascii=$(git config --type=bool hooks.allownonascii) + +# Redirect output to stderr. +exec 1>&2 + +# 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" != "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. + test $(git diff-index --cached --name-only --diff-filter=A -z $against | + LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0 +then + cat <<\EOF +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 +EOF + exit 1 +fi + +# If there are whitespace errors, print the offending file names and fail. +exec git diff-index --check --cached $against -- diff --git a/build/latex/letter/git_template/hooks/pre-merge-commit.sample b/build/latex/letter/git_template/hooks/pre-merge-commit.sample new file mode 100644 index 0000000..0ed3c36 --- /dev/null +++ b/build/latex/letter/git_template/hooks/pre-merge-commit.sample @@ -0,0 +1,13 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed. +# Called by "git merge" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message to +# stderr if it wants to stop the merge commit. +# +# To enable this hook, rename this file to "pre-merge-commit". + +. git-sh-setup +test -x "$GIT_DIR/hooks/pre-commit" && + exec "$GIT_DIR/hooks/pre-commit" +: diff --git a/build/latex/letter/git_template/hooks/pre-push.sample b/build/latex/letter/git_template/hooks/pre-push.sample new file mode 100644 index 0000000..cb27ddb --- /dev/null +++ b/build/latex/letter/git_template/hooks/pre-push.sample @@ -0,0 +1,53 @@ +#!/usr/bin/env bash + +# An example hook script to verify what is about to be pushed. Called by "git +# push" after it has checked the remote status, but before anything has been +# pushed. If this script exits with a non-zero status nothing will be pushed. +# +# This hook is called with the following parameters: +# +# $1 -- Name of the remote to which the push is being done +# $2 -- URL to which the push is being done +# +# If pushing without using a named remote those arguments will be equal. +# +# Information about the commits which are being pushed is supplied as lines to +# the standard input in the form: +# +# <local ref> <local oid> <remote ref> <remote oid> +# +# This sample shows how to prevent push of commits where the log message starts +# with "WIP" (work in progress). + +remote="$1" +url="$2" + +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') + +while read local_ref local_oid remote_ref remote_oid +do + if test "$local_oid" = "$zero" + then + # Handle delete + : + else + if test "$remote_oid" = "$zero" + then + # New branch, examine all commits + range="$local_oid" + else + # Update to existing branch, examine new commits + range="$remote_oid..$local_oid" + fi + + # Check for WIP commit + commit=$(git rev-list -n 1 --grep '^WIP' "$range") + if test -n "$commit" + then + echo >&2 "Found WIP commit in $local_ref, not pushing" + exit 1 + fi + fi +done + +exit 0 diff --git a/build/latex/letter/git_template/hooks/pre-rebase.sample b/build/latex/letter/git_template/hooks/pre-rebase.sample new file mode 100644 index 0000000..d062617 --- /dev/null +++ b/build/latex/letter/git_template/hooks/pre-rebase.sample @@ -0,0 +1,169 @@ +#!/usr/bin/env bash +# +# Copyright (c) 2006, 2008 Junio C Hamano +# +# The "pre-rebase" hook is run just before "git rebase" starts doing +# its job, and can prevent the command from running by exiting with +# non-zero status. +# +# The hook is called with the following parameters: +# +# $1 -- the upstream the series was forked from. +# $2 -- the branch being rebased (or empty when rebasing the current branch). +# +# This sample shows how to prevent topic branches that are already +# merged to 'next' branch from getting rebased, because allowing it +# would result in rebasing already published history. + +publish=next +basebranch="$1" +if test "$#" = 2 +then + topic="refs/heads/$2" +else + topic=`git symbolic-ref HEAD` || + exit 0 ;# we do not interrupt rebasing detached HEAD +fi + +case "$topic" in +refs/heads/??/*) + ;; +*) + exit 0 ;# we do not interrupt others. + ;; +esac + +# Now we are dealing with a topic branch being rebased +# on top of master. Is it OK to rebase it? + +# Does the topic really exist? +git show-ref -q "$topic" || { + echo >&2 "No such branch $topic" + exit 1 +} + +# Is topic fully merged to master? +not_in_master=`git rev-list --pretty=oneline ^master "$topic"` +if test -z "$not_in_master" +then + echo >&2 "$topic is fully merged to master; better remove it." + exit 1 ;# we could allow it, but there is no point. +fi + +# Is topic ever merged to next? If so you should not be rebasing it. +only_next_1=`git rev-list ^master "^$topic" ${publish} | sort` +only_next_2=`git rev-list ^master ${publish} | sort` +if test "$only_next_1" = "$only_next_2" +then + not_in_topic=`git rev-list "^$topic" master` + if test -z "$not_in_topic" + then + echo >&2 "$topic is already up to date with master" + exit 1 ;# we could allow it, but there is no point. + else + exit 0 + fi +else + not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"` + /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -e ' + my $topic = $ARGV[0]; + my $msg = "* $topic has commits already merged to public branch:\n"; + my (%not_in_next) = map { + /^([0-9a-f]+) /; + ($1 => 1); + } split(/\n/, $ARGV[1]); + for my $elem (map { + /^([0-9a-f]+) (.*)$/; + [$1 => $2]; + } split(/\n/, $ARGV[2])) { + if (!exists $not_in_next{$elem->[0]}) { + if ($msg) { + print STDERR $msg; + undef $msg; + } + print STDERR " $elem->[1]\n"; + } + } + ' "$topic" "$not_in_next" "$not_in_master" + exit 1 +fi + +<<\DOC_END + +This sample hook safeguards topic branches that have been +published from being rewound. + +The workflow assumed here is: + + * Once a topic branch forks from "master", "master" is never + merged into it again (either directly or indirectly). + + * Once a topic branch is fully cooked and merged into "master", + it is deleted. If you need to build on top of it to correct + earlier mistakes, a new topic branch is created by forking at + the tip of the "master". This is not strictly necessary, but + it makes it easier to keep your history simple. + + * Whenever you need to test or publish your changes to topic + branches, merge them into "next" branch. + +The script, being an example, hardcodes the publish branch name +to be "next", but it is trivial to make it configurable via +$GIT_DIR/config mechanism. + +With this workflow, you would want to know: + +(1) ... if a topic branch has ever been merged to "next". Young + topic branches can have stupid mistakes you would rather + clean up before publishing, and things that have not been + merged into other branches can be easily rebased without + affecting other people. But once it is published, you would + not want to rewind it. + +(2) ... if a topic branch has been fully merged to "master". + Then you can delete it. More importantly, you should not + build on top of it -- other people may already want to + change things related to the topic as patches against your + "master", so if you need further changes, it is better to + fork the topic (perhaps with the same name) afresh from the + tip of "master". + +Let's look at this example: + + o---o---o---o---o---o---o---o---o---o "next" + / / / / + / a---a---b A / / + / / / / + / / c---c---c---c B / + / / / \ / + / / / b---b C \ / + / / / / \ / + ---o---o---o---o---o---o---o---o---o---o---o "master" + + +A, B and C are topic branches. + + * A has one fix since it was merged up to "next". + + * B has finished. It has been fully merged up to "master" and "next", + and is ready to be deleted. + + * C has not merged to "next" at all. + +We would want to allow C to be rebased, refuse A, and encourage +B to be deleted. + +To compute (1): + + git rev-list ^master ^topic next + git rev-list ^master next + + if these match, topic has not merged in next at all. + +To compute (2): + + git rev-list master..topic + + if this is empty, it is fully merged to "master". + +DOC_END diff --git a/build/latex/letter/git_template/hooks/pre-receive.sample b/build/latex/letter/git_template/hooks/pre-receive.sample new file mode 100644 index 0000000..0bf2643 --- /dev/null +++ b/build/latex/letter/git_template/hooks/pre-receive.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to make use of push options. +# The example simply echoes all push options that start with 'echoback=' +# and rejects all pushes when the "reject" push option is used. +# +# To enable this hook, rename this file to "pre-receive". + +if test -n "$GIT_PUSH_OPTION_COUNT" +then + i=0 + while test "$i" -lt "$GIT_PUSH_OPTION_COUNT" + do + eval "value=\$GIT_PUSH_OPTION_$i" + case "$value" in + echoback=*) + echo "echo from the pre-receive-hook: ${value#*=}" >&2 + ;; + reject) + exit 1 + esac + i=$((i + 1)) + done +fi diff --git a/build/latex/letter/git_template/hooks/prepare-commit-msg.sample b/build/latex/letter/git_template/hooks/prepare-commit-msg.sample new file mode 100644 index 0000000..24283a0 --- /dev/null +++ b/build/latex/letter/git_template/hooks/prepare-commit-msg.sample @@ -0,0 +1,42 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare the commit log message. +# Called by "git commit" with the name of the file that has the +# commit message, followed by the description of the commit +# message's source. The hook's purpose is to edit the commit +# message file. If the hook fails with a non-zero status, +# the commit is aborted. +# +# To enable this hook, rename this file to "prepare-commit-msg". + +# This hook includes three examples. The first one removes the +# "# Please enter the commit message..." help message. +# +# The second includes the output of "git diff --name-status -r" +# into the message, just before the "git status" output. It is +# commented because it doesn't cope with --amend or with squashed +# commits. +# +# The third example adds a Signed-off-by line to the message, that can +# still be edited. This is rarely a good idea. + +COMMIT_MSG_FILE=$1 +COMMIT_SOURCE=$2 +SHA1=$3 + +/nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE" + +# case "$COMMIT_SOURCE,$SHA1" in +# ,|template,) +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe ' +# print "\n" . `git diff --cached --name-status -r` +# if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;; +# *) ;; +# esac + +# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE" +# if test -z "$COMMIT_SOURCE" +# then +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE" +# fi diff --git a/build/latex/letter/git_template/hooks/push-to-checkout.sample b/build/latex/letter/git_template/hooks/push-to-checkout.sample new file mode 100644 index 0000000..07fa538 --- /dev/null +++ b/build/latex/letter/git_template/hooks/push-to-checkout.sample @@ -0,0 +1,78 @@ +#!/usr/bin/env bash + +# An example hook script to update a checked-out tree on a git push. +# +# This hook is invoked by git-receive-pack(1) when it reacts to git +# push and updates reference(s) in its repository, and when the push +# tries to update the branch that is currently checked out and the +# receive.denyCurrentBranch configuration variable is set to +# updateInstead. +# +# By default, such a push is refused if the working tree and the index +# of the remote repository has any difference from the currently +# checked out commit; when both the working tree and the index match +# the current commit, they are updated to match the newly pushed tip +# of the branch. This hook is to be used to override the default +# behaviour; however the code below reimplements the default behaviour +# as a starting point for convenient modification. +# +# The hook receives the commit with which the tip of the current +# branch is going to be updated: +commit=$1 + +# It can exit with a non-zero status to refuse the push (when it does +# so, it must not modify the index or the working tree). +die () { + echo >&2 "$*" + exit 1 +} + +# Or it can make any necessary changes to the working tree and to the +# index to bring them to the desired state when the tip of the current +# branch is updated to the new commit, and exit with a zero status. +# +# For example, the hook can simply run git read-tree -u -m HEAD "$1" +# in order to emulate git fetch that is run in the reverse direction +# with git push, as the two-tree form of git read-tree -u -m is +# essentially the same as git switch or git checkout that switches +# branches while keeping the local changes in the working tree that do +# not interfere with the difference between the branches. + +# The below is a more-or-less exact translation to shell of the C code +# for the default behaviour for git's push-to-checkout hook defined in +# the push_to_deploy() function in builtin/receive-pack.c. +# +# Note that the hook will be executed from the repository directory, +# not from the working tree, so if you want to perform operations on +# the working tree, you will have to adapt your code accordingly, e.g. +# by adding "cd .." or using relative paths. + +if ! git update-index -q --ignore-submodules --refresh +then + die "Up-to-date check failed" +fi + +if ! git diff-files --quiet --ignore-submodules -- +then + die "Working directory has unstaged changes" +fi + +# This is a rough translation of: +# +# head_has_history() ? "HEAD" : EMPTY_TREE_SHA1_HEX +if git cat-file -e HEAD 2>/dev/null +then + head=HEAD +else + head=$(git hash-object -t tree --stdin </dev/null) +fi + +if ! git diff-index --quiet --cached --ignore-submodules $head -- +then + die "Working directory has staged changes" +fi + +if ! git read-tree -u -m "$commit" +then + die "Could not update working tree to new HEAD" +fi diff --git a/build/latex/letter/git_template/hooks/sendemail-validate.sample b/build/latex/letter/git_template/hooks/sendemail-validate.sample new file mode 100644 index 0000000..52aa61c --- /dev/null +++ b/build/latex/letter/git_template/hooks/sendemail-validate.sample @@ -0,0 +1,77 @@ +#!/usr/bin/env bash + +# An example hook script to validate a patch (and/or patch series) before +# sending it via email. +# +# The hook should exit with non-zero status after issuing an appropriate +# message if it wants to prevent the email(s) from being sent. +# +# To enable this hook, rename this file to "sendemail-validate". +# +# By default, it will only check that the patch(es) can be applied on top of +# the default upstream branch without conflicts in a secondary worktree. After +# validation (successful or not) of the last patch of a series, the worktree +# will be deleted. +# +# The following config variables can be set to change the default remote and +# remote ref that are used to apply the patches against: +# +# sendemail.validateRemote (default: origin) +# sendemail.validateRemoteRef (default: HEAD) +# +# Replace the TODO placeholders with appropriate checks according to your +# needs. + +validate_cover_letter () { + file="$1" + # TODO: Replace with appropriate checks (e.g. spell checking). + true +} + +validate_patch () { + file="$1" + # Ensure that the patch applies without conflicts. + git am -3 "$file" || return + # TODO: Replace with appropriate checks for this patch + # (e.g. checkpatch.pl). + true +} + +validate_series () { + # TODO: Replace with appropriate checks for the whole series + # (e.g. quick build, coding style checks, etc.). + true +} + +# main ------------------------------------------------------------------------- + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = 1 +then + remote=$(git config --default origin --get sendemail.validateRemote) && + ref=$(git config --default HEAD --get sendemail.validateRemoteRef) && + worktree=$(mktemp --tmpdir -d sendemail-validate.XXXXXXX) && + git worktree add -fd --checkout "$worktree" "refs/remotes/$remote/$ref" && + git config --replace-all sendemail.validateWorktree "$worktree" +else + worktree=$(git config --get sendemail.validateWorktree) +fi || { + echo "sendemail-validate: error: failed to prepare worktree" >&2 + exit 1 +} + +unset GIT_DIR GIT_WORK_TREE +cd "$worktree" && + +if grep -q "^diff --git " "$1" +then + validate_patch "$1" +else + validate_cover_letter "$1" +fi && + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = "$GIT_SENDEMAIL_FILE_TOTAL" +then + git config --unset-all sendemail.validateWorktree && + trap 'git worktree remove -ff "$worktree"' EXIT && + validate_series +fi diff --git a/build/latex/letter/git_template/hooks/update.sample b/build/latex/letter/git_template/hooks/update.sample new file mode 100644 index 0000000..1910758 --- /dev/null +++ b/build/latex/letter/git_template/hooks/update.sample @@ -0,0 +1,128 @@ +#!/usr/bin/env bash +# +# An example hook script to block unannotated tags from entering. +# Called by "git receive-pack" with arguments: refname sha1-old sha1-new +# +# To enable this hook, rename this file to "update". +# +# Config +# ------ +# hooks.allowunannotated +# This boolean sets whether unannotated tags will be allowed into the +# repository. By default they won't be. +# hooks.allowdeletetag +# This boolean sets whether deleting tags will be allowed in the +# repository. By default they won't be. +# hooks.allowmodifytag +# This boolean sets whether a tag may be modified after creation. By default +# it won't be. +# hooks.allowdeletebranch +# This boolean sets whether deleting branches will be allowed in the +# repository. By default they won't be. +# hooks.denycreatebranch +# This boolean sets whether remotely creating branches will be denied +# in the repository. By default this is allowed. +# + +# --- Command line +refname="$1" +oldrev="$2" +newrev="$3" + +# --- Safety check +if [ -z "$GIT_DIR" ]; then + echo "Don't run this script from the command line." >&2 + echo " (if you want, you could supply GIT_DIR then run" >&2 + echo " $0 <ref> <oldrev> <newrev>)" >&2 + exit 1 +fi + +if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then + echo "usage: $0 <ref> <oldrev> <newrev>" >&2 + exit 1 +fi + +# --- Config +allowunannotated=$(git config --type=bool hooks.allowunannotated) +allowdeletebranch=$(git config --type=bool hooks.allowdeletebranch) +denycreatebranch=$(git config --type=bool hooks.denycreatebranch) +allowdeletetag=$(git config --type=bool hooks.allowdeletetag) +allowmodifytag=$(git config --type=bool hooks.allowmodifytag) + +# check for no description +projectdesc=$(sed -e '1q' "$GIT_DIR/description") +case "$projectdesc" in +"Unnamed repository"* | "") + echo "*** Project description file hasn't been set" >&2 + exit 1 + ;; +esac + +# --- Check types +# if $newrev is 0000...0000, it's a commit to delete a ref. +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') +if [ "$newrev" = "$zero" ]; then + newrev_type=delete +else + newrev_type=$(git cat-file -t $newrev) +fi + +case "$refname","$newrev_type" in + refs/tags/*,commit) + # un-annotated tag + short_refname=${refname##refs/tags/} + if [ "$allowunannotated" != "true" ]; then + echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2 + echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2 + exit 1 + fi + ;; + refs/tags/*,delete) + # delete tag + if [ "$allowdeletetag" != "true" ]; then + echo "*** Deleting a tag is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/tags/*,tag) + # annotated tag + if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1 + then + echo "*** Tag '$refname' already exists." >&2 + echo "*** Modifying a tag is not allowed in this repository." >&2 + exit 1 + fi + ;; + refs/heads/*,commit) + # branch + if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then + echo "*** Creating a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/heads/*,delete) + # delete branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/remotes/*,commit) + # tracking branch + ;; + refs/remotes/*,delete) + # delete tracking branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a tracking branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + *) + # Anything else (is there anything else?) + echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2 + exit 1 + ;; +esac + +# --- Finished +exit 0 diff --git a/build/latex/letter/git_template/info/exclude b/build/latex/letter/git_template/info/exclude new file mode 100644 index 0000000..a5196d1 --- /dev/null +++ b/build/latex/letter/git_template/info/exclude @@ -0,0 +1,6 @@ +# git ls-files --others --exclude-from=.git/info/exclude +# Lines that start with '#' are comments. +# For a project mostly in C, the following would be a good set of +# exclude patterns (uncomment them if you want to use them): +# *.[oa] +# *~ diff --git a/build/latex/letter/init b/build/latex/letter/init index 1ea1603..f8c8bb3 100644 --- a/build/latex/letter/init +++ b/build/latex/letter/init @@ -10,13 +10,18 @@ trap "cleanup; remove_self" EXIT cleanup() { rm "$replacement_file" } +avoid_cleanup="false" remove_self() { - rm "$(realpath "$0")" - rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + if [ "$avoid_cleanup" = "false" ]; then + rm "$(realpath "$0")" + rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + [ -f "$(realpath "$(dirname "$0")")/init.local" ] && rm "$(realpath "$(dirname "$0")")/init.local" + fi } require() { program="$1" if ! command -v "$program" >/dev/null; then + avoid_cleanup="true" echo "Please install '$program' for this init script to work." 1>&2 exit 1 fi @@ -64,8 +69,6 @@ require mv require sed require chmod -git init - # necessary meta data prompt APPLICATION_NAME "The name of the application" "$(basename "$PWD")" prompt APPLICATION_NAME_STYLIZED "The stylized name of the application (for documentation)" "$(echo "$APPLICATION_NAME" | sed 's/[_-]/ /g' | sed 's/^\(\w\)/\U\1/g' | sed 's/ \(\w\)/ \U\1/g')" @@ -78,7 +81,15 @@ prompt AUTHOR_EMAIL "The email of the author (or authors)" "$(git config --get u # cog change-log variables prompt REMOTE "The remote, this project will be pushed to" "git.vhack.eu" prompt REPOSITORY "The path of the repository on the remote" "$APPLICATION_NAME" -prompt OWNER "The name of owner of the repository" "$AUTHOR_NAME" + +owner1="$(printf "%.1s" "$AUTHOR_NAME")" +owner2="${AUTHOR_NAME#* }" +if [ "$owner2" = "$AUTHOR_NAME" ]; then + owner_build="$(echo "$AUTHOR_NAME" | tr '[:upper:]' '[:lower:]')" +else + owner_build="$(echo "$owner1$owner2" | tr '[:upper:]' '[:lower:]')" +fi +prompt OWNER "The name of owner of the repository" "$owner_build" # nice meta data prompt DESCRIPTION "The description of this project" "" @@ -88,7 +99,12 @@ prompt APPLICATION_SOURCE_CODE_REPOSITORY "The package's source code repository prompt HOME_PAGE "The home page URL of the project" "https://$REPOSITORY.org/" prompt BUG_URL "The URL people should report bugs to" "$APPLICATION_SOURCE_CODE_REPOSITORY/issues" -if [ -e ./lpm.toml ]; then +# git stuff +prompt PUSH_URL "The url used to push this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt CLONE_URL "The url used to clone this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt MAIN_BRANCH "The name of the main branch" "$(git config init.defaultbranch)" + +if [ -e ./watch.sh ]; then # Use a different default license in latex projects. init_default_license="CC-BY-SA-4.0" else @@ -105,7 +121,7 @@ fi prompt LICENSE_URL "The url of the license" "$default_license_url" if [ -e ./.reuse/templates/default.jinja2 ]; then - cat <<EOF | fmt --uniform-spacing --width=75 >./.reuse/templates/default.jinja2 + cat <<EOF | fmt --uniform-spacing --width=85 --split-only >./.reuse/templates/default.jinja2 {% for copyright_line in copyright_lines %} {{ copyright_line }} {% endfor %} @@ -120,14 +136,14 @@ This file is part of $APPLICATION_NAME_STYLIZED - $DESCRIPTION. You should have received a copy of the License along with this program. If not, see <$LICENSE_URL>. -<!-- vim: ft=htmldjango --> EOF fi # Allow templates to add template specific prompts [ -e init.local ] && . ./init.local -echo "$DESCRIPTION" >.git/description +git init --initial-branch "$MAIN_BRANCH" --template="./git_template" +rm --recursive ./git_template while read -r var; do var_name="${var%=*}" @@ -148,5 +164,19 @@ done <"$replacement_file" chmod +x scripts/* chmod +x update.sh [ -f ./build.sh ] && chmod +x build.sh +[ -f ./watch.sh ] && chmod +x build.sh + +# Do the first run of reuse annotate +reuse="$(nix build nixpkgs#reuse --no-link --print-out-paths)" +[ "$(echo "$reuse" | wc -l)" -ne 1 ] && die "Something is wrong with the nixpkgs#reuse derivation" + +git add . + +git diff --name-only --cached | + xargs -I {} "$reuse" annotate \ + --copyright "$AUTHOR_NAME <$AUTHOR_EMAIL>" \ + --copyright-style string-c \ + --template default \ + --license "$SPDX_LICENSE_IDENTIFIER" "{}" # vim: ft=sh diff --git a/build/latex/letter/scripts/cprh.sh b/build/latex/letter/scripts/cprh.sh deleted file mode 100755 index 9582575..0000000 --- a/build/latex/letter/scripts/cprh.sh +++ /dev/null @@ -1,57 +0,0 @@ -#! /usr/bin/env sh - -die() { - echo "$@" 1>&2 - exit 1 -} - -help() { - cat <<EOF -A copyright header managment tool. - -USAGE: - cprh.sh [OPTIONS] contribute NAME EMAIL FILE.. - -OPTIONS: - --help | -h - Display this help and exit. - -ARGUMENTS: - NAME := [[git config user.name]] - Your name. - - NAME := [[git config user.email]] - Your email address. - - FILE := [[git diff --name-only --cached]] - The file you want to change. This can be given multiple times. -EOF -} - -for arg in "$@"; do - case "$arg" in - "--help" | "-h") - help - exit 0 - ;; - *) - echo "'$1' is not a recognized option. See --help for more!" 1>&2 - exit 1 - ;; - esac -done - -user_name="$1" -[ -z "$user_name" ] && die "No NAME set! See --help for more" - -user_email="$2" -[ -z "$user_email" ] && die "No EMAIL set! See --help for more" -shift 2 - -styleOne="" -styleTwo="" -[ "$COMMENT_STYLE" ] && styleOne="--style" && styleTwo="$COMMENT_STYLE" - -# The styleTwo must be unquoted to avoid adding empty args to reuse -# shellcheck disable=2086 -reuse annotate --copyright "$user_name <$user_email>" --copyright-prefix string-c --template default --multi-line $styleOne $styleTwo diff --git a/build/rust/README.md b/build/rust/README.md index 9c5c6da..6dad42c 100644 --- a/build/rust/README.md +++ b/build/rust/README.md @@ -3,6 +3,7 @@ > %INIT_DESCRIPTION ## Licensing + This project complies with the REUSE v3.2 specification. This means that every file clearly states its copyright. Please run `./scripts/cprh.sh contributer NAME EMAIL FILES..` after you diff --git a/build/rust/cog.toml b/build/rust/cog.toml index b4c68e1..5e2eee2 100644 --- a/build/rust/cog.toml +++ b/build/rust/cog.toml @@ -3,10 +3,10 @@ branch_whitelist = ["main", "prime"] ignore_merge_commits = false pre_bump_hooks = [ - "nix flake check", # verify the project builds - "./scripts/renew_copyright_header.sh", # update the license header in each file - "cargo set-version {{version}}", # bump version in Cargo.toml - "nix fmt", # format + "reuse lint", # Check licensing status. + "nix flake check", # Verify the project builds. + "cargo set-version {{version}}", # Bump version in Cargo.toml. + "nix fmt", # Format. ] post_bump_hooks = [ "git push", diff --git a/build/rust/git_template/config b/build/rust/git_template/config new file mode 100644 index 0000000..f0c8d31 --- /dev/null +++ b/build/rust/git_template/config @@ -0,0 +1,7 @@ +[remote "origin"] + url = %INIT_CLONE_URL + fetch = +refs/heads/*:refs/remotes/origin/* + pushurl = %INIT_PUSH_URL +[branch "%INIT_MAIN_BRANCH"] + remote = origin + merge = refs/heads/%INIT_MAIN_BRANCH diff --git a/build/rust/git_template/description b/build/rust/git_template/description new file mode 100644 index 0000000..bf2d1bf --- /dev/null +++ b/build/rust/git_template/description @@ -0,0 +1 @@ +%INIT_DESCRIPTION diff --git a/build/rust/git_template/hooks/applypatch-msg.sample b/build/rust/git_template/hooks/applypatch-msg.sample new file mode 100644 index 0000000..e6c87c6 --- /dev/null +++ b/build/rust/git_template/hooks/applypatch-msg.sample @@ -0,0 +1,15 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message taken by +# applypatch from an e-mail 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, rename this file to "applypatch-msg". + +. git-sh-setup +commitmsg="$(git rev-parse --git-path hooks/commit-msg)" +test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"} +: diff --git a/build/rust/git_template/hooks/commit-msg.sample b/build/rust/git_template/hooks/commit-msg.sample new file mode 100644 index 0000000..5604587 --- /dev/null +++ b/build/rust/git_template/hooks/commit-msg.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message. +# 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, rename this file to "commit-msg". + +# Uncomment the below to add a Signed-off-by line to the message. +# Doing this in a hook is a bad idea in general, but the prepare-commit-msg +# hook is more suited to it. +# +# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1" + +# This example catches duplicate Signed-off-by lines. + +test "" = "$(grep '^Signed-off-by: ' "$1" | + sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || { + echo >&2 Duplicate Signed-off-by lines. + exit 1 +} diff --git a/build/rust/git_template/hooks/fsmonitor-watchman.sample b/build/rust/git_template/hooks/fsmonitor-watchman.sample new file mode 100644 index 0000000..367d462 --- /dev/null +++ b/build/rust/git_template/hooks/fsmonitor-watchman.sample @@ -0,0 +1,174 @@ +#!/usr/bin/env perl + +use strict; +use warnings; +use IPC::Open2; + +# An example hook script to integrate Watchman +# (https://facebook.github.io/watchman/) with git to speed up detecting +# new and modified files. +# +# The hook is passed a version (currently 2) and last update token +# formatted as a string and outputs to stdout a new update token and +# all files that have been modified since the update token. Paths must +# be relative to the root of the working tree and separated by a single NUL. +# +# To enable this hook, rename this file to "query-watchman" and set +# 'git config core.fsmonitor .git/hooks/query-watchman' +# +my ($version, $last_update_token) = @ARGV; + +# Uncomment for debugging +# print STDERR "$0 $version $last_update_token\n"; + +# Check the hook interface version +if ($version ne 2) { + die "Unsupported query-fsmonitor hook version '$version'.\n" . + "Falling back to scanning...\n"; +} + +my $git_work_tree = get_working_dir(); + +my $retry = 1; + +my $json_pkg; +eval { + require JSON::XS; + $json_pkg = "JSON::XS"; + 1; +} or do { + require JSON::PP; + $json_pkg = "JSON::PP"; +}; + +launch_watchman(); + +sub launch_watchman { + my $o = watchman_query(); + if (is_work_tree_watched($o)) { + output_result($o->{clock}, @{$o->{files}}); + } +} + +sub output_result { + my ($clockid, @files) = @_; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # binmode $fh, ":utf8"; + # print $fh "$clockid\n@files\n"; + # close $fh; + + binmode STDOUT, ":utf8"; + print $clockid; + print "\0"; + local $, = "\0"; + print @files; +} + +sub watchman_clock { + my $response = qx/watchman clock "$git_work_tree"/; + die "Failed to get clock id on '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + + return $json_pkg->new->utf8->decode($response); +} + +sub watchman_query { + my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty') + or die "open2() failed: $!\n" . + "Falling back to scanning...\n"; + + # In the query expression below we're asking for names of files that + # changed since $last_update_token but not from the .git folder. + # + # To accomplish this, we're using the "since" generator to use the + # recency index to select candidate nodes and "fields" to limit the + # output to file names only. Then we're using the "expression" term to + # further constrain the results. + my $last_update_line = ""; + if (substr($last_update_token, 0, 1) eq "c") { + $last_update_token = "\"$last_update_token\""; + $last_update_line = qq[\n"since": $last_update_token,]; + } + my $query = <<" END"; + ["query", "$git_work_tree", {$last_update_line + "fields": ["name"], + "expression": ["not", ["dirname", ".git"]] + }] + END + + # Uncomment for debugging the watchman query + # open (my $fh, ">", ".git/watchman-query.json"); + # print $fh $query; + # close $fh; + + print CHLD_IN $query; + close CHLD_IN; + my $response = do {local $/; <CHLD_OUT>}; + + # Uncomment for debugging the watch response + # open ($fh, ">", ".git/watchman-response.json"); + # print $fh $response; + # close $fh; + + die "Watchman: command returned no output.\n" . + "Falling back to scanning...\n" if $response eq ""; + die "Watchman: command returned invalid output: $response\n" . + "Falling back to scanning...\n" unless $response =~ /^\{/; + + return $json_pkg->new->utf8->decode($response); +} + +sub is_work_tree_watched { + my ($output) = @_; + my $error = $output->{error}; + if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) { + $retry--; + my $response = qx/watchman watch "$git_work_tree"/; + die "Failed to make watchman watch '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + $output = $json_pkg->new->utf8->decode($response); + $error = $output->{error}; + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # close $fh; + + # Watchman will always return all files on the first query so + # return the fast "everything is dirty" flag to git and do the + # Watchman query just to get it over with now so we won't pay + # the cost in git to look up each individual file. + my $o = watchman_clock(); + $error = $output->{error}; + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + output_result($o->{clock}, ("/")); + $last_update_token = $o->{clock}; + + eval { launch_watchman() }; + return 0; + } + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + return 1; +} + +sub get_working_dir { + my $working_dir; + if ($^O =~ 'msys' || $^O =~ 'cygwin') { + $working_dir = Win32::GetCwd(); + $working_dir =~ tr/\\/\//; + } else { + require Cwd; + $working_dir = Cwd::cwd(); + } + + return $working_dir; +} diff --git a/build/rust/git_template/hooks/post-update.sample b/build/rust/git_template/hooks/post-update.sample new file mode 100644 index 0000000..e3b3f9f --- /dev/null +++ b/build/rust/git_template/hooks/post-update.sample @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare a packed repository for use over +# dumb transports. +# +# To enable this hook, rename this file to "post-update". + +exec git update-server-info diff --git a/build/rust/git_template/hooks/pre-applypatch.sample b/build/rust/git_template/hooks/pre-applypatch.sample new file mode 100644 index 0000000..c414f0e --- /dev/null +++ b/build/rust/git_template/hooks/pre-applypatch.sample @@ -0,0 +1,14 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed +# by applypatch from an e-mail message. +# +# The hook should exit with non-zero status after issuing an +# appropriate message if it wants to stop the commit. +# +# To enable this hook, rename this file to "pre-applypatch". + +. git-sh-setup +precommit="$(git rev-parse --git-path hooks/pre-commit)" +test -x "$precommit" && exec "$precommit" ${1+"$@"} +: diff --git a/build/rust/git_template/hooks/pre-commit.sample b/build/rust/git_template/hooks/pre-commit.sample new file mode 100644 index 0000000..55f180d --- /dev/null +++ b/build/rust/git_template/hooks/pre-commit.sample @@ -0,0 +1,49 @@ +#!/usr/bin/env bash +# +# An example 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. +# +# To enable this hook, rename this file to "pre-commit". + +if git rev-parse --verify HEAD >/dev/null 2>&1 +then + against=HEAD +else + # Initial commit: diff against an empty tree object + against=$(git hash-object -t tree /dev/null) +fi + +# If you want to allow non-ASCII filenames set this variable to true. +allownonascii=$(git config --type=bool hooks.allownonascii) + +# Redirect output to stderr. +exec 1>&2 + +# 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" != "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. + test $(git diff-index --cached --name-only --diff-filter=A -z $against | + LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0 +then + cat <<\EOF +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 +EOF + exit 1 +fi + +# If there are whitespace errors, print the offending file names and fail. +exec git diff-index --check --cached $against -- diff --git a/build/rust/git_template/hooks/pre-merge-commit.sample b/build/rust/git_template/hooks/pre-merge-commit.sample new file mode 100644 index 0000000..0ed3c36 --- /dev/null +++ b/build/rust/git_template/hooks/pre-merge-commit.sample @@ -0,0 +1,13 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed. +# Called by "git merge" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message to +# stderr if it wants to stop the merge commit. +# +# To enable this hook, rename this file to "pre-merge-commit". + +. git-sh-setup +test -x "$GIT_DIR/hooks/pre-commit" && + exec "$GIT_DIR/hooks/pre-commit" +: diff --git a/build/rust/git_template/hooks/pre-push.sample b/build/rust/git_template/hooks/pre-push.sample new file mode 100644 index 0000000..cb27ddb --- /dev/null +++ b/build/rust/git_template/hooks/pre-push.sample @@ -0,0 +1,53 @@ +#!/usr/bin/env bash + +# An example hook script to verify what is about to be pushed. Called by "git +# push" after it has checked the remote status, but before anything has been +# pushed. If this script exits with a non-zero status nothing will be pushed. +# +# This hook is called with the following parameters: +# +# $1 -- Name of the remote to which the push is being done +# $2 -- URL to which the push is being done +# +# If pushing without using a named remote those arguments will be equal. +# +# Information about the commits which are being pushed is supplied as lines to +# the standard input in the form: +# +# <local ref> <local oid> <remote ref> <remote oid> +# +# This sample shows how to prevent push of commits where the log message starts +# with "WIP" (work in progress). + +remote="$1" +url="$2" + +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') + +while read local_ref local_oid remote_ref remote_oid +do + if test "$local_oid" = "$zero" + then + # Handle delete + : + else + if test "$remote_oid" = "$zero" + then + # New branch, examine all commits + range="$local_oid" + else + # Update to existing branch, examine new commits + range="$remote_oid..$local_oid" + fi + + # Check for WIP commit + commit=$(git rev-list -n 1 --grep '^WIP' "$range") + if test -n "$commit" + then + echo >&2 "Found WIP commit in $local_ref, not pushing" + exit 1 + fi + fi +done + +exit 0 diff --git a/build/rust/git_template/hooks/pre-rebase.sample b/build/rust/git_template/hooks/pre-rebase.sample new file mode 100644 index 0000000..d062617 --- /dev/null +++ b/build/rust/git_template/hooks/pre-rebase.sample @@ -0,0 +1,169 @@ +#!/usr/bin/env bash +# +# Copyright (c) 2006, 2008 Junio C Hamano +# +# The "pre-rebase" hook is run just before "git rebase" starts doing +# its job, and can prevent the command from running by exiting with +# non-zero status. +# +# The hook is called with the following parameters: +# +# $1 -- the upstream the series was forked from. +# $2 -- the branch being rebased (or empty when rebasing the current branch). +# +# This sample shows how to prevent topic branches that are already +# merged to 'next' branch from getting rebased, because allowing it +# would result in rebasing already published history. + +publish=next +basebranch="$1" +if test "$#" = 2 +then + topic="refs/heads/$2" +else + topic=`git symbolic-ref HEAD` || + exit 0 ;# we do not interrupt rebasing detached HEAD +fi + +case "$topic" in +refs/heads/??/*) + ;; +*) + exit 0 ;# we do not interrupt others. + ;; +esac + +# Now we are dealing with a topic branch being rebased +# on top of master. Is it OK to rebase it? + +# Does the topic really exist? +git show-ref -q "$topic" || { + echo >&2 "No such branch $topic" + exit 1 +} + +# Is topic fully merged to master? +not_in_master=`git rev-list --pretty=oneline ^master "$topic"` +if test -z "$not_in_master" +then + echo >&2 "$topic is fully merged to master; better remove it." + exit 1 ;# we could allow it, but there is no point. +fi + +# Is topic ever merged to next? If so you should not be rebasing it. +only_next_1=`git rev-list ^master "^$topic" ${publish} | sort` +only_next_2=`git rev-list ^master ${publish} | sort` +if test "$only_next_1" = "$only_next_2" +then + not_in_topic=`git rev-list "^$topic" master` + if test -z "$not_in_topic" + then + echo >&2 "$topic is already up to date with master" + exit 1 ;# we could allow it, but there is no point. + else + exit 0 + fi +else + not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"` + /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -e ' + my $topic = $ARGV[0]; + my $msg = "* $topic has commits already merged to public branch:\n"; + my (%not_in_next) = map { + /^([0-9a-f]+) /; + ($1 => 1); + } split(/\n/, $ARGV[1]); + for my $elem (map { + /^([0-9a-f]+) (.*)$/; + [$1 => $2]; + } split(/\n/, $ARGV[2])) { + if (!exists $not_in_next{$elem->[0]}) { + if ($msg) { + print STDERR $msg; + undef $msg; + } + print STDERR " $elem->[1]\n"; + } + } + ' "$topic" "$not_in_next" "$not_in_master" + exit 1 +fi + +<<\DOC_END + +This sample hook safeguards topic branches that have been +published from being rewound. + +The workflow assumed here is: + + * Once a topic branch forks from "master", "master" is never + merged into it again (either directly or indirectly). + + * Once a topic branch is fully cooked and merged into "master", + it is deleted. If you need to build on top of it to correct + earlier mistakes, a new topic branch is created by forking at + the tip of the "master". This is not strictly necessary, but + it makes it easier to keep your history simple. + + * Whenever you need to test or publish your changes to topic + branches, merge them into "next" branch. + +The script, being an example, hardcodes the publish branch name +to be "next", but it is trivial to make it configurable via +$GIT_DIR/config mechanism. + +With this workflow, you would want to know: + +(1) ... if a topic branch has ever been merged to "next". Young + topic branches can have stupid mistakes you would rather + clean up before publishing, and things that have not been + merged into other branches can be easily rebased without + affecting other people. But once it is published, you would + not want to rewind it. + +(2) ... if a topic branch has been fully merged to "master". + Then you can delete it. More importantly, you should not + build on top of it -- other people may already want to + change things related to the topic as patches against your + "master", so if you need further changes, it is better to + fork the topic (perhaps with the same name) afresh from the + tip of "master". + +Let's look at this example: + + o---o---o---o---o---o---o---o---o---o "next" + / / / / + / a---a---b A / / + / / / / + / / c---c---c---c B / + / / / \ / + / / / b---b C \ / + / / / / \ / + ---o---o---o---o---o---o---o---o---o---o---o "master" + + +A, B and C are topic branches. + + * A has one fix since it was merged up to "next". + + * B has finished. It has been fully merged up to "master" and "next", + and is ready to be deleted. + + * C has not merged to "next" at all. + +We would want to allow C to be rebased, refuse A, and encourage +B to be deleted. + +To compute (1): + + git rev-list ^master ^topic next + git rev-list ^master next + + if these match, topic has not merged in next at all. + +To compute (2): + + git rev-list master..topic + + if this is empty, it is fully merged to "master". + +DOC_END diff --git a/build/rust/git_template/hooks/pre-receive.sample b/build/rust/git_template/hooks/pre-receive.sample new file mode 100644 index 0000000..0bf2643 --- /dev/null +++ b/build/rust/git_template/hooks/pre-receive.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to make use of push options. +# The example simply echoes all push options that start with 'echoback=' +# and rejects all pushes when the "reject" push option is used. +# +# To enable this hook, rename this file to "pre-receive". + +if test -n "$GIT_PUSH_OPTION_COUNT" +then + i=0 + while test "$i" -lt "$GIT_PUSH_OPTION_COUNT" + do + eval "value=\$GIT_PUSH_OPTION_$i" + case "$value" in + echoback=*) + echo "echo from the pre-receive-hook: ${value#*=}" >&2 + ;; + reject) + exit 1 + esac + i=$((i + 1)) + done +fi diff --git a/build/rust/git_template/hooks/prepare-commit-msg.sample b/build/rust/git_template/hooks/prepare-commit-msg.sample new file mode 100644 index 0000000..24283a0 --- /dev/null +++ b/build/rust/git_template/hooks/prepare-commit-msg.sample @@ -0,0 +1,42 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare the commit log message. +# Called by "git commit" with the name of the file that has the +# commit message, followed by the description of the commit +# message's source. The hook's purpose is to edit the commit +# message file. If the hook fails with a non-zero status, +# the commit is aborted. +# +# To enable this hook, rename this file to "prepare-commit-msg". + +# This hook includes three examples. The first one removes the +# "# Please enter the commit message..." help message. +# +# The second includes the output of "git diff --name-status -r" +# into the message, just before the "git status" output. It is +# commented because it doesn't cope with --amend or with squashed +# commits. +# +# The third example adds a Signed-off-by line to the message, that can +# still be edited. This is rarely a good idea. + +COMMIT_MSG_FILE=$1 +COMMIT_SOURCE=$2 +SHA1=$3 + +/nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE" + +# case "$COMMIT_SOURCE,$SHA1" in +# ,|template,) +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe ' +# print "\n" . `git diff --cached --name-status -r` +# if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;; +# *) ;; +# esac + +# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE" +# if test -z "$COMMIT_SOURCE" +# then +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE" +# fi diff --git a/build/rust/git_template/hooks/push-to-checkout.sample b/build/rust/git_template/hooks/push-to-checkout.sample new file mode 100644 index 0000000..07fa538 --- /dev/null +++ b/build/rust/git_template/hooks/push-to-checkout.sample @@ -0,0 +1,78 @@ +#!/usr/bin/env bash + +# An example hook script to update a checked-out tree on a git push. +# +# This hook is invoked by git-receive-pack(1) when it reacts to git +# push and updates reference(s) in its repository, and when the push +# tries to update the branch that is currently checked out and the +# receive.denyCurrentBranch configuration variable is set to +# updateInstead. +# +# By default, such a push is refused if the working tree and the index +# of the remote repository has any difference from the currently +# checked out commit; when both the working tree and the index match +# the current commit, they are updated to match the newly pushed tip +# of the branch. This hook is to be used to override the default +# behaviour; however the code below reimplements the default behaviour +# as a starting point for convenient modification. +# +# The hook receives the commit with which the tip of the current +# branch is going to be updated: +commit=$1 + +# It can exit with a non-zero status to refuse the push (when it does +# so, it must not modify the index or the working tree). +die () { + echo >&2 "$*" + exit 1 +} + +# Or it can make any necessary changes to the working tree and to the +# index to bring them to the desired state when the tip of the current +# branch is updated to the new commit, and exit with a zero status. +# +# For example, the hook can simply run git read-tree -u -m HEAD "$1" +# in order to emulate git fetch that is run in the reverse direction +# with git push, as the two-tree form of git read-tree -u -m is +# essentially the same as git switch or git checkout that switches +# branches while keeping the local changes in the working tree that do +# not interfere with the difference between the branches. + +# The below is a more-or-less exact translation to shell of the C code +# for the default behaviour for git's push-to-checkout hook defined in +# the push_to_deploy() function in builtin/receive-pack.c. +# +# Note that the hook will be executed from the repository directory, +# not from the working tree, so if you want to perform operations on +# the working tree, you will have to adapt your code accordingly, e.g. +# by adding "cd .." or using relative paths. + +if ! git update-index -q --ignore-submodules --refresh +then + die "Up-to-date check failed" +fi + +if ! git diff-files --quiet --ignore-submodules -- +then + die "Working directory has unstaged changes" +fi + +# This is a rough translation of: +# +# head_has_history() ? "HEAD" : EMPTY_TREE_SHA1_HEX +if git cat-file -e HEAD 2>/dev/null +then + head=HEAD +else + head=$(git hash-object -t tree --stdin </dev/null) +fi + +if ! git diff-index --quiet --cached --ignore-submodules $head -- +then + die "Working directory has staged changes" +fi + +if ! git read-tree -u -m "$commit" +then + die "Could not update working tree to new HEAD" +fi diff --git a/build/rust/git_template/hooks/sendemail-validate.sample b/build/rust/git_template/hooks/sendemail-validate.sample new file mode 100644 index 0000000..52aa61c --- /dev/null +++ b/build/rust/git_template/hooks/sendemail-validate.sample @@ -0,0 +1,77 @@ +#!/usr/bin/env bash + +# An example hook script to validate a patch (and/or patch series) before +# sending it via email. +# +# The hook should exit with non-zero status after issuing an appropriate +# message if it wants to prevent the email(s) from being sent. +# +# To enable this hook, rename this file to "sendemail-validate". +# +# By default, it will only check that the patch(es) can be applied on top of +# the default upstream branch without conflicts in a secondary worktree. After +# validation (successful or not) of the last patch of a series, the worktree +# will be deleted. +# +# The following config variables can be set to change the default remote and +# remote ref that are used to apply the patches against: +# +# sendemail.validateRemote (default: origin) +# sendemail.validateRemoteRef (default: HEAD) +# +# Replace the TODO placeholders with appropriate checks according to your +# needs. + +validate_cover_letter () { + file="$1" + # TODO: Replace with appropriate checks (e.g. spell checking). + true +} + +validate_patch () { + file="$1" + # Ensure that the patch applies without conflicts. + git am -3 "$file" || return + # TODO: Replace with appropriate checks for this patch + # (e.g. checkpatch.pl). + true +} + +validate_series () { + # TODO: Replace with appropriate checks for the whole series + # (e.g. quick build, coding style checks, etc.). + true +} + +# main ------------------------------------------------------------------------- + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = 1 +then + remote=$(git config --default origin --get sendemail.validateRemote) && + ref=$(git config --default HEAD --get sendemail.validateRemoteRef) && + worktree=$(mktemp --tmpdir -d sendemail-validate.XXXXXXX) && + git worktree add -fd --checkout "$worktree" "refs/remotes/$remote/$ref" && + git config --replace-all sendemail.validateWorktree "$worktree" +else + worktree=$(git config --get sendemail.validateWorktree) +fi || { + echo "sendemail-validate: error: failed to prepare worktree" >&2 + exit 1 +} + +unset GIT_DIR GIT_WORK_TREE +cd "$worktree" && + +if grep -q "^diff --git " "$1" +then + validate_patch "$1" +else + validate_cover_letter "$1" +fi && + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = "$GIT_SENDEMAIL_FILE_TOTAL" +then + git config --unset-all sendemail.validateWorktree && + trap 'git worktree remove -ff "$worktree"' EXIT && + validate_series +fi diff --git a/build/rust/git_template/hooks/update.sample b/build/rust/git_template/hooks/update.sample new file mode 100644 index 0000000..1910758 --- /dev/null +++ b/build/rust/git_template/hooks/update.sample @@ -0,0 +1,128 @@ +#!/usr/bin/env bash +# +# An example hook script to block unannotated tags from entering. +# Called by "git receive-pack" with arguments: refname sha1-old sha1-new +# +# To enable this hook, rename this file to "update". +# +# Config +# ------ +# hooks.allowunannotated +# This boolean sets whether unannotated tags will be allowed into the +# repository. By default they won't be. +# hooks.allowdeletetag +# This boolean sets whether deleting tags will be allowed in the +# repository. By default they won't be. +# hooks.allowmodifytag +# This boolean sets whether a tag may be modified after creation. By default +# it won't be. +# hooks.allowdeletebranch +# This boolean sets whether deleting branches will be allowed in the +# repository. By default they won't be. +# hooks.denycreatebranch +# This boolean sets whether remotely creating branches will be denied +# in the repository. By default this is allowed. +# + +# --- Command line +refname="$1" +oldrev="$2" +newrev="$3" + +# --- Safety check +if [ -z "$GIT_DIR" ]; then + echo "Don't run this script from the command line." >&2 + echo " (if you want, you could supply GIT_DIR then run" >&2 + echo " $0 <ref> <oldrev> <newrev>)" >&2 + exit 1 +fi + +if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then + echo "usage: $0 <ref> <oldrev> <newrev>" >&2 + exit 1 +fi + +# --- Config +allowunannotated=$(git config --type=bool hooks.allowunannotated) +allowdeletebranch=$(git config --type=bool hooks.allowdeletebranch) +denycreatebranch=$(git config --type=bool hooks.denycreatebranch) +allowdeletetag=$(git config --type=bool hooks.allowdeletetag) +allowmodifytag=$(git config --type=bool hooks.allowmodifytag) + +# check for no description +projectdesc=$(sed -e '1q' "$GIT_DIR/description") +case "$projectdesc" in +"Unnamed repository"* | "") + echo "*** Project description file hasn't been set" >&2 + exit 1 + ;; +esac + +# --- Check types +# if $newrev is 0000...0000, it's a commit to delete a ref. +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') +if [ "$newrev" = "$zero" ]; then + newrev_type=delete +else + newrev_type=$(git cat-file -t $newrev) +fi + +case "$refname","$newrev_type" in + refs/tags/*,commit) + # un-annotated tag + short_refname=${refname##refs/tags/} + if [ "$allowunannotated" != "true" ]; then + echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2 + echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2 + exit 1 + fi + ;; + refs/tags/*,delete) + # delete tag + if [ "$allowdeletetag" != "true" ]; then + echo "*** Deleting a tag is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/tags/*,tag) + # annotated tag + if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1 + then + echo "*** Tag '$refname' already exists." >&2 + echo "*** Modifying a tag is not allowed in this repository." >&2 + exit 1 + fi + ;; + refs/heads/*,commit) + # branch + if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then + echo "*** Creating a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/heads/*,delete) + # delete branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/remotes/*,commit) + # tracking branch + ;; + refs/remotes/*,delete) + # delete tracking branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a tracking branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + *) + # Anything else (is there anything else?) + echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2 + exit 1 + ;; +esac + +# --- Finished +exit 0 diff --git a/build/rust/git_template/info/exclude b/build/rust/git_template/info/exclude new file mode 100644 index 0000000..a5196d1 --- /dev/null +++ b/build/rust/git_template/info/exclude @@ -0,0 +1,6 @@ +# git ls-files --others --exclude-from=.git/info/exclude +# Lines that start with '#' are comments. +# For a project mostly in C, the following would be a good set of +# exclude patterns (uncomment them if you want to use them): +# *.[oa] +# *~ diff --git a/build/rust/init b/build/rust/init index 1ea1603..f8c8bb3 100644 --- a/build/rust/init +++ b/build/rust/init @@ -10,13 +10,18 @@ trap "cleanup; remove_self" EXIT cleanup() { rm "$replacement_file" } +avoid_cleanup="false" remove_self() { - rm "$(realpath "$0")" - rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + if [ "$avoid_cleanup" = "false" ]; then + rm "$(realpath "$0")" + rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + [ -f "$(realpath "$(dirname "$0")")/init.local" ] && rm "$(realpath "$(dirname "$0")")/init.local" + fi } require() { program="$1" if ! command -v "$program" >/dev/null; then + avoid_cleanup="true" echo "Please install '$program' for this init script to work." 1>&2 exit 1 fi @@ -64,8 +69,6 @@ require mv require sed require chmod -git init - # necessary meta data prompt APPLICATION_NAME "The name of the application" "$(basename "$PWD")" prompt APPLICATION_NAME_STYLIZED "The stylized name of the application (for documentation)" "$(echo "$APPLICATION_NAME" | sed 's/[_-]/ /g' | sed 's/^\(\w\)/\U\1/g' | sed 's/ \(\w\)/ \U\1/g')" @@ -78,7 +81,15 @@ prompt AUTHOR_EMAIL "The email of the author (or authors)" "$(git config --get u # cog change-log variables prompt REMOTE "The remote, this project will be pushed to" "git.vhack.eu" prompt REPOSITORY "The path of the repository on the remote" "$APPLICATION_NAME" -prompt OWNER "The name of owner of the repository" "$AUTHOR_NAME" + +owner1="$(printf "%.1s" "$AUTHOR_NAME")" +owner2="${AUTHOR_NAME#* }" +if [ "$owner2" = "$AUTHOR_NAME" ]; then + owner_build="$(echo "$AUTHOR_NAME" | tr '[:upper:]' '[:lower:]')" +else + owner_build="$(echo "$owner1$owner2" | tr '[:upper:]' '[:lower:]')" +fi +prompt OWNER "The name of owner of the repository" "$owner_build" # nice meta data prompt DESCRIPTION "The description of this project" "" @@ -88,7 +99,12 @@ prompt APPLICATION_SOURCE_CODE_REPOSITORY "The package's source code repository prompt HOME_PAGE "The home page URL of the project" "https://$REPOSITORY.org/" prompt BUG_URL "The URL people should report bugs to" "$APPLICATION_SOURCE_CODE_REPOSITORY/issues" -if [ -e ./lpm.toml ]; then +# git stuff +prompt PUSH_URL "The url used to push this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt CLONE_URL "The url used to clone this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt MAIN_BRANCH "The name of the main branch" "$(git config init.defaultbranch)" + +if [ -e ./watch.sh ]; then # Use a different default license in latex projects. init_default_license="CC-BY-SA-4.0" else @@ -105,7 +121,7 @@ fi prompt LICENSE_URL "The url of the license" "$default_license_url" if [ -e ./.reuse/templates/default.jinja2 ]; then - cat <<EOF | fmt --uniform-spacing --width=75 >./.reuse/templates/default.jinja2 + cat <<EOF | fmt --uniform-spacing --width=85 --split-only >./.reuse/templates/default.jinja2 {% for copyright_line in copyright_lines %} {{ copyright_line }} {% endfor %} @@ -120,14 +136,14 @@ This file is part of $APPLICATION_NAME_STYLIZED - $DESCRIPTION. You should have received a copy of the License along with this program. If not, see <$LICENSE_URL>. -<!-- vim: ft=htmldjango --> EOF fi # Allow templates to add template specific prompts [ -e init.local ] && . ./init.local -echo "$DESCRIPTION" >.git/description +git init --initial-branch "$MAIN_BRANCH" --template="./git_template" +rm --recursive ./git_template while read -r var; do var_name="${var%=*}" @@ -148,5 +164,19 @@ done <"$replacement_file" chmod +x scripts/* chmod +x update.sh [ -f ./build.sh ] && chmod +x build.sh +[ -f ./watch.sh ] && chmod +x build.sh + +# Do the first run of reuse annotate +reuse="$(nix build nixpkgs#reuse --no-link --print-out-paths)" +[ "$(echo "$reuse" | wc -l)" -ne 1 ] && die "Something is wrong with the nixpkgs#reuse derivation" + +git add . + +git diff --name-only --cached | + xargs -I {} "$reuse" annotate \ + --copyright "$AUTHOR_NAME <$AUTHOR_EMAIL>" \ + --copyright-style string-c \ + --template default \ + --license "$SPDX_LICENSE_IDENTIFIER" "{}" # vim: ft=sh diff --git a/build/rust/scripts/cprh.sh b/build/rust/scripts/cprh.sh deleted file mode 100755 index 9582575..0000000 --- a/build/rust/scripts/cprh.sh +++ /dev/null @@ -1,57 +0,0 @@ -#! /usr/bin/env sh - -die() { - echo "$@" 1>&2 - exit 1 -} - -help() { - cat <<EOF -A copyright header managment tool. - -USAGE: - cprh.sh [OPTIONS] contribute NAME EMAIL FILE.. - -OPTIONS: - --help | -h - Display this help and exit. - -ARGUMENTS: - NAME := [[git config user.name]] - Your name. - - NAME := [[git config user.email]] - Your email address. - - FILE := [[git diff --name-only --cached]] - The file you want to change. This can be given multiple times. -EOF -} - -for arg in "$@"; do - case "$arg" in - "--help" | "-h") - help - exit 0 - ;; - *) - echo "'$1' is not a recognized option. See --help for more!" 1>&2 - exit 1 - ;; - esac -done - -user_name="$1" -[ -z "$user_name" ] && die "No NAME set! See --help for more" - -user_email="$2" -[ -z "$user_email" ] && die "No EMAIL set! See --help for more" -shift 2 - -styleOne="" -styleTwo="" -[ "$COMMENT_STYLE" ] && styleOne="--style" && styleTwo="$COMMENT_STYLE" - -# The styleTwo must be unquoted to avoid adding empty args to reuse -# shellcheck disable=2086 -reuse annotate --copyright "$user_name <$user_email>" --copyright-prefix string-c --template default --multi-line $styleOne $styleTwo diff --git a/build/shell/README.md b/build/shell/README.md index 9c5c6da..6dad42c 100644 --- a/build/shell/README.md +++ b/build/shell/README.md @@ -3,6 +3,7 @@ > %INIT_DESCRIPTION ## Licensing + This project complies with the REUSE v3.2 specification. This means that every file clearly states its copyright. Please run `./scripts/cprh.sh contributer NAME EMAIL FILES..` after you diff --git a/build/shell/cog.toml b/build/shell/cog.toml index ccca764..ebb3a5d 100644 --- a/build/shell/cog.toml +++ b/build/shell/cog.toml @@ -3,10 +3,10 @@ branch_whitelist = ["main", "prime"] ignore_merge_commits = false pre_bump_hooks = [ - "nix flake check", # verify the project builds - "./scripts/renew_copyright_header.sh", # update the license header in each file - "flake_version_update --version v{{version}} --input-file flake.nix", # update the version in the flake.nix file - "nix fmt", # format + "reuse lint", # Check licensing status. + "nix flake check", # Verify the project builds. + "flake_version_update --version v{{version}} --input-file flake.nix", # Bump the version in the flake.nix file + "nix fmt", # Format. ] post_bump_hooks = [ "git push", diff --git a/build/shell/git_template/config b/build/shell/git_template/config new file mode 100644 index 0000000..f0c8d31 --- /dev/null +++ b/build/shell/git_template/config @@ -0,0 +1,7 @@ +[remote "origin"] + url = %INIT_CLONE_URL + fetch = +refs/heads/*:refs/remotes/origin/* + pushurl = %INIT_PUSH_URL +[branch "%INIT_MAIN_BRANCH"] + remote = origin + merge = refs/heads/%INIT_MAIN_BRANCH diff --git a/build/shell/git_template/description b/build/shell/git_template/description new file mode 100644 index 0000000..bf2d1bf --- /dev/null +++ b/build/shell/git_template/description @@ -0,0 +1 @@ +%INIT_DESCRIPTION diff --git a/build/shell/git_template/hooks/applypatch-msg.sample b/build/shell/git_template/hooks/applypatch-msg.sample new file mode 100644 index 0000000..e6c87c6 --- /dev/null +++ b/build/shell/git_template/hooks/applypatch-msg.sample @@ -0,0 +1,15 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message taken by +# applypatch from an e-mail 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, rename this file to "applypatch-msg". + +. git-sh-setup +commitmsg="$(git rev-parse --git-path hooks/commit-msg)" +test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"} +: diff --git a/build/shell/git_template/hooks/commit-msg.sample b/build/shell/git_template/hooks/commit-msg.sample new file mode 100644 index 0000000..5604587 --- /dev/null +++ b/build/shell/git_template/hooks/commit-msg.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to check the commit log message. +# 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, rename this file to "commit-msg". + +# Uncomment the below to add a Signed-off-by line to the message. +# Doing this in a hook is a bad idea in general, but the prepare-commit-msg +# hook is more suited to it. +# +# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1" + +# This example catches duplicate Signed-off-by lines. + +test "" = "$(grep '^Signed-off-by: ' "$1" | + sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || { + echo >&2 Duplicate Signed-off-by lines. + exit 1 +} diff --git a/build/shell/git_template/hooks/fsmonitor-watchman.sample b/build/shell/git_template/hooks/fsmonitor-watchman.sample new file mode 100644 index 0000000..367d462 --- /dev/null +++ b/build/shell/git_template/hooks/fsmonitor-watchman.sample @@ -0,0 +1,174 @@ +#!/usr/bin/env perl + +use strict; +use warnings; +use IPC::Open2; + +# An example hook script to integrate Watchman +# (https://facebook.github.io/watchman/) with git to speed up detecting +# new and modified files. +# +# The hook is passed a version (currently 2) and last update token +# formatted as a string and outputs to stdout a new update token and +# all files that have been modified since the update token. Paths must +# be relative to the root of the working tree and separated by a single NUL. +# +# To enable this hook, rename this file to "query-watchman" and set +# 'git config core.fsmonitor .git/hooks/query-watchman' +# +my ($version, $last_update_token) = @ARGV; + +# Uncomment for debugging +# print STDERR "$0 $version $last_update_token\n"; + +# Check the hook interface version +if ($version ne 2) { + die "Unsupported query-fsmonitor hook version '$version'.\n" . + "Falling back to scanning...\n"; +} + +my $git_work_tree = get_working_dir(); + +my $retry = 1; + +my $json_pkg; +eval { + require JSON::XS; + $json_pkg = "JSON::XS"; + 1; +} or do { + require JSON::PP; + $json_pkg = "JSON::PP"; +}; + +launch_watchman(); + +sub launch_watchman { + my $o = watchman_query(); + if (is_work_tree_watched($o)) { + output_result($o->{clock}, @{$o->{files}}); + } +} + +sub output_result { + my ($clockid, @files) = @_; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # binmode $fh, ":utf8"; + # print $fh "$clockid\n@files\n"; + # close $fh; + + binmode STDOUT, ":utf8"; + print $clockid; + print "\0"; + local $, = "\0"; + print @files; +} + +sub watchman_clock { + my $response = qx/watchman clock "$git_work_tree"/; + die "Failed to get clock id on '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + + return $json_pkg->new->utf8->decode($response); +} + +sub watchman_query { + my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty') + or die "open2() failed: $!\n" . + "Falling back to scanning...\n"; + + # In the query expression below we're asking for names of files that + # changed since $last_update_token but not from the .git folder. + # + # To accomplish this, we're using the "since" generator to use the + # recency index to select candidate nodes and "fields" to limit the + # output to file names only. Then we're using the "expression" term to + # further constrain the results. + my $last_update_line = ""; + if (substr($last_update_token, 0, 1) eq "c") { + $last_update_token = "\"$last_update_token\""; + $last_update_line = qq[\n"since": $last_update_token,]; + } + my $query = <<" END"; + ["query", "$git_work_tree", {$last_update_line + "fields": ["name"], + "expression": ["not", ["dirname", ".git"]] + }] + END + + # Uncomment for debugging the watchman query + # open (my $fh, ">", ".git/watchman-query.json"); + # print $fh $query; + # close $fh; + + print CHLD_IN $query; + close CHLD_IN; + my $response = do {local $/; <CHLD_OUT>}; + + # Uncomment for debugging the watch response + # open ($fh, ">", ".git/watchman-response.json"); + # print $fh $response; + # close $fh; + + die "Watchman: command returned no output.\n" . + "Falling back to scanning...\n" if $response eq ""; + die "Watchman: command returned invalid output: $response\n" . + "Falling back to scanning...\n" unless $response =~ /^\{/; + + return $json_pkg->new->utf8->decode($response); +} + +sub is_work_tree_watched { + my ($output) = @_; + my $error = $output->{error}; + if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) { + $retry--; + my $response = qx/watchman watch "$git_work_tree"/; + die "Failed to make watchman watch '$git_work_tree'.\n" . + "Falling back to scanning...\n" if $? != 0; + $output = $json_pkg->new->utf8->decode($response); + $error = $output->{error}; + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + # Uncomment for debugging watchman output + # open (my $fh, ">", ".git/watchman-output.out"); + # close $fh; + + # Watchman will always return all files on the first query so + # return the fast "everything is dirty" flag to git and do the + # Watchman query just to get it over with now so we won't pay + # the cost in git to look up each individual file. + my $o = watchman_clock(); + $error = $output->{error}; + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + output_result($o->{clock}, ("/")); + $last_update_token = $o->{clock}; + + eval { launch_watchman() }; + return 0; + } + + die "Watchman: $error.\n" . + "Falling back to scanning...\n" if $error; + + return 1; +} + +sub get_working_dir { + my $working_dir; + if ($^O =~ 'msys' || $^O =~ 'cygwin') { + $working_dir = Win32::GetCwd(); + $working_dir =~ tr/\\/\//; + } else { + require Cwd; + $working_dir = Cwd::cwd(); + } + + return $working_dir; +} diff --git a/build/shell/git_template/hooks/post-update.sample b/build/shell/git_template/hooks/post-update.sample new file mode 100644 index 0000000..e3b3f9f --- /dev/null +++ b/build/shell/git_template/hooks/post-update.sample @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare a packed repository for use over +# dumb transports. +# +# To enable this hook, rename this file to "post-update". + +exec git update-server-info diff --git a/build/shell/git_template/hooks/pre-applypatch.sample b/build/shell/git_template/hooks/pre-applypatch.sample new file mode 100644 index 0000000..c414f0e --- /dev/null +++ b/build/shell/git_template/hooks/pre-applypatch.sample @@ -0,0 +1,14 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed +# by applypatch from an e-mail message. +# +# The hook should exit with non-zero status after issuing an +# appropriate message if it wants to stop the commit. +# +# To enable this hook, rename this file to "pre-applypatch". + +. git-sh-setup +precommit="$(git rev-parse --git-path hooks/pre-commit)" +test -x "$precommit" && exec "$precommit" ${1+"$@"} +: diff --git a/build/shell/git_template/hooks/pre-commit.sample b/build/shell/git_template/hooks/pre-commit.sample new file mode 100644 index 0000000..55f180d --- /dev/null +++ b/build/shell/git_template/hooks/pre-commit.sample @@ -0,0 +1,49 @@ +#!/usr/bin/env bash +# +# An example 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. +# +# To enable this hook, rename this file to "pre-commit". + +if git rev-parse --verify HEAD >/dev/null 2>&1 +then + against=HEAD +else + # Initial commit: diff against an empty tree object + against=$(git hash-object -t tree /dev/null) +fi + +# If you want to allow non-ASCII filenames set this variable to true. +allownonascii=$(git config --type=bool hooks.allownonascii) + +# Redirect output to stderr. +exec 1>&2 + +# 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" != "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. + test $(git diff-index --cached --name-only --diff-filter=A -z $against | + LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0 +then + cat <<\EOF +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 +EOF + exit 1 +fi + +# If there are whitespace errors, print the offending file names and fail. +exec git diff-index --check --cached $against -- diff --git a/build/shell/git_template/hooks/pre-merge-commit.sample b/build/shell/git_template/hooks/pre-merge-commit.sample new file mode 100644 index 0000000..0ed3c36 --- /dev/null +++ b/build/shell/git_template/hooks/pre-merge-commit.sample @@ -0,0 +1,13 @@ +#!/usr/bin/env bash +# +# An example hook script to verify what is about to be committed. +# Called by "git merge" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message to +# stderr if it wants to stop the merge commit. +# +# To enable this hook, rename this file to "pre-merge-commit". + +. git-sh-setup +test -x "$GIT_DIR/hooks/pre-commit" && + exec "$GIT_DIR/hooks/pre-commit" +: diff --git a/build/shell/git_template/hooks/pre-push.sample b/build/shell/git_template/hooks/pre-push.sample new file mode 100644 index 0000000..cb27ddb --- /dev/null +++ b/build/shell/git_template/hooks/pre-push.sample @@ -0,0 +1,53 @@ +#!/usr/bin/env bash + +# An example hook script to verify what is about to be pushed. Called by "git +# push" after it has checked the remote status, but before anything has been +# pushed. If this script exits with a non-zero status nothing will be pushed. +# +# This hook is called with the following parameters: +# +# $1 -- Name of the remote to which the push is being done +# $2 -- URL to which the push is being done +# +# If pushing without using a named remote those arguments will be equal. +# +# Information about the commits which are being pushed is supplied as lines to +# the standard input in the form: +# +# <local ref> <local oid> <remote ref> <remote oid> +# +# This sample shows how to prevent push of commits where the log message starts +# with "WIP" (work in progress). + +remote="$1" +url="$2" + +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') + +while read local_ref local_oid remote_ref remote_oid +do + if test "$local_oid" = "$zero" + then + # Handle delete + : + else + if test "$remote_oid" = "$zero" + then + # New branch, examine all commits + range="$local_oid" + else + # Update to existing branch, examine new commits + range="$remote_oid..$local_oid" + fi + + # Check for WIP commit + commit=$(git rev-list -n 1 --grep '^WIP' "$range") + if test -n "$commit" + then + echo >&2 "Found WIP commit in $local_ref, not pushing" + exit 1 + fi + fi +done + +exit 0 diff --git a/build/shell/git_template/hooks/pre-rebase.sample b/build/shell/git_template/hooks/pre-rebase.sample new file mode 100644 index 0000000..d062617 --- /dev/null +++ b/build/shell/git_template/hooks/pre-rebase.sample @@ -0,0 +1,169 @@ +#!/usr/bin/env bash +# +# Copyright (c) 2006, 2008 Junio C Hamano +# +# The "pre-rebase" hook is run just before "git rebase" starts doing +# its job, and can prevent the command from running by exiting with +# non-zero status. +# +# The hook is called with the following parameters: +# +# $1 -- the upstream the series was forked from. +# $2 -- the branch being rebased (or empty when rebasing the current branch). +# +# This sample shows how to prevent topic branches that are already +# merged to 'next' branch from getting rebased, because allowing it +# would result in rebasing already published history. + +publish=next +basebranch="$1" +if test "$#" = 2 +then + topic="refs/heads/$2" +else + topic=`git symbolic-ref HEAD` || + exit 0 ;# we do not interrupt rebasing detached HEAD +fi + +case "$topic" in +refs/heads/??/*) + ;; +*) + exit 0 ;# we do not interrupt others. + ;; +esac + +# Now we are dealing with a topic branch being rebased +# on top of master. Is it OK to rebase it? + +# Does the topic really exist? +git show-ref -q "$topic" || { + echo >&2 "No such branch $topic" + exit 1 +} + +# Is topic fully merged to master? +not_in_master=`git rev-list --pretty=oneline ^master "$topic"` +if test -z "$not_in_master" +then + echo >&2 "$topic is fully merged to master; better remove it." + exit 1 ;# we could allow it, but there is no point. +fi + +# Is topic ever merged to next? If so you should not be rebasing it. +only_next_1=`git rev-list ^master "^$topic" ${publish} | sort` +only_next_2=`git rev-list ^master ${publish} | sort` +if test "$only_next_1" = "$only_next_2" +then + not_in_topic=`git rev-list "^$topic" master` + if test -z "$not_in_topic" + then + echo >&2 "$topic is already up to date with master" + exit 1 ;# we could allow it, but there is no point. + else + exit 0 + fi +else + not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"` + /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -e ' + my $topic = $ARGV[0]; + my $msg = "* $topic has commits already merged to public branch:\n"; + my (%not_in_next) = map { + /^([0-9a-f]+) /; + ($1 => 1); + } split(/\n/, $ARGV[1]); + for my $elem (map { + /^([0-9a-f]+) (.*)$/; + [$1 => $2]; + } split(/\n/, $ARGV[2])) { + if (!exists $not_in_next{$elem->[0]}) { + if ($msg) { + print STDERR $msg; + undef $msg; + } + print STDERR " $elem->[1]\n"; + } + } + ' "$topic" "$not_in_next" "$not_in_master" + exit 1 +fi + +<<\DOC_END + +This sample hook safeguards topic branches that have been +published from being rewound. + +The workflow assumed here is: + + * Once a topic branch forks from "master", "master" is never + merged into it again (either directly or indirectly). + + * Once a topic branch is fully cooked and merged into "master", + it is deleted. If you need to build on top of it to correct + earlier mistakes, a new topic branch is created by forking at + the tip of the "master". This is not strictly necessary, but + it makes it easier to keep your history simple. + + * Whenever you need to test or publish your changes to topic + branches, merge them into "next" branch. + +The script, being an example, hardcodes the publish branch name +to be "next", but it is trivial to make it configurable via +$GIT_DIR/config mechanism. + +With this workflow, you would want to know: + +(1) ... if a topic branch has ever been merged to "next". Young + topic branches can have stupid mistakes you would rather + clean up before publishing, and things that have not been + merged into other branches can be easily rebased without + affecting other people. But once it is published, you would + not want to rewind it. + +(2) ... if a topic branch has been fully merged to "master". + Then you can delete it. More importantly, you should not + build on top of it -- other people may already want to + change things related to the topic as patches against your + "master", so if you need further changes, it is better to + fork the topic (perhaps with the same name) afresh from the + tip of "master". + +Let's look at this example: + + o---o---o---o---o---o---o---o---o---o "next" + / / / / + / a---a---b A / / + / / / / + / / c---c---c---c B / + / / / \ / + / / / b---b C \ / + / / / / \ / + ---o---o---o---o---o---o---o---o---o---o---o "master" + + +A, B and C are topic branches. + + * A has one fix since it was merged up to "next". + + * B has finished. It has been fully merged up to "master" and "next", + and is ready to be deleted. + + * C has not merged to "next" at all. + +We would want to allow C to be rebased, refuse A, and encourage +B to be deleted. + +To compute (1): + + git rev-list ^master ^topic next + git rev-list ^master next + + if these match, topic has not merged in next at all. + +To compute (2): + + git rev-list master..topic + + if this is empty, it is fully merged to "master". + +DOC_END diff --git a/build/shell/git_template/hooks/pre-receive.sample b/build/shell/git_template/hooks/pre-receive.sample new file mode 100644 index 0000000..0bf2643 --- /dev/null +++ b/build/shell/git_template/hooks/pre-receive.sample @@ -0,0 +1,24 @@ +#!/usr/bin/env bash +# +# An example hook script to make use of push options. +# The example simply echoes all push options that start with 'echoback=' +# and rejects all pushes when the "reject" push option is used. +# +# To enable this hook, rename this file to "pre-receive". + +if test -n "$GIT_PUSH_OPTION_COUNT" +then + i=0 + while test "$i" -lt "$GIT_PUSH_OPTION_COUNT" + do + eval "value=\$GIT_PUSH_OPTION_$i" + case "$value" in + echoback=*) + echo "echo from the pre-receive-hook: ${value#*=}" >&2 + ;; + reject) + exit 1 + esac + i=$((i + 1)) + done +fi diff --git a/build/shell/git_template/hooks/prepare-commit-msg.sample b/build/shell/git_template/hooks/prepare-commit-msg.sample new file mode 100644 index 0000000..24283a0 --- /dev/null +++ b/build/shell/git_template/hooks/prepare-commit-msg.sample @@ -0,0 +1,42 @@ +#!/usr/bin/env bash +# +# An example hook script to prepare the commit log message. +# Called by "git commit" with the name of the file that has the +# commit message, followed by the description of the commit +# message's source. The hook's purpose is to edit the commit +# message file. If the hook fails with a non-zero status, +# the commit is aborted. +# +# To enable this hook, rename this file to "prepare-commit-msg". + +# This hook includes three examples. The first one removes the +# "# Please enter the commit message..." help message. +# +# The second includes the output of "git diff --name-status -r" +# into the message, just before the "git status" output. It is +# commented because it doesn't cope with --amend or with squashed +# commits. +# +# The third example adds a Signed-off-by line to the message, that can +# still be edited. This is rarely a good idea. + +COMMIT_MSG_FILE=$1 +COMMIT_SOURCE=$2 +SHA1=$3 + +/nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE" + +# case "$COMMIT_SOURCE,$SHA1" in +# ,|template,) +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe ' +# print "\n" . `git diff --cached --name-status -r` +# if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;; +# *) ;; +# esac + +# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') +# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE" +# if test -z "$COMMIT_SOURCE" +# then +# /nix/store/57hpz6jj3pnjwdwwg6jgmj9gr7kxs8zp-perl-5.38.2/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE" +# fi diff --git a/build/shell/git_template/hooks/push-to-checkout.sample b/build/shell/git_template/hooks/push-to-checkout.sample new file mode 100644 index 0000000..07fa538 --- /dev/null +++ b/build/shell/git_template/hooks/push-to-checkout.sample @@ -0,0 +1,78 @@ +#!/usr/bin/env bash + +# An example hook script to update a checked-out tree on a git push. +# +# This hook is invoked by git-receive-pack(1) when it reacts to git +# push and updates reference(s) in its repository, and when the push +# tries to update the branch that is currently checked out and the +# receive.denyCurrentBranch configuration variable is set to +# updateInstead. +# +# By default, such a push is refused if the working tree and the index +# of the remote repository has any difference from the currently +# checked out commit; when both the working tree and the index match +# the current commit, they are updated to match the newly pushed tip +# of the branch. This hook is to be used to override the default +# behaviour; however the code below reimplements the default behaviour +# as a starting point for convenient modification. +# +# The hook receives the commit with which the tip of the current +# branch is going to be updated: +commit=$1 + +# It can exit with a non-zero status to refuse the push (when it does +# so, it must not modify the index or the working tree). +die () { + echo >&2 "$*" + exit 1 +} + +# Or it can make any necessary changes to the working tree and to the +# index to bring them to the desired state when the tip of the current +# branch is updated to the new commit, and exit with a zero status. +# +# For example, the hook can simply run git read-tree -u -m HEAD "$1" +# in order to emulate git fetch that is run in the reverse direction +# with git push, as the two-tree form of git read-tree -u -m is +# essentially the same as git switch or git checkout that switches +# branches while keeping the local changes in the working tree that do +# not interfere with the difference between the branches. + +# The below is a more-or-less exact translation to shell of the C code +# for the default behaviour for git's push-to-checkout hook defined in +# the push_to_deploy() function in builtin/receive-pack.c. +# +# Note that the hook will be executed from the repository directory, +# not from the working tree, so if you want to perform operations on +# the working tree, you will have to adapt your code accordingly, e.g. +# by adding "cd .." or using relative paths. + +if ! git update-index -q --ignore-submodules --refresh +then + die "Up-to-date check failed" +fi + +if ! git diff-files --quiet --ignore-submodules -- +then + die "Working directory has unstaged changes" +fi + +# This is a rough translation of: +# +# head_has_history() ? "HEAD" : EMPTY_TREE_SHA1_HEX +if git cat-file -e HEAD 2>/dev/null +then + head=HEAD +else + head=$(git hash-object -t tree --stdin </dev/null) +fi + +if ! git diff-index --quiet --cached --ignore-submodules $head -- +then + die "Working directory has staged changes" +fi + +if ! git read-tree -u -m "$commit" +then + die "Could not update working tree to new HEAD" +fi diff --git a/build/shell/git_template/hooks/sendemail-validate.sample b/build/shell/git_template/hooks/sendemail-validate.sample new file mode 100644 index 0000000..52aa61c --- /dev/null +++ b/build/shell/git_template/hooks/sendemail-validate.sample @@ -0,0 +1,77 @@ +#!/usr/bin/env bash + +# An example hook script to validate a patch (and/or patch series) before +# sending it via email. +# +# The hook should exit with non-zero status after issuing an appropriate +# message if it wants to prevent the email(s) from being sent. +# +# To enable this hook, rename this file to "sendemail-validate". +# +# By default, it will only check that the patch(es) can be applied on top of +# the default upstream branch without conflicts in a secondary worktree. After +# validation (successful or not) of the last patch of a series, the worktree +# will be deleted. +# +# The following config variables can be set to change the default remote and +# remote ref that are used to apply the patches against: +# +# sendemail.validateRemote (default: origin) +# sendemail.validateRemoteRef (default: HEAD) +# +# Replace the TODO placeholders with appropriate checks according to your +# needs. + +validate_cover_letter () { + file="$1" + # TODO: Replace with appropriate checks (e.g. spell checking). + true +} + +validate_patch () { + file="$1" + # Ensure that the patch applies without conflicts. + git am -3 "$file" || return + # TODO: Replace with appropriate checks for this patch + # (e.g. checkpatch.pl). + true +} + +validate_series () { + # TODO: Replace with appropriate checks for the whole series + # (e.g. quick build, coding style checks, etc.). + true +} + +# main ------------------------------------------------------------------------- + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = 1 +then + remote=$(git config --default origin --get sendemail.validateRemote) && + ref=$(git config --default HEAD --get sendemail.validateRemoteRef) && + worktree=$(mktemp --tmpdir -d sendemail-validate.XXXXXXX) && + git worktree add -fd --checkout "$worktree" "refs/remotes/$remote/$ref" && + git config --replace-all sendemail.validateWorktree "$worktree" +else + worktree=$(git config --get sendemail.validateWorktree) +fi || { + echo "sendemail-validate: error: failed to prepare worktree" >&2 + exit 1 +} + +unset GIT_DIR GIT_WORK_TREE +cd "$worktree" && + +if grep -q "^diff --git " "$1" +then + validate_patch "$1" +else + validate_cover_letter "$1" +fi && + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = "$GIT_SENDEMAIL_FILE_TOTAL" +then + git config --unset-all sendemail.validateWorktree && + trap 'git worktree remove -ff "$worktree"' EXIT && + validate_series +fi diff --git a/build/shell/git_template/hooks/update.sample b/build/shell/git_template/hooks/update.sample new file mode 100644 index 0000000..1910758 --- /dev/null +++ b/build/shell/git_template/hooks/update.sample @@ -0,0 +1,128 @@ +#!/usr/bin/env bash +# +# An example hook script to block unannotated tags from entering. +# Called by "git receive-pack" with arguments: refname sha1-old sha1-new +# +# To enable this hook, rename this file to "update". +# +# Config +# ------ +# hooks.allowunannotated +# This boolean sets whether unannotated tags will be allowed into the +# repository. By default they won't be. +# hooks.allowdeletetag +# This boolean sets whether deleting tags will be allowed in the +# repository. By default they won't be. +# hooks.allowmodifytag +# This boolean sets whether a tag may be modified after creation. By default +# it won't be. +# hooks.allowdeletebranch +# This boolean sets whether deleting branches will be allowed in the +# repository. By default they won't be. +# hooks.denycreatebranch +# This boolean sets whether remotely creating branches will be denied +# in the repository. By default this is allowed. +# + +# --- Command line +refname="$1" +oldrev="$2" +newrev="$3" + +# --- Safety check +if [ -z "$GIT_DIR" ]; then + echo "Don't run this script from the command line." >&2 + echo " (if you want, you could supply GIT_DIR then run" >&2 + echo " $0 <ref> <oldrev> <newrev>)" >&2 + exit 1 +fi + +if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then + echo "usage: $0 <ref> <oldrev> <newrev>" >&2 + exit 1 +fi + +# --- Config +allowunannotated=$(git config --type=bool hooks.allowunannotated) +allowdeletebranch=$(git config --type=bool hooks.allowdeletebranch) +denycreatebranch=$(git config --type=bool hooks.denycreatebranch) +allowdeletetag=$(git config --type=bool hooks.allowdeletetag) +allowmodifytag=$(git config --type=bool hooks.allowmodifytag) + +# check for no description +projectdesc=$(sed -e '1q' "$GIT_DIR/description") +case "$projectdesc" in +"Unnamed repository"* | "") + echo "*** Project description file hasn't been set" >&2 + exit 1 + ;; +esac + +# --- Check types +# if $newrev is 0000...0000, it's a commit to delete a ref. +zero=$(git hash-object --stdin </dev/null | tr '[0-9a-f]' '0') +if [ "$newrev" = "$zero" ]; then + newrev_type=delete +else + newrev_type=$(git cat-file -t $newrev) +fi + +case "$refname","$newrev_type" in + refs/tags/*,commit) + # un-annotated tag + short_refname=${refname##refs/tags/} + if [ "$allowunannotated" != "true" ]; then + echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2 + echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2 + exit 1 + fi + ;; + refs/tags/*,delete) + # delete tag + if [ "$allowdeletetag" != "true" ]; then + echo "*** Deleting a tag is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/tags/*,tag) + # annotated tag + if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1 + then + echo "*** Tag '$refname' already exists." >&2 + echo "*** Modifying a tag is not allowed in this repository." >&2 + exit 1 + fi + ;; + refs/heads/*,commit) + # branch + if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then + echo "*** Creating a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/heads/*,delete) + # delete branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + refs/remotes/*,commit) + # tracking branch + ;; + refs/remotes/*,delete) + # delete tracking branch + if [ "$allowdeletebranch" != "true" ]; then + echo "*** Deleting a tracking branch is not allowed in this repository" >&2 + exit 1 + fi + ;; + *) + # Anything else (is there anything else?) + echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2 + exit 1 + ;; +esac + +# --- Finished +exit 0 diff --git a/build/shell/git_template/info/exclude b/build/shell/git_template/info/exclude new file mode 100644 index 0000000..a5196d1 --- /dev/null +++ b/build/shell/git_template/info/exclude @@ -0,0 +1,6 @@ +# git ls-files --others --exclude-from=.git/info/exclude +# Lines that start with '#' are comments. +# For a project mostly in C, the following would be a good set of +# exclude patterns (uncomment them if you want to use them): +# *.[oa] +# *~ diff --git a/build/shell/init b/build/shell/init index 1ea1603..f8c8bb3 100644 --- a/build/shell/init +++ b/build/shell/init @@ -10,13 +10,18 @@ trap "cleanup; remove_self" EXIT cleanup() { rm "$replacement_file" } +avoid_cleanup="false" remove_self() { - rm "$(realpath "$0")" - rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + if [ "$avoid_cleanup" = "false" ]; then + rm "$(realpath "$0")" + rm "$(realpath "$(dirname "$0")")/shell_line_editor.sh" + [ -f "$(realpath "$(dirname "$0")")/init.local" ] && rm "$(realpath "$(dirname "$0")")/init.local" + fi } require() { program="$1" if ! command -v "$program" >/dev/null; then + avoid_cleanup="true" echo "Please install '$program' for this init script to work." 1>&2 exit 1 fi @@ -64,8 +69,6 @@ require mv require sed require chmod -git init - # necessary meta data prompt APPLICATION_NAME "The name of the application" "$(basename "$PWD")" prompt APPLICATION_NAME_STYLIZED "The stylized name of the application (for documentation)" "$(echo "$APPLICATION_NAME" | sed 's/[_-]/ /g' | sed 's/^\(\w\)/\U\1/g' | sed 's/ \(\w\)/ \U\1/g')" @@ -78,7 +81,15 @@ prompt AUTHOR_EMAIL "The email of the author (or authors)" "$(git config --get u # cog change-log variables prompt REMOTE "The remote, this project will be pushed to" "git.vhack.eu" prompt REPOSITORY "The path of the repository on the remote" "$APPLICATION_NAME" -prompt OWNER "The name of owner of the repository" "$AUTHOR_NAME" + +owner1="$(printf "%.1s" "$AUTHOR_NAME")" +owner2="${AUTHOR_NAME#* }" +if [ "$owner2" = "$AUTHOR_NAME" ]; then + owner_build="$(echo "$AUTHOR_NAME" | tr '[:upper:]' '[:lower:]')" +else + owner_build="$(echo "$owner1$owner2" | tr '[:upper:]' '[:lower:]')" +fi +prompt OWNER "The name of owner of the repository" "$owner_build" # nice meta data prompt DESCRIPTION "The description of this project" "" @@ -88,7 +99,12 @@ prompt APPLICATION_SOURCE_CODE_REPOSITORY "The package's source code repository prompt HOME_PAGE "The home page URL of the project" "https://$REPOSITORY.org/" prompt BUG_URL "The URL people should report bugs to" "$APPLICATION_SOURCE_CODE_REPOSITORY/issues" -if [ -e ./lpm.toml ]; then +# git stuff +prompt PUSH_URL "The url used to push this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt CLONE_URL "The url used to clone this project" "git@$REMOTE:$OWNER/$REPOSITORY.git" +prompt MAIN_BRANCH "The name of the main branch" "$(git config init.defaultbranch)" + +if [ -e ./watch.sh ]; then # Use a different default license in latex projects. init_default_license="CC-BY-SA-4.0" else @@ -105,7 +121,7 @@ fi prompt LICENSE_URL "The url of the license" "$default_license_url" if [ -e ./.reuse/templates/default.jinja2 ]; then - cat <<EOF | fmt --uniform-spacing --width=75 >./.reuse/templates/default.jinja2 + cat <<EOF | fmt --uniform-spacing --width=85 --split-only >./.reuse/templates/default.jinja2 {% for copyright_line in copyright_lines %} {{ copyright_line }} {% endfor %} @@ -120,14 +136,14 @@ This file is part of $APPLICATION_NAME_STYLIZED - $DESCRIPTION. You should have received a copy of the License along with this program. If not, see <$LICENSE_URL>. -<!-- vim: ft=htmldjango --> EOF fi # Allow templates to add template specific prompts [ -e init.local ] && . ./init.local -echo "$DESCRIPTION" >.git/description +git init --initial-branch "$MAIN_BRANCH" --template="./git_template" +rm --recursive ./git_template while read -r var; do var_name="${var%=*}" @@ -148,5 +164,19 @@ done <"$replacement_file" chmod +x scripts/* chmod +x update.sh [ -f ./build.sh ] && chmod +x build.sh +[ -f ./watch.sh ] && chmod +x build.sh + +# Do the first run of reuse annotate +reuse="$(nix build nixpkgs#reuse --no-link --print-out-paths)" +[ "$(echo "$reuse" | wc -l)" -ne 1 ] && die "Something is wrong with the nixpkgs#reuse derivation" + +git add . + +git diff --name-only --cached | + xargs -I {} "$reuse" annotate \ + --copyright "$AUTHOR_NAME <$AUTHOR_EMAIL>" \ + --copyright-style string-c \ + --template default \ + --license "$SPDX_LICENSE_IDENTIFIER" "{}" # vim: ft=sh diff --git a/build/shell/scripts/cprh.sh b/build/shell/scripts/cprh.sh deleted file mode 100755 index 9582575..0000000 --- a/build/shell/scripts/cprh.sh +++ /dev/null @@ -1,57 +0,0 @@ -#! /usr/bin/env sh - -die() { - echo "$@" 1>&2 - exit 1 -} - -help() { - cat <<EOF -A copyright header managment tool. - -USAGE: - cprh.sh [OPTIONS] contribute NAME EMAIL FILE.. - -OPTIONS: - --help | -h - Display this help and exit. - -ARGUMENTS: - NAME := [[git config user.name]] - Your name. - - NAME := [[git config user.email]] - Your email address. - - FILE := [[git diff --name-only --cached]] - The file you want to change. This can be given multiple times. -EOF -} - -for arg in "$@"; do - case "$arg" in - "--help" | "-h") - help - exit 0 - ;; - *) - echo "'$1' is not a recognized option. See --help for more!" 1>&2 - exit 1 - ;; - esac -done - -user_name="$1" -[ -z "$user_name" ] && die "No NAME set! See --help for more" - -user_email="$2" -[ -z "$user_email" ] && die "No EMAIL set! See --help for more" -shift 2 - -styleOne="" -styleTwo="" -[ "$COMMENT_STYLE" ] && styleOne="--style" && styleTwo="$COMMENT_STYLE" - -# The styleTwo must be unquoted to avoid adding empty args to reuse -# shellcheck disable=2086 -reuse annotate --copyright "$user_name <$user_email>" --copyright-prefix string-c --template default --multi-line $styleOne $styleTwo |