Skip to content

Commit

Permalink
doc: Shell limitation (#306)
Browse files Browse the repository at this point in the history
* doc: Shell limitation

* Update Readme.md

Co-authored-by: James Sumners <james@sumners.email>

* Welcome PR here

Co-authored-by: Your Name <you@example.com>
Co-authored-by: James Sumners <james@sumners.email>
  • Loading branch information
3 people committed Mar 2, 2022
1 parent 1862157 commit 25b0e51
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,18 @@ This option can also be defined as a `function` with this prototype:
}
```

<a id="license"><a>
## Limitations

Because `pino-pretty` uses stdout redirection, in some cases the command may
terminate with an error due to shell limitations.

For example, currently, mingw64 based shells (e.g. Bash as supplied by [git for
Windows](https://gitforwindows.org)) are affected and terminate the process with
a `stdout is not a tty` error message.

Any PRs are welcomed!

<a id="license"></a>
## License

MIT License

0 comments on commit 25b0e51

Please sign in to comment.