Skip to content

Commit

Permalink
Fix spelling mistakes in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
twpayne committed May 7, 2020
1 parent d5a825d commit afb3653
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 37 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ don't need chezmoi. Otherwise, read on...
while still being able to control machine-specific details. You only need to
maintain a single branch. Your dotfiles can be templates (using
[`text/template`](https://pkg.go.dev/text/template) syntax). Predefined
variables allow you to change behaviour depending on operating system,
variables allow you to change behavior depending on operating system,
architecture, and hostname.

* Personal and secure: Nothing leaves your machine, unless you want it to. You
Expand Down
2 changes: 1 addition & 1 deletion chezmoi.io/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ don't need chezmoi. Otherwise, read on...
while still being able to control machine-specific details. You only need to
maintain a single branch. Your dotfiles can be templates (using
[`text/template`](https://pkg.go.dev/text/template) syntax). Predefined
variables allow you to change behaviour depending on operating system,
variables allow you to change behavior depending on operating system,
architecture, and hostname.

* Personal and secure: Nothing leaves your machine, unless you want it to. You
Expand Down
32 changes: 16 additions & 16 deletions cmd/docs.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions cmd/helps.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,15 +136,15 @@ If you're packaging chezmoi for an operating system or distribution:
`$DATE` should be the date of the build in RFC3339 format, e.g.
`2019-11-23T18:29:25Z`.

`$BULIT_BY` should be a string indicating what mechanism was used to build the
`$BUILT_BY` should be a string indicating what mechanism was used to build the
binary, e.g. `goreleaser`.

* Please enable cgo, if possible. chezmoi can be built and run without cgo, but
the `.chezmoi.username` and `.chezmoi.group` template variables may not be set
correctly on some systems.

* chezmoi includes a `docs` command which prints its documentation. By default,
the docs are embedded in the binary. You can disable this behaviour, and have
the docs are embedded in the binary. You can disable this behavior, and have
chezmoi read its docs from the filesystem by building with the `noembeddocs`
build tag and setting the directory where chezmoi can find them with the `-X
github.com/twpayne/chezmoi/cmd.DocDir=$DOCDIR` linker flag. For example:
Expand Down
6 changes: 3 additions & 3 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ in your configuration file, for example:
Note that this will apply to all files and directories that chezmoi manages and
will ensure that none of them are group writeable. It is not currently possible
to control group writability for individual files or directories. Please [open
an issue on
to control group write permissions for individual files or directories. Please
[open an issue on
GitHub](https://github.com/twpayne/chezmoi/issues/new?assignees=&labels=enhancement&template=02_feature_request.md&title=)
if you need this.
Expand Down Expand Up @@ -238,7 +238,7 @@ If your needs extend beyond modifying a handful of files outside your target
system, then existing configuration management tools like
[Puppet](https://puppet.com/), [Chef](https://www.chef.io/chef/),
[Ansible](https://www.ansible.com/), and [Salt](https://www.saltstack.com/) are
much better suited - and of couse can be called from a chezmoi `run_` script.
much better suited - and of course can be called from a chezmoi `run_` script.
Put your Puppet Manifests, Chef Recipes, Ansible Modules, and Salt Modules in a
directory ignored by `.chezmoiignore` so they do not pollute your home
directory.
Expand Down
14 changes: 7 additions & 7 deletions docs/HOWTO.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,8 @@ The file should look something like:
To disable automatic variable detection, use the `--template` or `-T` option to
`chezmoi add` instead of `--autotemplate`.

Templates are often used to capture machine-specifc differences. For example, in
your `~/.local/share/chezmoi/dot_bashrc.tmpl` you might have:
Templates are often used to capture machine-specific differences. For example,
in your `~/.local/share/chezmoi/dot_bashrc.tmpl` you might have:

# common config
export EDITOR=vi
Expand Down Expand Up @@ -229,9 +229,9 @@ will ignore all files beginning with an `f` except `foo`.

## Use completely separate config files on different machines

chezmoi's templating functionality allows you to change a file's contents based
on any variable. For example, if you want `~/.bashrc` to be different on Linux
and macOS you would create a file in the source state called `dot_bashrc.tmpl`
chezmoi's template functionality allows you to change a file's contents based on
any variable. For example, if you want `~/.bashrc` to be different on Linux and
macOS you would create a file in the source state called `dot_bashrc.tmpl`
containing:

```
Expand All @@ -244,7 +244,7 @@ containing:

However, if the differences between the two versions are so large that you'd
prefer to use completely separate files in the source state, you can achieve
this using a templated symbolic link. Create the following files:
this using a symbolic link template. Create the following files:

`symlink_dot_bashrc.tmpl`:

Expand Down Expand Up @@ -604,7 +604,7 @@ Documents can be retrieved with:
{{- onepasswordDocument "uuid" -}}

Note the extra `-` after the opening `{{` and before the closing `}}`. This
instructs the templating language to remove and whitespace before and after the
instructs the template language to remove and whitespace before and after the
substitution. This removes any trailing newline added by your editor when saving
the template.

Expand Down
2 changes: 1 addition & 1 deletion docs/MEDIA.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
| ---------- | ------- | ------------ | ------------------------------------------------------------------------------------------------------------------------- |
| 2020-04-16 | 1.17.19 | Text (FR) | [Chezmoi, visite guidée](https://blog.wescale.fr/2020/04/16/chezmoi-visite-guidee/) |
| 2020-04-03 | 1.7.17 | Text | [Fedora Magazine: Take back your dotfiles with Chezmoi](https://fedoramagazine.org/take-back-your-dotfiles-with-chezmoi/) |
| 2020-03-12 | 1.7.16 | Video | [Manging Dotfiles with ChezMoi](https://www.youtube.com/watch?v=HXx6ugA98Qo) |
| 2020-03-12 | 1.7.16 | Video | [Managing Dotfiles with ChezMoi](https://www.youtube.com/watch?v=HXx6ugA98Qo) |
| 2019-11-20 | 1.7.2 | Audio/video | [FLOSS weekly episode 556: chezmoi](https://twit.tv/shows/floss-weekly/episodes/556) |
| 2019-01-10 | 0.0.11 | Text | [Linux Fu: The kitchen sync](https://hackaday.com/2019/01/10/linux-fu-the-kitchen-sync/) |

Expand Down
6 changes: 3 additions & 3 deletions docs/REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ directory. The `add` command accepts additional flags:
#### `--autotemplate`

Automatically generate a template by replacing strings with variable names from
the `data` section of the config file. Longer subsitutions occur before shorter
the `data` section of the config file. Longer substitutions occur before shorter
ones. This implies the `--template` option.

#### `-e`, `--empty`
Expand Down Expand Up @@ -590,7 +590,7 @@ Edit the configuration file.
### `execute-template` [*templates*]

Execute *templates*. This is useful for testing templates or for calling chezmoi
from other scripts. *templates* are interpeted as literal templates, with no
from other scripts. *templates* are interpreted as literal templates, with no
whitespace added to the output between arguments. If no templates are specified,
the template is read from stdin.

Expand Down Expand Up @@ -782,7 +782,7 @@ To get a full list of available commands run:
### `source` [*args*]

Execute the source version control system in the source directory with *args*.
Note that any flags for the source version control system must be sepeated with
Note that any flags for the source version control system must be separated with
a `--` to stop chezmoi from reading them.

#### `source` examples
Expand Down

0 comments on commit afb3653

Please sign in to comment.