The terminology surrounding Max Buffer Size is inconsistent #709

New Issue

2026-10-05T04:39:58+02:00

adam commented

2026-10-05 04:39:58 +02:00

Today, as I was configuring my ZNC instance using the webUI module, I noticed that the terminology around the size of the channel playback buffer is not exactly uniform.

I therefore propose that the webUI module be updated to use the following terminology and tooltips:

"MaxBufferSize" (used on the ZNC » webadmin » Settings page) :

"This is the amount of lines that the playback buffer will store for channels
before dropping off the oldest line. The buffers are stored in the memory by default. MaxBufferSize controls the global maximum allowed amount of lines in the playback buffer for each channel."

"BufferSize" (used on the ZNC » webadmin » Edit User [user] page) :

"This is the amount of lines that the playback buffer will store for channels before dropping off the oldest line. The buffers are stored in the memory by default. For normal users, the global MaxBufferSize setting controls the global maximum allowed number of lines in the playback buffer for each channel. Admin users are not subject to this limit."

"BufferCount" (used on the ZNC » webadmin » Edit User [user] » Edit Network [network] page) :

Delete and replace it with "BufferSize" instead for consistency.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Today, as I was configuring my ZNC instance using the webUI module, I noticed that the terminology around the size of the channel playback buffer is not exactly uniform. I therefore propose that the webUI module be updated to use the following terminology and tooltips: **"MaxBufferSize"** (used on the _ZNC » webadmin » Settings_ page) : > "This is the amount of lines that the playback buffer will store for channels > before dropping off the oldest line. The buffers are stored in the memory by default. MaxBufferSize controls the global maximum allowed amount of lines in the playback buffer for each channel." **"BufferSize"** (used on the _ZNC » webadmin » Edit User [user]_ page) : > "This is the amount of lines that the playback buffer will store for channels before dropping off the oldest line. The buffers are stored in the memory by default. For normal users, the global MaxBufferSize setting controls the global maximum allowed number of lines in the playback buffer for each channel. Admin users are not subject to this limit." **"BufferCount"** (used on the _ZNC » webadmin » Edit User [user] » Edit Network [network]_ page) : Delete and replace it with **"BufferSize"** instead for consistency. ## <bountysource-plugin> Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/35075871-the-terminology-surrounding-max-buffer-size-is-inconsistent?utm_campaign=plugin&utm_content=tracker%2F1759&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F1759&utm_medium=issues&utm_source=github). </bountysource-plugin>

adam commented

2026-10-05 04:39:59 +02:00

MaxBufferSize is accurate and should be left alone. It is the global maximum buffer size permitted for either the 'user' level setting or for individual channels (and only admins can go beyond it).

BufferSize at the user level is for user 'default' maximum. New channel buffers for a user's network(s) are autoset to this value. Perhaps a rename to MaxNetworkBufferSize or MaxNetBufferSize.

BufferCount would be a per-network 'default' for channels under that network. As well, newly added networks inherit the default maximum. This should be left alone, except for a rename to MaxChanBufferSize perhaps.

What's missing in your analysis is a buffer count at the network channel level, which I don't remember the name (for the purposes of my reply, assume it's just ChanBufferSize).

Basically, for a non ZNC-administrator user, the logic is thus:

MaxBufferSize >= BufferSize (user level) >= BufferCount (network level) >= ChanBufferSize

"Delete it" as you suggests is vague, though, are you saying to delete BufferCount, or overall rename everything?

`MaxBufferSize` is accurate and should be left alone. It is the global maximum buffer size permitted for either the 'user' level setting or for individual channels (and only admins can go beyond it). `BufferSize` at the user level is for user 'default' maximum. New channel buffers for a user's network(s) are autoset to this value. Perhaps a rename to `MaxNetworkBufferSize` or `MaxNetBufferSize`. `BufferCount` would be a per-network 'default' for channels under that network. As well, newly added networks inherit the default maximum. This should be left alone, except for a rename to `MaxChanBufferSize` perhaps. What's missing in your analysis is a buffer count at the network channel level, which I don't remember the name (for the purposes of my reply, assume it's just ChanBufferSize). Basically, for a non ZNC-administrator user, the logic is thus: `MaxBufferSize >= BufferSize (user level) >= BufferCount (network level) >= ChanBufferSize` "Delete it" as you suggests is vague, though, are you saying to delete BufferCount, or overall rename everything?

adam commented

2026-10-05 04:40:00 +02:00

Having a self-documenting UI is IMHO a really nice feature in terms of discoverability, so ensuring that the labels and their accompanying tooltips (where applicable) are both accurate and succint is therefore worth striving for.

In the user facing webinterface, I would personally prefer full CamelCase terms:

MaxBufferSize (global maximum buffersize)
UserBufferSize (defaults to MaxBufferSize)
NetworkBufferSize (defaults to UserBufferSize)
ChannelBufferSize (defaults to NetworkBufferSize)

I'll let others determine whether or not the above terminology has any value in the code proper.

EDIT: Oh, and the *BufferSize tooltips should all include the word 'lines'. Please. =)

Having a self-documenting UI is IMHO a really nice feature in terms of discoverability, so ensuring that the labels and their accompanying tooltips (where applicable) are both accurate and succint is therefore worth striving for. In the user facing webinterface, I would personally prefer full CamelCase terms: MaxBufferSize (global maximum buffersize) UserBufferSize (defaults to MaxBufferSize) NetworkBufferSize (defaults to UserBufferSize) ChannelBufferSize (defaults to NetworkBufferSize) I'll let others determine whether or not the above terminology has any value in the code proper. EDIT: Oh, and the *BufferSize tooltips should all include the word 'lines'. Please. =)

adam commented

2026-10-05 04:40:01 +02:00

MaxBufferSize is accurate and should be left alone.

It's not accurate in that the variable has no units. I had to search around to determine if this was bytes, lines, or some other unit.

> MaxBufferSize is accurate and should be left alone. It's not accurate in that the variable has no units. I had to search around to determine if this was bytes, lines, or some other unit.

adam commented

2026-10-05 04:40:01 +02:00

What is the definition of MaxBufferSize? global maximum buffersize doesn't tell me much.

What is the definition of MaxBufferSize? global maximum buffersize doesn't tell me much.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: adam/znc#709