Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Update configuration manual to document size-related suffixes #12777

Merged
merged 4 commits into from
May 19, 2022
Merged

Update configuration manual to document size-related suffixes #12777

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2e67646
update config doc
H-Shay May 18, 2022
808773a
newsfragment
H-Shay May 18, 2022
bd264f3
clarify MiB/KiB and example
H-Shay May 18, 2022
53d53ff
Add commas
H-Shay May 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog.d/12777.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Update configuration manual documentation to document size-related suffixes.

8 changes: 8 additions & 0 deletions docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@ followed by a letter. Letters have the following meanings:
For example, setting `redaction_retention_period: 5m` would remove redacted
messages from the database after 5 minutes, rather than 5 months.

In addition, configuration options referring to size use the following suffixes:

* `M` = MB, or 1048576 bytes
* `K` = KB, or 1024 bytes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1024 bytes is actually a Kibibyte, which is abbreviated to KiB. Same for MiB!

It's also a very fun word to say.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is indeed :)


For example, setting `max_avatar_size: 10M` means that Synapse will not accept files larger than 10MB
for a user avatar.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this example might be clearer if we fully spell out what 10 Mebibytes means in this case? (10485760 bytes) Otherwise it kind of reads as "X is equal to X".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense, I've changed it.


### YAML
The configuration file is a [YAML](https://yaml.org/) file, which means that certain syntax rules
apply if you want your config file to be read properly. A few helpful things to know:
Expand Down