diff --git a/cli/.gitignore b/cli/.gitignore index 53ca19a23..2319f815c 100644 --- a/cli/.gitignore +++ b/cli/.gitignore @@ -1,16 +1,16 @@ -# Generated by Cargo -# will have compiled files and executables -debug/ -target/ - -# These are backup files generated by rustfmt -**/*.rs.bk - -# Ignore OpenAPI cache files -.openapi_cache -# Ignore generated OpenAPI documentation -unit-openapi/docs -# Ignore autogenerated OpenAPI code -unit-openapi/src - +# Generated by Cargo +# will have compiled files and executables +debug/ +target/ + +# These are backup files generated by rustfmt +**/*.rs.bk + +# Ignore OpenAPI cache files +.openapi_cache +# Ignore generated OpenAPI documentation +unit-openapi/docs +# Ignore autogenerated OpenAPI code +unit-openapi/src + config \ No newline at end of file diff --git a/cli/README.md b/cli/README.md index d3a1d283c..1a2a1c716 100644 --- a/cli/README.md +++ b/cli/README.md @@ -1,18 +1,18 @@ # NGINX UNIT Rust SDK and CLI -This project provides a Rust SDK interface to the +This project provides a Rust SDK interface to the [NGINX UNIT](https://unit.nginx.org/) -[control API](https://unit.nginx.org/howto/source/#source-startup) +[control API](https://unit.nginx.org/howto/source/#source-startup) and a CLI (`unitctl`) that exposes the functionality provided by the SDK. ## Installation and Use -In order to build and use `unitctl` one needs a working installation of Maven -and Cargo. It is recommended to procure Cargo with Rustup. Rustup is packaged -for use in many systems, but you can also find it at its +In order to build and use `unitctl` one needs a working installation of Maven +and Cargo. It is recommended to procure Cargo with Rustup. Rustup is packaged +for use in many systems, but you can also find it at its [Official Site](https://rustup.rs/). -With a working installation of Cargo it is advised to build unitctl with the -provided makefile. The `list-targets` target will inform the user of what +With a working installation of Cargo it is advised to build unitctl with the +provided makefile. The `list-targets` target will inform the user of what platforms are available to be built. One or more of these can then be run as their own makefile targets. Alternatively, all available binary targets can be built with `make all`. See the below example for illustration: @@ -30,7 +30,7 @@ with debug_info, not stripped ``` As demonstrated in the example above, compiled binaries may be found in the -targets folder, under the subdirectory corresponding to the build target +targets folder, under the subdirectory corresponding to the build target desired. @@ -106,7 +106,7 @@ $ unitctl edit { "success": "Reconfiguration done." -} +} ``` ### Display interactive OpenAPI control panel @@ -137,7 +137,7 @@ Timeout waiting for unit to start has been exceeded We welcome pull requests and issues! -Please refer to the +Please refer to the [Contributing Guidelines](../CONTRIBUTING.md) when doing a PR. ## License diff --git a/cli/build/openapi-generator-cli.sh b/cli/build/openapi-generator-cli.sh index 99d1ea72e..3a65e5ced 100755 --- a/cli/build/openapi-generator-cli.sh +++ b/cli/build/openapi-generator-cli.sh @@ -74,5 +74,4 @@ java -ea \ -Xms512M \ -Xmx1024M \ -server \ - -jar ${DIR}/${jar} "$@" - + -jar ${DIR}/${jar} "$@" \ No newline at end of file diff --git a/cli/man/unitctl.1 b/cli/man/unitctl.1 index 966cf1480..1bd725c6d 100644 --- a/cli/man/unitctl.1 +++ b/cli/man/unitctl.1 @@ -14,7 +14,7 @@ Report any issues on the project issue tracker at: \fB\fR . .SH ACKNOWLEDGEMENTS -WRITE ME +WRITE ME . .SH AUTHOR Elijah Zupancic \fB\fR diff --git a/cli/unit-openapi/README.md b/cli/unit-openapi/README.md index 05aba6d9c..e4d6e925d 100644 --- a/cli/unit-openapi/README.md +++ b/cli/unit-openapi/README.md @@ -408,5 +408,4 @@ cargo doc --open ## Author -unit-owner@nginx.org - +unit-owner@nginx.org \ No newline at end of file diff --git a/cli/unitctl/src/unitctl.rs b/cli/unitctl/src/unitctl.rs index e9fe0333d..49e87e8e4 100644 --- a/cli/unitctl/src/unitctl.rs +++ b/cli/unitctl/src/unitctl.rs @@ -123,7 +123,7 @@ pub(crate) enum Commands { help = "Output format: yaml, json, json-pretty (default)" )] output_format: OutputFormat, - } + }, } fn parse_control_socket_address(s: &str) -> Result {