Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update migration guide with TOML changes #3007

Merged
merged 2 commits into from
Jan 18, 2021
Merged

Conversation

leszke
Copy link
Contributor

@leszke leszke commented Jan 14, 2021

Basically I went through the output of git diff master toml-config doc/ command and wrote it down, already excluding couple of type alignments. I also added missing link to the newest migration guide's chapter.

doc/migrations/4.0.1_4.x.x.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Jan 14, 2021

Codecov Report

Merging #3007 (5752230) into toml-config (2646ad2) will decrease coverage by 16.96%.
The diff coverage is n/a.

Impacted file tree graph

@@               Coverage Diff                @@
##           toml-config    #3007       +/-   ##
================================================
- Coverage        78.51%   61.55%   -16.97%     
================================================
  Files              376      376               
  Lines            31574    31574               
================================================
- Hits             24790    19434     -5356     
- Misses            6784    12140     +5356     
Impacted Files Coverage Δ
src/mam/mam_jid.erl 0.00% <0.00%> (-100.00%) ⬇️
src/mam/mam_jid_rfc.erl 0.00% <0.00%> (-100.00%) ⬇️
src/mam/mam_message.erl 0.00% <0.00%> (-100.00%) ⬇️
src/mam/mam_message_xml.erl 0.00% <0.00%> (-100.00%) ⬇️
src/mod_auth_token_rdbms.erl 0.00% <0.00%> (-100.00%) ⬇️
src/inbox/mod_inbox_one2one.erl 0.00% <0.00%> (-100.00%) ⬇️
src/rdbms/rdbms_queries_mssql.erl 0.00% <0.00%> (-100.00%) ⬇️
src/inbox/mod_inbox_rdbms_mssql.erl 0.00% <0.00%> (-100.00%) ⬇️
src/inbox/mod_inbox_rdbms_mysql.erl 0.00% <0.00%> (-100.00%) ⬇️
src/inbox/mod_inbox_rdbms_pgsql.erl 0.00% <0.00%> (-100.00%) ⬇️
... and 109 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2646ad2...2c00f85. Read the comment docs.

Copy link
Member

@chrzaszcz chrzaszcz left a comment

Choose a reason for hiding this comment

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

I think the migration guide (contrary to the changelog) should only list the changes that require actions from the user. This is why I pointed out all the changes that actually are only doc corrections - I think they shouldn't be listed here as they require no action from the user. If they had a correct setting, it remains correct, so no there is no migration.

Regarding the language - I pointed out a few missing articles, which I am sure about.

doc/migrations/4.0.1_4.x.x.md Outdated Show resolved Hide resolved
doc/migrations/4.0.1_4.x.x.md Outdated Show resolved Hide resolved
doc/migrations/4.0.1_4.x.x.md Outdated Show resolved Hide resolved
doc/migrations/4.0.1_4.x.x.md Outdated Show resolved Hide resolved
doc/migrations/4.0.1_4.x.x.md Show resolved Hide resolved
doc/migrations/4.0.1_4.x.x.md Outdated Show resolved Hide resolved
doc/migrations/4.0.1_4.x.x.md Outdated Show resolved Hide resolved
doc/migrations/4.0.1_4.x.x.md Outdated Show resolved Hide resolved
doc/migrations/4.0.1_4.x.x.md Outdated Show resolved Hide resolved
doc/migrations/4.0.1_4.x.x.md Outdated Show resolved Hide resolved

* `mod_global_distrib.connections.tls.enabled`: the flag was removed, TLS is enabled by providing the [`cacertfile`](../../modules/mod_global_distrib/#modulesmod_global_distribconnectionstlscacertfile) and [`certfile`](../../modules/mod_global_distrib/#modulesmod_global_distribconnectionstlscertfile) options

* [`mod_http_upload.max_file_size`](../../modules/mod_http_upload/#modulesmod_http_uploadmax_file_size): `undefined` is no longer allowed
Copy link
Member

@chrzaszcz chrzaszcz Jan 18, 2021

Choose a reason for hiding this comment

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

Just a note: Actually it seems that this was already changed (accidentally?) when introducing TOML, but I believe there were no comments about it, so let's keep it, no changes needed here.

Copy link
Member

@chrzaszcz chrzaszcz left a comment

Choose a reason for hiding this comment

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

Looks great!

@chrzaszcz chrzaszcz merged commit 2584101 into toml-config Jan 18, 2021
@chrzaszcz chrzaszcz deleted the update-migration_guide branch January 18, 2021 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants