Skip to content

Commit

Permalink
fix documentation about ipv6only always being added
Browse files Browse the repository at this point in the history
This was refering to issue voxpupuli#30 which was closed by changing the
behavior for *not* adding the default in the template. Instead, the
default includes the setting. We do not mention the default here
because it's visible in the generated `REFERENCE.md` file and is not
mentioned in other parameter documentation anyways.
  • Loading branch information
anarcat committed Aug 30, 2022
1 parent 516750e commit a1aff2e
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 18 deletions.
12 changes: 3 additions & 9 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2644,9 +2644,7 @@ Default value: `$listen_port`

Data type: `String`

Extra options for listen directive like 'default' to catchall. Template
will allways add ipv6only=on. While issue jfryman/puppet-nginx#30 is
discussed, default value is 'default'.
Extra options for listen directive like 'default' to catchall.

Default value: `'default ipv6only=on'`

Expand Down Expand Up @@ -3354,9 +3352,7 @@ Default value: `$listen_port`

Data type: `String`

Extra options for listen directive like 'default' to catchall. Template
will allways add ipv6only=on. While issue jfryman/puppet-nginx#30 is
discussed, default value is 'default'.
Extra options for listen directive like 'default' to catchall.

Default value: `'default ipv6only=on'`

Expand Down Expand Up @@ -4479,9 +4475,7 @@ Default value: `$listen_port`

Data type: `String`

Extra options for listen directive like 'default' to catchall. Template
will allways add ipv6only=on. While issue jfryman/puppet-nginx#30 is
discussed, default value is 'default'.
Extra options for listen directive like 'default' to catchall.

Default value: `'default ipv6only=on'`

Expand Down
4 changes: 1 addition & 3 deletions manifests/resource/mailhost.pp
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@
# @param ipv6_listen_port
# Default IPv6 Port for NGINX to listen with this server on.
# @param ipv6_listen_options
# Extra options for listen directive like 'default' to catchall. Template
# will allways add ipv6only=on. While issue jfryman/puppet-nginx#30 is
# discussed, default value is 'default'.
# Extra options for listen directive like 'default' to catchall.
# @param ssl
# Indicates whether to setup SSL bindings for this mailhost.
# @param ssl_cert
Expand Down
4 changes: 1 addition & 3 deletions manifests/resource/server.pp
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@
# @param ipv6_listen_port
# Default IPv6 Port for NGINX to listen with this server on. Defaults to TCP 80
# @param ipv6_listen_options
# Extra options for listen directive like 'default' to catchall. Template
# will allways add ipv6only=on. While issue jfryman/puppet-nginx#30 is
# discussed, default value is 'default'.
# Extra options for listen directive like 'default' to catchall.
# @param add_header
# Adds headers to the HTTP response when response code is equal to 200, 204,
# 301, 302 or 304.
Expand Down
5 changes: 2 additions & 3 deletions manifests/resource/streamhost.pp
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@
# @param ipv6_listen_port
# Default IPv6 Port for NGINX to listen with this streamhost on.
# @param ipv6_listen_options
# Extra options for listen directive like 'default' to catchall. Template
# will allways add ipv6only=on. While issue jfryman/puppet-nginx#30 is
# discussed, default value is 'default'.
# Extra options for listen directive like 'default' to
# catchall.
# @param proxy
# Proxy server(s) for the root location to connect to. Accepts a single
# value, can be used in conjunction with nginx::resource::upstream
Expand Down

0 comments on commit a1aff2e

Please sign in to comment.