Skip to content

Commit

Permalink
Merge pull request rust-lang#1164 from zdenek-crha/doc_gitignore_use
Browse files Browse the repository at this point in the history
Mention that .gitignore is used for watch excludes (rust-lang#1160)
  • Loading branch information
ehuss authored Apr 21, 2020
2 parents 54e58e9 + 5d3b260 commit 1fb8b5f
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
11 changes: 11 additions & 0 deletions book-example/src/cli/serve.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,14 @@ The `--dest-dir` (`-d`) option allows you to change the output directory for the
book. Relative paths are interpreted relative to the book's root directory. If
not specified it will default to the value of the `build.build-dir` key in
`book.toml`, or to `./book`.

#### Specify exclude patterns

The `serve` command will not automatically trigger a build for files listed in
the `.gitignore` file in the book root directory. The `.gitignore` file may
contain file patterns described in the [gitignore
documentation](https://git-scm.com/docs/gitignore). This can be useful for
ignoring temporary files created by some editors.

_Note: Only `.gitignore` from book root directory is used. Global
`$HOME/.gitignore` or `.gitignore` files in parent directories are not used._
12 changes: 12 additions & 0 deletions book-example/src/cli/watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,15 @@ The `--dest-dir` (`-d`) option allows you to change the output directory for the
book. Relative paths are interpreted relative to the book's root directory. If
not specified it will default to the value of the `build.build-dir` key in
`book.toml`, or to `./book`.


#### Specify exclude patterns

The `watch` command will not automatically trigger a build for files listed in
the `.gitignore` file in the book root directory. The `.gitignore` file may
contain file patterns described in the [gitignore
documentation](https://git-scm.com/docs/gitignore). This can be useful for
ignoring temporary files created by some editors.

_Note: Only `.gitignore` from book root directory is used. Global
`$HOME/.gitignore` or `.gitignore` files in parent directories are not used._

0 comments on commit 1fb8b5f

Please sign in to comment.