From 236a9fed5f91109d20196ad6336b50c9a5ee14fd Mon Sep 17 00:00:00 2001 From: Ryan Mast Date: Fri, 6 Mar 2020 16:04:04 -0800 Subject: [PATCH] Update generated HELICS apps manpages (#1125) * Generate updated HELICS manpages * Update CHANGELOG.md --- CHANGELOG.md | 1 + docs/man/manpage_out/helics_app-broker.1 | 17 +++++++++++++++-- docs/man/manpage_out/helics_app-clone.1 | 4 ++-- docs/man/manpage_out/helics_app-echo.1 | 4 ++-- docs/man/manpage_out/helics_app-player.1 | 4 ++-- docs/man/manpage_out/helics_app-recorder.1 | 4 ++-- docs/man/manpage_out/helics_app-source.1 | 4 ++-- docs/man/manpage_out/helics_app-tracer.1 | 4 ++-- docs/man/manpage_out/helics_app.1 | 4 ++-- docs/man/manpage_out/helics_broker-term.1 | 4 ++-- docs/man/manpage_out/helics_broker.1 | 17 +++++++++++++++-- docs/man/manpage_out/helics_player.1 | 4 ++-- 12 files changed, 49 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1bf7b061aa..2b134dca6c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,7 @@ Increased code coverage and additional bug fixes. The error propagation in HELI - the `error` Function in the C++ API is now the same as `localError` previously it was primary useful for logging and didn't do much, and will be deprecated in the next release. - Updated the GitHub actions (clang-format, swig interface updates, and release builds) to use actions/checkout@v2 - Cleaned up the Windows installer (better component names/descriptions and groups, link to Gitter, and require installing Headers to install SWIG) +- Updated the HELICS apps manpages with new options ### Fixed - Issue with iterative requests that were not being honored if the federate was acting in isolation diff --git a/docs/man/manpage_out/helics_app-broker.1 b/docs/man/manpage_out/helics_app-broker.1 index 549fcf5c06..954e942c89 100644 --- a/docs/man/manpage_out/helics_app-broker.1 +++ b/docs/man/manpage_out/helics_app-broker.1 @@ -2,12 +2,12 @@ .\" Title: helics_app-broker .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/24/2020 +.\" Date: 03/06/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "HELICS_APP\-BROKER" "1" "01/24/2020" "\ \&" "\ \&" +.TH "HELICS_APP\-BROKER" "1" "03/06/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -202,6 +202,11 @@ Specify a key to use to verify all connections to/from a broker\&. Specify that a broker might be slow or unresponsive to ping requests from other brokers\&. .RE .PP +\-\-terminate_on_error +.RS 4 +Specify that a broker should treat all errors as global errors and terminate the co\-simulation if an error is encountered +.RE +.PP \-\-restrictive_time_policy, \-\-conservative_time_policy .RS 4 Specify that a broker should use a conservative time policy in the time coordinator\&. @@ -263,6 +268,14 @@ Time to wait for a broker connection\&. Can be entered as a time like or \fI45ms\fR\&. Default unit is ms\&. .RE +.PP +\-\-errortimeout +.RS 4 +Time to wait after an error has occured before disconnecting\&. Can be entered as a time like +\fI10s\fR +or +\fI45ms\fR\&. Default unit is ms\&. +.RE .SH "SEE ALSO" .sp helics_broker(1) diff --git a/docs/man/manpage_out/helics_app-clone.1 b/docs/man/manpage_out/helics_app-clone.1 index 4ae32f943c..e5781b2dee 100644 --- a/docs/man/manpage_out/helics_app-clone.1 +++ b/docs/man/manpage_out/helics_app-clone.1 @@ -2,12 +2,12 @@ .\" Title: helics_app-clone .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/24/2020 +.\" Date: 03/06/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "HELICS_APP\-CLONE" "1" "01/24/2020" "\ \&" "\ \&" +.TH "HELICS_APP\-CLONE" "1" "03/06/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/docs/man/manpage_out/helics_app-echo.1 b/docs/man/manpage_out/helics_app-echo.1 index b66e826475..e4b88f4504 100644 --- a/docs/man/manpage_out/helics_app-echo.1 +++ b/docs/man/manpage_out/helics_app-echo.1 @@ -2,12 +2,12 @@ .\" Title: helics_app-echo .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/24/2020 +.\" Date: 03/06/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "HELICS_APP\-ECHO" "1" "01/24/2020" "\ \&" "\ \&" +.TH "HELICS_APP\-ECHO" "1" "03/06/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/docs/man/manpage_out/helics_app-player.1 b/docs/man/manpage_out/helics_app-player.1 index 11b3229292..11b97dceaa 100644 --- a/docs/man/manpage_out/helics_app-player.1 +++ b/docs/man/manpage_out/helics_app-player.1 @@ -2,12 +2,12 @@ .\" Title: helics_app-player .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/24/2020 +.\" Date: 03/06/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "HELICS_APP\-PLAYER" "1" "01/24/2020" "\ \&" "\ \&" +.TH "HELICS_APP\-PLAYER" "1" "03/06/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/docs/man/manpage_out/helics_app-recorder.1 b/docs/man/manpage_out/helics_app-recorder.1 index 7e738c5ba6..d1853c8bee 100644 --- a/docs/man/manpage_out/helics_app-recorder.1 +++ b/docs/man/manpage_out/helics_app-recorder.1 @@ -2,12 +2,12 @@ .\" Title: helics_app-recorder .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/24/2020 +.\" Date: 03/06/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "HELICS_APP\-RECORDER" "1" "01/24/2020" "\ \&" "\ \&" +.TH "HELICS_APP\-RECORDER" "1" "03/06/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/docs/man/manpage_out/helics_app-source.1 b/docs/man/manpage_out/helics_app-source.1 index 875bdd4e8d..ab5c1b839e 100644 --- a/docs/man/manpage_out/helics_app-source.1 +++ b/docs/man/manpage_out/helics_app-source.1 @@ -2,12 +2,12 @@ .\" Title: helics_app-source .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/24/2020 +.\" Date: 03/06/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "HELICS_APP\-SOURCE" "1" "01/24/2020" "\ \&" "\ \&" +.TH "HELICS_APP\-SOURCE" "1" "03/06/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/docs/man/manpage_out/helics_app-tracer.1 b/docs/man/manpage_out/helics_app-tracer.1 index 8783467fb7..281acf13b1 100644 --- a/docs/man/manpage_out/helics_app-tracer.1 +++ b/docs/man/manpage_out/helics_app-tracer.1 @@ -2,12 +2,12 @@ .\" Title: helics_app-tracer .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/24/2020 +.\" Date: 03/06/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "HELICS_APP\-TRACER" "1" "01/24/2020" "\ \&" "\ \&" +.TH "HELICS_APP\-TRACER" "1" "03/06/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/docs/man/manpage_out/helics_app.1 b/docs/man/manpage_out/helics_app.1 index 6d7c14ed95..0a1f0d353a 100644 --- a/docs/man/manpage_out/helics_app.1 +++ b/docs/man/manpage_out/helics_app.1 @@ -2,12 +2,12 @@ .\" Title: helics_app .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/24/2020 +.\" Date: 03/06/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "HELICS_APP" "1" "01/24/2020" "\ \&" "\ \&" +.TH "HELICS_APP" "1" "03/06/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/docs/man/manpage_out/helics_broker-term.1 b/docs/man/manpage_out/helics_broker-term.1 index 814192a011..e03bd369bd 100644 --- a/docs/man/manpage_out/helics_broker-term.1 +++ b/docs/man/manpage_out/helics_broker-term.1 @@ -2,12 +2,12 @@ .\" Title: helics_broker-term .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/24/2020 +.\" Date: 03/06/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "HELICS_BROKER\-TERM" "1" "01/24/2020" "\ \&" "\ \&" +.TH "HELICS_BROKER\-TERM" "1" "03/06/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/docs/man/manpage_out/helics_broker.1 b/docs/man/manpage_out/helics_broker.1 index cc9424fabf..2a04ce092e 100644 --- a/docs/man/manpage_out/helics_broker.1 +++ b/docs/man/manpage_out/helics_broker.1 @@ -2,12 +2,12 @@ .\" Title: helics_broker .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/24/2020 +.\" Date: 03/06/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "HELICS_BROKER" "1" "01/24/2020" "\ \&" "\ \&" +.TH "HELICS_BROKER" "1" "03/06/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -208,6 +208,11 @@ Specify a key to use to verify all connections to/from a broker\&. Specify that a broker might be slow or unresponsive to ping requests from other brokers\&. .RE .PP +\-\-terminate_on_error +.RS 4 +Specify that a broker should treat all errors as global errors and terminate the co\-simulation if an error is encountered +.RE +.PP \-\-restrictive_time_policy, \-\-conservative_time_policy .RS 4 Specify that a broker should use a conservative time policy in the time coordinator\&. @@ -269,6 +274,14 @@ Time to wait for a broker connection\&. Can be entered as a time like or \fI45ms\fR\&. Default unit is ms\&. .RE +.PP +\-\-errortimeout +.RS 4 +Time to wait after an error has occured before disconnecting\&. Can be entered as a time like +\fI10s\fR +or +\fI45ms\fR\&. Default unit is ms\&. +.RE .SH "SUBCOMMANDS" .PP helics_broker\-term(1) diff --git a/docs/man/manpage_out/helics_player.1 b/docs/man/manpage_out/helics_player.1 index 5618614a4d..248b4b2314 100644 --- a/docs/man/manpage_out/helics_player.1 +++ b/docs/man/manpage_out/helics_player.1 @@ -2,12 +2,12 @@ .\" Title: helics_player .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 01/24/2020 +.\" Date: 03/06/2020 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "HELICS_PLAYER" "1" "01/24/2020" "\ \&" "\ \&" +.TH "HELICS_PLAYER" "1" "03/06/2020" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------