Skip to content

Rename ringbuf-shm to ringbuf_shm #6

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

Merged
merged 3 commits into from
Jun 19, 2021

Conversation

ChunMinChang
Copy link
Contributor

The ringbuf_shm link in README.md is not working since it's linked to
an inexistent ringbuf_shm folder. Renaming ringbuf-shm folder to
ringbuf_shm fixes the problem.

The `ringbuf_shm` link in README.md is not working since it's linked to
an inexistent `ringbuf_shm` folder. Renaming `ringbuf-shm` folder to
`ringbuf_shm` fixes the problem.
@jserv
Copy link
Contributor

jserv commented Jun 18, 2021

Why didn't change the top-level README.md instead?

@ChunMinChang
Copy link
Contributor Author

ChunMinChang commented Jun 19, 2021

I am comfortable with both approaches as long as they can fix the link.

The term in ringbuf-shm/README.md is named ringbuf_shm instead, and the _ is used in another folder's name (preempt_sched), so I guess the naming convention here prefers _.

I didn't file the PR in the first place because I'd like to keep the author's name on the files (in git blame and history). So renaming the folder's name in README.md rather than the folder's name itself is probably more in line with my need.

Feel free to let me know what works for you best.

@jserv
Copy link
Contributor

jserv commented Jun 19, 2021

The term in ringbuf-shm/README.md is named ringbuf_shm instead, and the _ is used in another folder's name (preempt_sched), so I guess the naming convention here prefers _.

I did not follow a consistent name scheme since these programs were written separately. The minimal change is fine to me.

@jserv jserv merged commit 139081d into sysprog21:master Jun 19, 2021
@jserv
Copy link
Contributor

jserv commented Jun 19, 2021

Thank @ChunMinChang for contributing!

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