Skip to content

Commit 629db2a

Browse files
committed
docs: more proofing
1 parent 674e408 commit 629db2a

File tree

3 files changed

+8
-8
lines changed
  • docs/05-building-your-toolkit

3 files changed

+8
-8
lines changed

docs/05-building-your-toolkit/26-managing-your-dotfiles/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ You will mostly see dotfiles in your `HOME` directory. They have a dot to mark t
3636

3737
As an example, a user's personal Bash configuration is stored in _~/.bashrc_, but the global Bash configuration applied to _all_ users is stored in _/etc/bash.bashrc_. The second configuration file does not need a dot in front of it - the _/etc_ folder is where configuration is kept so there is no need to differentiate it from other files like a user's personal files.
3838

39-
Nowadays, when a user say "my dotfiles", they typically mean their _configuration_ files that are kept in their home directory. In a sense, your dotfiles are a bit like your personal settings for your computer. On a desktop environment your settings might be things like your theme or wallpaper. For a shell user, you settings will be files like _~/.bashrc_ for your shell configuration, _~/.ssh/config_ for your SSH configuration and so on.
39+
Nowadays, when a user says "my dotfiles", they typically mean their _configuration_ files that are kept in their home directory. In a sense, your dotfiles are a bit like your personal settings for your computer. On a desktop environment your settings might be things like your theme or wallpaper. For a shell user, you settings will be files like _~/.bashrc_ for your shell configuration, _~/.ssh/config_ for your SSH configuration and so on.
4040

4141
You will likely change the dotfiles over time to suit your preferences. Let's take a look at some sensible ways to organise and structure your dotfiles so that you can easily see what is your personal configuration, rather than what is the default configuration provided by the system, and easily manage these configurations.
4242

@@ -201,7 +201,7 @@ VISUAL=nano
201201
EDITOR=nano
202202
```
203203

204-
There are two variables are are used by the shell and command line programs to run an editor. The first, and original, variable was `EDITOR`. This was originally often a _line mode_ editor - i.e. a text editor that doesn't take up the whole screen. This was useful in the days of printed output, before screens were used. The `VISUAL` variable was used to specify the editor that could be used for 'full screen' terminal editing. Some programs use `EDITOR` and some use `VISUAL` so it is best to set both.
204+
There are two variables are used by the shell and command line programs to run an editor. The first, and original, variable was `EDITOR`. This was originally often a _line mode_ editor - i.e. a text editor that doesn't take up the whole screen. This was useful in the days of printed output, before screens were used. The `VISUAL` variable was used to specify the editor that could be used for 'full screen' terminal editing. Some programs use `EDITOR` and some use `VISUAL` so it is best to set both.
205205

206206
I have used the `nano` editor in this example as it available on many distributions and is a little easier than `vi` or `emacs`, but you can use whatever you like. For my personal dotfiles I use `vi`.
207207

@@ -330,7 +330,7 @@ This is a great way to verify that the script works as expected, before we actua
330330

331331
Now that we have a working shell dotfile, we can source it as part of our shell startup.
332332

333-
Rather than having our shell startup file know about our _~/dotfiles_ folder, we will create a symlink to th shell script from our home directory:
333+
Rather than having our shell startup file know about our _~/dotfiles_ folder, we will create a symlink to the shell script from our home directory:
334334

335335
Finally, we can create a symlink in our home directory that points to our _~/dotfiles/shell.sh_ file and we are good to go!
336336

docs/05-building-your-toolkit/27-controlling-changes-with-git/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ nothing added to commit but untracked files present (use "git add" to track)
8989

9090
The first thing that `git status` tells us is the name of the _branch_ we are on. We'll look at branches in detail shortly. The next thing we see is that there are no _commits_ - commits are sets of changes that we track. Finally, git is telling us that there are three files that are 'untracked'. These are the _install.sh_ and _shell.sh_ files as well as the _shell.d_ folder.
9191

92-
If we are going to use Git to track changes to these file, we need to add them to the repository. We can do that with the _git add_ (_add file contents to index_) command<!--index-->:
92+
If we are going to use Git to track changes to these files, we need to add them to the repository. We can do that with the _git add_ (_add file contents to index_) command<!--index-->:
9393

9494
```
9595
$ git add .
@@ -329,7 +329,7 @@ $ tree
329329
└── shell.sh
330330
```
331331

332-
When we switch back to the _main_ branch and look our our working tree we can see that the _git_aliases.sh_ file is not present. This is very cool - by passing the name of the branch we want to switch to as the parameter to the `git checkout` command we can switch branches. If we are on the _main_ branch we don't see the _git_aliases.sh_ file, because the commit that added is was not on the _main_ branch. To go back to the _aliases_ branch we can just checkout again:
332+
When we switch back to the _main_ branch and look at our working tree we can see that the _git_aliases.sh_ file is not present. This is very cool - by passing the name of the branch we want to switch to as the parameter to the `git checkout` command we can switch branches. If we are on the _main_ branch we don't see the _git_aliases.sh_ file, because the commit that added is was not on the _main_ branch. To go back to the _aliases_ branch we can just checkout again:
333333

334334
```
335335
$ git checkout aliases
@@ -902,4 +902,4 @@ We've introduced a lot of commands in this chapter - you can use this table as a
902902
| `git mv <source> <destination>` | Stage the movement of `source` to `destination`. |
903903
| `git checkout 8342bec` | Checkout a commit with SHA `834bec`. |
904904
| `git checkout HEAD~1` | Move the current HEAD back one commit. |
905-
| `git checkout <branch>~3` | Checkout `branch`, move back three commits from the tip. |
905+
| `git checkout <branch>~3` | Checkout `branch`, move back three commits from the tip. |

docs/05-building-your-toolkit/28-managing-remote-git-repositories/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ Choose the 'fork' option and GitHub will create a copy of the repository in your
257257

258258
If you have made changes to a fork, you can then open a _Pull Request_. A pull request is a request to merge a set of changes from one branch into another, or from one fork into the original repository. So if you were to improve upon the dotfiles that you forked, and wanted to share your changes back, you could open a pull request to do so.
259259

260-
Typically when a pull request is opened, the project maintainer will then review the changes, make suggestions or discuss the proposal, and then either merge the pull request or reject it. In the screenshot below I am opening a pull request from my clone of the dorfile repository to the original dotfiles repository, this pull requests adds an uninstall script to the repository. A maintainer of the target repository will then review the changes:
260+
Typically when a pull request is opened, the project maintainer will then review the changes, make suggestions or discuss the proposal, and then either merge the pull request or reject it. In the screenshot below I am opening a pull request from my clone of the dotfiles repository to the original dotfiles repository, this pull requests adds an uninstall script to the repository. A maintainer of the target repository will then review the changes:
261261

262262
![Screenshot of a pull request being opened](./images/github-open-pull-request.png)
263263

@@ -447,4 +447,4 @@ In this chapter we learned how to use GitHub to host a remote repository, how to
447447

448448
Although we've only scratched the surface of what Git can do, you should now have the tools to work with repositories, share content like your dotfiles, collaborate with others and manage your own changes.
449449

450-
In the next part of the book we will look at some advanced techniques that can help you as a shell user.
450+
In the next part of the book we will look at some advanced techniques that can help you as a shell user.

0 commit comments

Comments
 (0)