[gjs: 2/9] docs: Avoid confusing term "checkout directory"
- From: Philip Chimento <pchimento src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gjs: 2/9] docs: Avoid confusing term "checkout directory"
- Date: Sat, 2 Jan 2021 20:52:41 +0000 (UTC)
commit 4816b29cb7447bd3aa8119657cbe541b21f86976
Author: Philip Chimento <philip chimento gmail com>
Date: Thu Dec 3 16:23:02 2020 -0800
docs: Avoid confusing term "checkout directory"
You _checkout_ a branch, but you _clone_ a repository, yet the directory
that you _clone_ into is called a _checkout_ directory! This is weird.
Just refer to it as the gjs directory.
doc/Hacking.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
---
diff --git a/doc/Hacking.md b/doc/Hacking.md
index 7c62cfaa..edab9f54 100644
--- a/doc/Hacking.md
+++ b/doc/Hacking.md
@@ -4,7 +4,7 @@
First of all, if you are contributing C++ code, install the handy git
commit hook that will autoformat your code when you commit it.
-In your GJS checkout directory, run
+In your `gjs` directory, run
`tools/git-pre-commit-format install`.
For more information, see
<https://github.com/barisione/clang-format-hooks/>.
@@ -38,7 +38,7 @@ make sure to use the same build prefix for SpiderMonkey with `--prefix`.
## First build ##
-To build GJS, change to your checkout directory, and run:
+To build GJS, change to your `gjs` directory, and run:
```sh
meson _build
ninja -C _build
@@ -53,7 +53,7 @@ To install GJS into the path you chose with `-Dprefix`, (or into
## Making Sure Your Stuff Doesn't Break Anything Else ##
-Make your changes in your GJS checkout directory, then run
+Make your changes in your `gjs` directory, then run
`ninja -C _build` to build a modified copy of GJS.
Each changeset should ensure that the test suite still passes.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]