Skip to content

Commit

Permalink
Merge pull request #163 from bdrung/fix-readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pgier authored May 23, 2019
2 parents bc1a522 + 50384d0 commit a7aeb8d
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ backwards-incompatible ways without warnings. Use it at your own risk.

The procfs library is organized by packages based on whether the gathered data is coming from
/proc, /sys, or both. Each package contains an `FS` type which represents the path to either /proc, /sys, or both. For example, current cpu statistics are gathered from
`/proc/stat` and are available via the root procfs package. First, the proc filesystem mount
`/proc/stat` and are available via the root procfs package. First, the proc filesystem mount
point is initialized, and then the stat information is read.

```go
fs, err := procfs.NewFS("/proc")
stats, err := fs.NewStat()
fs, err := procfs.NewFS("/proc")
stats, err := fs.NewStat()
```

## Building and Testing
Expand All @@ -36,11 +36,11 @@ ensure the `fixtures` directory is up to date by removing the existing directory
extracting the ttar file using `make fixtures/.unpacked` or just `make test`.

```bash
rm -rf fixtures
make test
rm -rf fixtures
make test
```

Next, make the required changes to the extracted files in the `fixtures` directory. When
the changes are complete, run `make update-fixtures` to create a new `fixtures.ttar` file
based on the updated `fixtures` directory. And finally, verify the changes using
Next, make the required changes to the extracted files in the `fixtures` directory. When
the changes are complete, run `make update_fixtures` to create a new `fixtures.ttar` file
based on the updated `fixtures` directory. And finally, verify the changes using
`git diff fixtures.ttar`.

0 comments on commit a7aeb8d

Please sign in to comment.