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 README.md #226

Merged
merged 4 commits into from
Jun 12, 2024
Merged

Update README.md #226

merged 4 commits into from
Jun 12, 2024

Conversation

adamsthws
Copy link
Contributor

Improve the visibility of log2ram filesystem type

Provides additional clarity by showing the type of filesystem (e.g. tmpfs) where 'log2ram' is mounted.
This makes the output more useful for diagnostics and ensuring correct configuration.

  • From:
    df -h | grep log2ram

    • Returns:
      log2ram 128M 89M 40M 70% /var/log
  • To:
    df -hT | grep log2ram

    • Returns:
      log2ram tmpfs 128M 89M 40M 70% /var/log

Enhance visibility of log2ram filesystem type

Changed the command...
  `df -h | grep log2ram`
to: 
  `df -hT | grep log2ram` 

This provides additional clarity by explicitly showing the type of filesystem (e.g. tmpfs) where 'log2ram' is mounted. This makes the output more useful for diagnostics and ensuring correct configuration.
Copy link
Owner

@azlux azlux left a comment

Choose a reason for hiding this comment

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

Add the good exemple.

README.md Outdated
@@ -59,7 +59,7 @@ The log is also written to `/var/log/log2ram.log`.
You can also inspect the mount folder in RAM with:

```bash
# df -h | grep log2ram
# df -hT | grep log2ram
log2ram 40M 532K 40M 2% /var/log
Copy link
Owner

Choose a reason for hiding this comment

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

The good output should be here as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well spotted, thankyou!

I've also modified the commands with 'awk' to enhance the output.

Update the example for 'df -hT...'
Update README with Clearer Examples

Improves readability and provides more immediate comprehension for users checking filesystem mount details. (Uses `awk` to provide more descriptive output).

1. Modified the `df -hT | grep log2ram` command to include labels for each output field, making it easier to understand the filesystem statistics. 

2. Updated the `mount | grep log2ram` command to better display information about the `log2ram` mount.
@azlux azlux merged commit f171449 into azlux:master Jun 12, 2024
@adamsthws adamsthws deleted the update-readme branch July 3, 2024 08:55
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