doc: Replace 'shell' language labels (generally with 'console')
authorW. Trevor King <wking@tremily.us>
Mon, 8 Jan 2018 22:42:48 +0000 (14:42 -0800)
committerW. Trevor King <wking@tremily.us>
Mon, 8 Jan 2018 22:48:45 +0000 (14:48 -0800)
commitbc489e255d6a7cee5531da4992512a9e281000bb
treefbb3739154f22e5b0120815a50b8545b04396708
parentf60ece98c10aa3716d037524da4ee989e212fe19
doc: Replace 'shell' language labels (generally with 'console')

GitHub uses Linguist for syntax highlighting [1].  Linguist's 'shell'
language is for the *language* [2] (e.g. the contents of a `.sh`
file).  The proper language for a shell session is ShellSession [3],
although in this commit I've used the alias 'console' [4].

The Cargo book uses mdBook (src/doc/README.md), mdBook uses
Highlight.js [5], and Highlight.js also supports 'console' as an alias
for shell sessions [6].

A handful of places where we had been using 'shell' were just command
output, not shell sessions (e.g. they lacked a prompt and command).
In this commit, I've left those without a language label.

[1]: https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
[2]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4208
[3]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4249
[4]: https://github.com/github/linguist/blob/v5.3.3/lib/linguist/languages.yml#L4255
[5]: https://rust-lang-nursery.github.io/mdBook/format/theme/syntax-highlighting.html#syntax-highlighting
[6]: https://github.com/isagalaev/highlight.js/blob/9.12.0/src/languages/shell.js#L10
13 files changed:
src/doc/README.md
src/doc/src/getting-started/first-steps.md
src/doc/src/getting-started/installation.md
src/doc/src/guide/cargo-toml-vs-cargo-lock.md
src/doc/src/guide/creating-a-new-project.md
src/doc/src/guide/dependencies.md
src/doc/src/guide/project-layout.md
src/doc/src/guide/tests.md
src/doc/src/guide/working-on-an-existing-project.md
src/doc/src/reference/build-scripts.md
src/doc/src/reference/manifest.md
src/doc/src/reference/publishing.md
src/doc/src/reference/specifying-dependencies.md