Skip to content

Commit

Permalink
Update README.md (#226)
Browse files Browse the repository at this point in the history
* Update README.md

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.

* Update README.md

Update the example for 'df -hT...'

* Update README.md

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.
  • Loading branch information
adamsthws authored Jun 12, 2024
1 parent ee74229 commit f171449
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,30 @@ 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
log2ram 40M 532K 40M 2% /var/log
df -hT | grep log2ram | awk '{print " Name: " $1 "\nMount: " $7 "\n Type: " $2 "\nUsage: " $6 "\n Size: " $3 "\n Used: " $4 "\n Free: " $5}'
```
or also:
Returns:
```bash
Name: log2ram
Mount: /var/log
Type: tmpfs
Usage: 72%
Size: 128M
Used: 93M
Free: 36M
```

Or also:

```bash
# mount | grep log2ram
log2ram on /var/log type tmpfs (rw,nosuid,nodev,noexec,relatime,size=40960k,mode=755)
mount | grep log2ram | awk -F'[ ()]+' '{print " Name: " $1 "\n Mount: " $3 "\n Type: " $5 "\nOptions: " $6}'
```
Returns:
```bash
Name: log2ram
Mount: /var/log
Type: tmpfs
Options: rw,nosuid,nodev,noexec,noatime,size=131072k,mode=755,uid=100000,gid=100000,inode64
```
If you do not get any line as response of these commands, something is not working. Refer to [this section](#is-it-working).
Expand Down

2 comments on commit f171449

@Marc66
Copy link
Contributor

@Marc66 Marc66 commented on f171449 Jun 28, 2024

Choose a reason for hiding this comment

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

README.md is missing the new variable JOURNALD_AWARE and the corresponding description under the Customization / Variables section + should read "there are six variables"

I am not proposing a commit because the use of the JOURNALD_AWARE variable is not clear. See my other comment

The old MAIL variable should also be replaced with the new NOTIFICATION variable and all new variables should also appear in README.md. Eg. NOTIFICATION_COMMAND, COMP_ALG, etc.

I can give it a shot if you want

[Edit: added a few more details]

@Marc66
Copy link
Contributor

@Marc66 Marc66 commented on f171449 Jun 28, 2024

Choose a reason for hiding this comment

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

I submitted a Pull request with above changes

Please sign in to comment.