summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.git-blame-ignore-revs8
-rw-r--r--.gitconfig2
-rw-r--r--HACKING.md16
-rwxr-xr-xcontrib/setup10
4 files changed, 35 insertions, 1 deletions
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
new file mode 100644
index 0000000..a4e41a4
--- /dev/null
+++ b/.git-blame-ignore-revs
@@ -0,0 +1,8 @@
+# Fix spelling issues with codespell check
+bab81e5e44a13275b93a3e08ace2c2b7a00bef33
+
+# Reformat python code style with black
+17e5903670801ec8a38ecb2808e43d28706a10b0
+
+# Fix trailing white space and end of file
+2678cb00d4cb5426c4e5b714338065d9d3323f7b \ No newline at end of file
diff --git a/.gitconfig b/.gitconfig
new file mode 100644
index 0000000..7994bc3
--- /dev/null
+++ b/.gitconfig
@@ -0,0 +1,2 @@
+[blame]
+ ignoreRevsFile = .git-blame-ignore-revs \ No newline at end of file
diff --git a/HACKING.md b/HACKING.md
index 89ded16..65ac527 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -62,6 +62,15 @@
- see also
<http://www.kernel.org/pub/software/scm/git/docs/>
+## Set up Git environment
+
+Run the following command to include the upower Git configurations.
+
+```bash
+cd contrib
+./setup
+```
+
## Committing code
- Commit messages should be of the form (the five lines between the
@@ -106,5 +115,10 @@
## Testing
-Under Linux, with the umockdev package installed, you can run `ninja test`
+Under Linux, with the umockdev package installed, you can run
+
+```console
+ninja test
+```
+
in the root build directory to run an automated test suite.
diff --git a/contrib/setup b/contrib/setup
new file mode 100755
index 0000000..7eb1a84
--- /dev/null
+++ b/contrib/setup
@@ -0,0 +1,10 @@
+#!/usr/bin/env -S bash -e
+#set up local repository
+
+setup_git()
+{
+ echo "Configuring git environment"
+ git config include.path ../.gitconfig
+}
+
+setup_git