Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typo in subprocess input documentation #164

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Fix typo in subprocess input documentation #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion internal/impl/io/input_subprocess.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ func subprocInputSpec() *service.ConfigSpec {
Categories("Utility").
Summary("Executes a command, runs it as a subprocess, and consumes messages from it over stdout.").
Description(`
Messages are consumed according to a specified codec. The command is executed once and if it terminates the input also closes down gracefully. Alternatively, the field `+"`restart_on_close` can be set to `true`"+` in order to have Bento re-execute the command each time it stops.
Messages are consumed according to a specified codec. The command is executed once and if it terminates the input also closes down gracefully. Alternatively, the field `+"`restart_on_exit` can be set to `true`"+` in order to have Bento re-execute the command each time it stops.

The field `+"`max_buffer`"+` defines the maximum message size able to be read from the subprocess. This value should be set significantly above the real expected maximum message size.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/components/inputs/subprocess.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ input:
</TabItem>
</Tabs>

Messages are consumed according to a specified codec. The command is executed once and if it terminates the input also closes down gracefully. Alternatively, the field `restart_on_close` can be set to `true` in order to have Bento re-execute the command each time it stops.
Messages are consumed according to a specified codec. The command is executed once and if it terminates the input also closes down gracefully. Alternatively, the field `restart_on_exit` can be set to `true` in order to have Bento re-execute the command each time it stops.

The field `max_buffer` defines the maximum message size able to be read from the subprocess. This value should be set significantly above the real expected maximum message size.

Expand Down