eecs280staff / tutorials

Tools and tutorials
https://eecs280staff.github.io/tutorials/
Other
5 stars 4 forks source link

WSL Pitfalls #122

Closed awdeorio closed 1 year ago

awdeorio commented 1 year ago

Centralized location for WSL pitfalls so that we can link to them.

github-actions[bot] commented 1 year ago

The spec from this PR is available at https://preview.sesh.rs/previews/eecs280staff/tutorials/122/.

(Available until Fri Jul 28 2023.)

noah-weingarden commented 1 year ago

I suggest reverting commit 5b76c49: the # prefix is the default Bash prompt when the logged-in user is root.

awdeorio commented 1 year ago

Bump @ohjuny !

ohjuny commented 1 year ago

LGTM, I think the $ prefix would be less confusing for students since it is consistent with all the other tutorials we have. @noah-weingarden thoughts?

noah-weingarden commented 1 year ago

I think that the point of this section of the tutorial is essentially "Don't run commands as root; this is what it looks like if you're running commands as root." If that's the case, it makes the most sense and is least confusing (to me, anyway) to leave that line with root's prompt as a #, since that's the default with bash--it's what a WSL student would actually see if they're logged in as root. If you think it would be helpful, perhaps add an explicit note that the prompt is only # when logged in as root.

Also, I can't find any other tutorials which display shell output when the logged-in user is root. Being logged in as root is a pitfall, after all, so it shouldn't be relevant anywhere but here. It's not a big deal, but there is also an argument to be made that if a WSL student does see that their command prompt is # instead of $, this might be an early hint that they're logged in as root when they shouldn't be.

awdeorio commented 1 year ago

I'm OK with this either way, so I'm going to merge.