diff options
| author | W. Trevor King <wking@tremily.us> | 2018-05-17 13:22:43 -0700 |
|---|---|---|
| committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-05-18 00:11:10 +0000 |
| commit | c54b423cb3d12154255a81054d54f98536393f54 (patch) | |
| tree | fb10fa37f075b0bd177cf6f35feffe09fee75111 /docs | |
| parent | 3f8587926a17dbbfaaff2ea2168351efe6f5cf55 (diff) | |
| download | podman-c54b423cb3d12154255a81054d54f98536393f54.tar.gz podman-c54b423cb3d12154255a81054d54f98536393f54.tar.bz2 podman-c54b423cb3d12154255a81054d54f98536393f54.zip | |
troubleshooting: Add console syntax highlighting
These blocks include both shell input and command output. GitHub uses
Linuguist for syntax highlighting [1]. Linguist defines a
ShellSession language to highlight those [2], although I prefer the
shorter 'console' alias.
This commit also makes this file more consistent about including the
leading prompt and sudo.
I'd also be fine using the traditional '#' prompt for privileged users
instead of '$ sudo', to be less opinionated about *how* the user
acquires the privileges (via sudo or otherwise). Linguist's
shell-session grammar is from Atom [3], and that grammar recognizes
any of >$#% as the final prompt character [4]. But I've left this
facet alone for now.
[1]: https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
[2]: https://github.com/github/linguist/blob/v6.1.0/lib/linguist/languages.yml#L4362-L4373
[3]: https://github.com/github/linguist/blame/v6.1.0/vendor/README.md#L335
[4]: https://github.com/atom/language-shellscript/blob/v0.26.3/grammars/shell-session.cson#L22
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #796
Approved by: rhatdan
Diffstat (limited to 'docs')
0 files changed, 0 insertions, 0 deletions