From 0140688750be61dd752059ee66734ab1c7a8f30e Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sun, 26 Sep 2021 16:24:18 -0700 Subject: [PATCH] link updates --- README.md | 2 +- docs/parsers/ping_s.md | 2 +- docs/parsers/vmstat_s.md | 2 ++ jc/parsers/ping_s.py | 2 +- jc/parsers/vmstat_s.py | 2 ++ templates/readme_template | 2 +- 6 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e982b315..0151f614 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ > Try the `jc` [web demo](https://jc-web-demo.herokuapp.com/) -> JC is [now available](https://galaxy.ansible.com/community/general) as an Ansible filter plugin in the `community.general` collection! See this [blog post](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) for an example. +> JC is [now available](https://galaxy.ansible.com/community/general) as an Ansible filter plugin in the `community.general` collection. See this [blog post](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) for an example. # JC JSON CLI output utility diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index 5f034948..ffe6b90f 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -9,7 +9,7 @@ Usage (cli): $ ping | jc --ping-s -> Note: When piping `jc` converted ping output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/streaming#streaming-parsers) for more information. +> Note: When piping `jc` converted ping output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#streaming-parsers) for more information. Usage (module): diff --git a/docs/parsers/vmstat_s.md b/docs/parsers/vmstat_s.md index 09c93df5..57323596 100644 --- a/docs/parsers/vmstat_s.md +++ b/docs/parsers/vmstat_s.md @@ -13,6 +13,8 @@ Usage (cli): $ vmstat | jc --vmstat-s +> Note: When piping `jc` converted vmstat output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `vmstat` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#streaming-parsers) for more information. + Usage (module): import jc.parsers.vmstat_s diff --git a/jc/parsers/ping_s.py b/jc/parsers/ping_s.py index 10eb56d9..89e6dc0e 100644 --- a/jc/parsers/ping_s.py +++ b/jc/parsers/ping_s.py @@ -6,7 +6,7 @@ Usage (cli): $ ping | jc --ping-s -> Note: When piping `jc` converted ping output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/streaming#streaming-parsers) for more information. +> Note: When piping `jc` converted ping output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#streaming-parsers) for more information. Usage (module): diff --git a/jc/parsers/vmstat_s.py b/jc/parsers/vmstat_s.py index 77e44562..02fa4fa5 100644 --- a/jc/parsers/vmstat_s.py +++ b/jc/parsers/vmstat_s.py @@ -10,6 +10,8 @@ Usage (cli): $ vmstat | jc --vmstat-s +> Note: When piping `jc` converted vmstat output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `vmstat` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#streaming-parsers) for more information. + Usage (module): import jc.parsers.vmstat_s diff --git a/templates/readme_template b/templates/readme_template index 834be61e..608b83b0 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -3,7 +3,7 @@ > Try the `jc` [web demo](https://jc-web-demo.herokuapp.com/) -> JC is [now available](https://galaxy.ansible.com/community/general) as an Ansible filter plugin in the `community.general` collection! See this [blog post](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) for an example. +> JC is [now available](https://galaxy.ansible.com/community/general) as an Ansible filter plugin in the `community.general` collection. See this [blog post](https://blog.kellybrazil.com/2020/08/30/parsing-command-output-in-ansible-with-jc/) for an example. # JC JSON CLI output utility