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

Config file update #224

Merged
merged 11 commits into from
Jun 10, 2024
Merged

Config file update #224

merged 11 commits into from
Jun 10, 2024

Conversation

adamsthws
Copy link
Contributor

Enhance Clarity and Readability of Configuration Comments

Overview

This pull request introduces a series of comment updates in the configuration files to improve clarity and readability.

By enhancing the documentation directly within the configuration files, we can reduce the learning curve and help prevent configuration errors.

The changes should make it easier to setup log2ram, especially for new users or those not familiar with the more technical aspects of system configuration.

The revisions provide concise, clear explanations of configuration settings. This includes specifying the purpose and implications of each setting, offering examples where applicable, and outlining the effects of different configurations on system behavior.

Thankyou,
Adam

@azlux
Copy link
Owner

azlux commented Jun 9, 2024

Sorry, I had to force push the branch (error on my side), can you rebase it ?

adamsthws added 11 commits June 9, 2024 20:56
Changes to comments for setting: 'SIZE=128M'
Changes to comments for setting: 'USE_RSYNC=false'
Changes to comments for setting: 'NOTIFICATION=true'
Changes to comments for setting: 'NOTIFICATION_COMMAND='
Changes to comments for setting: 'PATH_DISK='
Changes to comments for setting: 'JOURNALD_AWARE='
Changes to comments for setting: 'ZL2R='
Changes to comments for setting: 'COMP_ALG='
Update to comment for setting: 'LOG_DISK_SIZE='
Update to comment for setting:  'ZL2R='
Update to comment for setting: 'SIZE='
@adamsthws adamsthws force-pushed the config-file-update branch from ecb8ebb to 136d2c1 Compare June 9, 2024 19:59
@adamsthws
Copy link
Contributor Author

Sorry, I had to force push the branch (error on my side), can you rebase it ?

Yes Sir, no problem!

@azlux azlux merged commit 52d0d9a into azlux:master Jun 10, 2024
@adamsthws adamsthws deleted the config-file-update branch June 10, 2024 17:13
# Note: 'rsync' must be used for this feature.
# Ensure 'SystemMaxUse' is configured in 'journald.conf'
# - (To limit journald’s disk usage to be smaller than the log2ram RAM allocation).
JOURNALD_AWARE=true
Copy link

@XhmikosR XhmikosR Jun 28, 2024

Choose a reason for hiding this comment

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

Isn't this block duplicated with line 35?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, thankyou for catching this! It has now been fixed in: this commit

@adamsthws adamsthws restored the config-file-update branch July 2, 2024 20:14
@adamsthws adamsthws deleted the config-file-update branch July 2, 2024 20:25
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.

3 participants