Page MenuHomeFreeBSD
Files F177533141

D61408.1794649075.diff
No OneTemporary
Actions

Authored By
Unknown
Size
2 KB
Referenced Files
None
Subscribers
None

D61408.1794649075.diff
View Options

diff --git a/tools/tools/git/README.md b/tools/tools/git/README.md
new file mode 100644
--- /dev/null
+++ b/tools/tools/git/README.md
@@ -0,0 +1,70 @@
+# Introduction
+
+This directory contains a few git-related tools/resources which are useful with
+FreeBSD development.
+
+# Tools in FreeBSD Tree
+
+## `git-arc`
+
+`git-arc` is a developer tool which provides a user-friendly interface with
+[reviews.FreeBSD.org](https://reviews.FreeBSD.org) (Phabricator).
+
+See `man 1 git-arc` for more details on usage, how to install, etc.
+
+## `git-mfc`
+
+`git-mfc` is a developer tool which helps provide a user-friendly interface
+for MFCing changes to stable branches.
+
+See `man 1 git-mfc` for more details on usage, how to install, etc.
+
+# Externally Hosted Tools
+
+## `ghpr`
+
+`ghpr` is a developer tool that helps with landing GitHub PRs in mainstream
+FreeBSD repos. `ghpr` was previously homed in the subdirectory of the same
+name.
+
+The tool can be found on [GitHub](https://github.com/bsdimp/ghpr).
+
+See the README.md in the repo for more details on usage, how to install, etc.
+
+## `git-pr`
+
+`git-pr` is a developer tool that helps with reviewing and landing diffs posted
+on [ron-dev.FreeBSD.org](https://ron-dev.freebsd.org/) (Phorge).
+
+The tool can be found on [Codeberg](https://codeberg.org/FreeBSD/git-pr).
+
+See the README.md in the repo for more details on usage, how to install, etc.
+
+# Installation
+
+## From Source
+
+The tools in this directory can be built via (b)make, like so:
+```sh
+bmake obj && bmake all
+```
+
+The tools can then be installed via (b)make.
+
+The following, for instance, installs the tools to the user's home directory:
+```sh
+sudo make install PREFIX="$HOME/.local" MK_INSTALL_AS_USER=yes
+```
+
+## Using `pkg`
+
+| Tool | Install Command |
+ --------------------------------------------
+| `ghpr` | `pkg install py312-ghpr` |
+ --------------------------------------------
+| `git-arc` | `pkg install freebsd-git-arc` |
+ --------------------------------------------
+| `git-mfc` | `pkg install freebsd-git-mfc` |
+ --------------------------------------------
+| `git-pr` | `pkg install freebsd-git-pr` |
+ --------------------------------------------

File Metadata

Mime Type
text/plain
Expires
Sat, Nov 14, 9:37 AM (25 m, 16 s)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
41665807
Default Alt Text
D61408.1794649075.diff (2 KB)

Event Timeline