Mailing List Archive: [master] 3f69805f9 Release docs polish

[master] 3f69805f9 Release docs polish

Mar 7, 2024, 2:14 AM

Post #1 of 3 (35 views)

commit 3f69805f91ff70d55d2585214445abf267e4e26b
Author: Nils Goroll <nils.goroll@uplex.de>
Date: Thu Mar 7 11:11:49 2024 +0100

Release docs polish

Mention the old/new cli_limit values

Polish wordning of bits parameter change

Add param.show example in place of what looks like an unmotivated
param.set -j example

diff --git a/doc/sphinx/whats-new/changes-trunk.rst b/doc/sphinx/whats-new/changes-trunk.rst
index e15a7e3cd..f592518f7 100644
--- a/doc/sphinx/whats-new/changes-trunk.rst
+++ b/doc/sphinx/whats-new/changes-trunk.rst
@@ -21,28 +21,38 @@ Parameters

**XXX changes in -p parameters**

-The default value of ``cli_limit`` increased to avoid truncating the
-``param.show -j`` output.
+The default value of ``cli_limit`` has been increased from 48KB to
+64KB to avoid truncating the ``param.show -j`` output for common use
+cases.

The ``vsl_mask`` parameter accepts a new special value "all" that enables
logging of all VSL tags, the counterpart of "none".

-All bits parameters can be set atomically to an absolute value::
+.. I am not sure if "absolute value" is the best name here. It is
+ "relative to all", but I do not have a better idea
+
+This allows all bits parameters to be set atomically to an absolute
+value, as in::

param.set vsl_mask all,-Debug,-ExpKill

-The ``param.show`` output prints them with an absolute value. This enables
-operations to atomically set a value, relative or absolute, and collect the
-absolute value, for bits parameters::
+The ``param.show`` output prints the absolute value. This enables
+operations to atomically set a bits parameter, relative or absolute,
+and collect the absolute value::

- param.set -j feature +http2
+ param.show vsl_mask
+ 200
+ vsl_mask
+ Value is: all,-Debug,-ExpKill
+ [...]

-The ``param.set`` command in JSON mode prints the ``param.show`` JSON output
-after successfully updating a parameter. The ``param.reset`` command now
-shares the same behavior.
+The ``param.set`` command in JSON mode (``-j argument``) prints the
+``param.show`` JSON output after successfully updating a
+parameter. The ``param.reset`` command now shares the same behavior.

-The special value "default" for bits parameters was deprecated in favor of the
-generic ``param.reset`` command. It will be removed in a future release.
+The special value ``default`` for bits parameters was deprecated in
+favor of the generic ``param.reset`` command. It will be removed in a
+future release.

A new ``pipe_task_deadline`` specifies the maximum duration of a pipe
transaction. The default value is the special value "never" to align with the
_______________________________________________
varnish-commit mailing list
varnish-commit@varnish-cache.org
https://www.varnish-cache.org/lists/mailman/listinfo/varnish-commit

Re: [master] 3f69805f9 Release docs polish [ In reply to ]

dridi at varni

Mar 7, 2024, 3:18 AM

Post #2 of 3 (32 views)

Permalink

> Add param.show example in place of what looks like an unmotivated
> param.set -j example

Please revert that part, it was meant to be a param.set -j and not an accident.

I'll try to find a better wording but basically for this:

param.set -j bits +wanted,-part_of_defaults_but_not_wanted

It means that in the JSON output I will get the absolute value, for example:

"none,+wanted,+part_of_defaults"

So in one atomic param.set command I can both make a partial update of
a bits parameter and collect an absolute value for future consistency
checks (if I were to implement such checks with the likes of ansible
for example).

The main use case is not having to care about the default values, and
making sure that specific bits are raised or cleared without
interfering with changes to default values when upgrading.

Dridi
_______________________________________________
varnish-commit mailing list
varnish-commit@varnish-cache.org
https://www.varnish-cache.org/lists/mailman/listinfo/varnish-commit

Re: [master] 3f69805f9 Release docs polish [ In reply to ]

nils.goroll at uplex

Mar 7, 2024, 9:17 AM

Post #3 of 3 (31 views)

Permalink

On 07.03.24 12:18, Dridi Boukelmoune wrote:
> Please revert that part, it was meant to be a param.set -j and not an accident.

Before I try to make it so to follow your plan, just change it however you want it.

--

Nils Goroll (he/him)

** * * UPLEX - Nils Goroll Systemoptimierung

Scheffelstraße 32
22301 Hamburg

tel +49 40 28805731
mob +49 170 2723133
fax +49 40 42949753

xmpp://slink@jabber.int.uplex.de/

http://uplex.de/

_______________________________________________
varnish-commit mailing list
varnish-commit@varnish-cache.org
https://www.varnish-cache.org/lists/mailman/listinfo/varnish-commit