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.

Sign up for GitHub

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

Jump to bottom

Add clarity to dotfile edits #4053

Open
ghost opened this issue May 31, 2017 · 5 comments · May be fixed by #4054
Open

Add clarity to dotfile edits #4053

ghost opened this issue May 31, 2017 · 5 comments · May be fixed by #4054
Assignees
@pkuczynski
Labels
feature
Milestone
rvm-1.29.13

Comments

@ghost
Copy link

ghost commented May 31, 2017

Description

The RVM installer edits several dot-files (and creates them, if they do not already exist). It can be confusing for a user to find dot-files in their home directory for shells they have never installed (e.g. .mkshrc, if they are not a mksh user). It can also be hard for a novice user to know which edits to their dot-files were made by what, when, and why.

Possible example of such confusion: #3130

Steps to reproduce

  1. Install RVM according to the instructions.
  2. Several dotfiles (.mkshrc, .bashrc, .profile, .bash_profile, etc) are created or modified.
  3. The user might not, at some point in the future, know exactly which ones were modified by RVM, when, and how.

Expected behavior

RVM should clearly delineate the edits it makes to dot-files.

Actual behavior

RVM is terse. It is hard to be confident whether the file was modified by RVM itself, or did I instead make the edit manually at some point? Why do I even have a .mkshrc, given that I don't have mksh installed? Example, after installing a slightly earlier version of RVM:


export PATH="$PATH:$HOME/.rvm/bin" # Add RVM to PATH for scripting

Environment info

N/A
@ghost ghost linked a pull request May 31, 2017 that will close this issue
Open
@pkuczynski
Copy link
Member

What do you mean by delineate? Would you expect RVM to print info during installation or include comment whenever dotfile is modified by RVM?

@ghost
Copy link
Author

ghost commented May 31, 2017

@pkuczynski something like this: 1873ef2#diff-e2aa477d4d8062608817e3021b4ed39d :)

@pkuczynski
Copy link
Member

Yeah, I asked question before I notice your PR :)

@pkuczynski pkuczynski added this to the rvm-1.29.3 milestone Jul 2, 2017
@pkuczynski
Copy link
Member

#4052 adds more clarity to files created by RVM. We could implement the logic of recognizing which shell is installed in the system, but I am not sure if that's worth the effort. Now if you would install new shell after installing RVM, it would work out of the box. Otherwise, user after installing a shell would have to run --auto-dotfiles again. Both have pros and cons, so honestly, I would leave it as it is for now...

@pkuczynski pkuczynski self-assigned this Jul 2, 2017
@ghost
Copy link
Author

ghost commented Jul 3, 2017

Thanks for all your work to make this acceptably robust!

@pkuczynski pkuczynski modified the milestones: rvm-1.29.3, rvm-1.29.4 Sep 14, 2017
@pkuczynski pkuczynski modified the milestones: rvm-1.29.4, rvm-1.29.5 Sep 23, 2018
@pkuczynski pkuczynski modified the milestones: rvm-1.29.5, rvm-1.29.7 Dec 12, 2018
@pkuczynski pkuczynski modified the milestones: rvm-1.29.7, rvm-1.29.8 Jan 3, 2019
@pkuczynski pkuczynski modified the milestones: rvm-1.29.8, rvm-1.29.9 May 8, 2019
@pkuczynski pkuczynski modified the milestones: rvm-1.29.9, rvm-1.29.10 Jul 10, 2019
@pkuczynski pkuczynski modified the milestones: rvm-1.29.10, rvm-1.29.11 Mar 25, 2020
@pkuczynski pkuczynski modified the milestones: rvm-1.29.11, rvm-1.29.12 Dec 29, 2020
@pkuczynski pkuczynski modified the milestones: rvm-1.29.12, rvm-1.29.13 Jan 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pkuczynski pkuczynski

Labels
feature
Projects
None yet
Milestone
rvm-1.29.13
Development

Successfully merging a pull request may close this issue.

Improve clarity of dotfile edits
1 participant
@pkuczynski