Skip to content

Add comment to explain .bashrc vs .bash_profile #11849

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
Merged
merged 4 commits into from
Oct 24, 2022
Merged

Add comment to explain .bashrc vs .bash_profile #11849

merged 4 commits into from
Oct 24, 2022

Conversation

pavelzw
Copy link
Member

@pavelzw pavelzw commented Sep 15, 2022 •
edited
Loading

Description

This PR adds a comment explaining why .bashrc gets modified on Linux and why .bash_profile gets modified on macOS + Windows instead when executing conda init.

Closes #11830

Checklist - did you ...

  • Add a file to the news directory (using the template) for the next release's release notes?
  • Add / update necessary tests?
  • Add / update outdated documentation?

@pavelzw pavelzw requested a review from a team as a code owner September 15, 2022 17:24
@conda-bot
Copy link
Contributor

We require contributors to sign our Contributor License Agreement and we don't have one on file for @pavelzw.

In order for us to review and merge your code, please e-sign the Contributor License Agreement PDF. We then need to manually verify your signature. We will ping the bot to refresh the PR status when we have confirmed your signature.

@pavelzw
Copy link
Member Author

pavelzw commented Sep 15, 2022

One could also add this comment to the end-user facing documentation of conda init (here). But I think this would be a bit too much and bloat the documentation page. What do you think?

@pavelzw pavelzw force-pushed the document-bashrc-bashprofile branch from 8fcc5b0 to b592df0 Compare September 24, 2022 14:27
@conda-bot conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Sep 24, 2022
@pavelzw
Copy link
Member Author

pavelzw commented Sep 24, 2022

@travishathaway this is ready for review, can you please take a look at it?

ForgottenProgramme
ForgottenProgramme reviewed Sep 29, 2022
View reviewed changes
Copy link
Contributor

@ForgottenProgramme ForgottenProgramme left a comment

Choose a reason for hiding this comment

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

@pavelzw, thank you for opening this PR! :)
The comments look good. Could you please put them in a function docstring?

@pavelzw
Copy link
Member Author

pavelzw commented Sep 29, 2022

@ForgottenProgramme

Could you please put them in a function docstring?

Done. I also moved this comment in the docstring for consistency.

@jonashaag jonashaag mentioned this pull request Sep 30, 2022
Closed
@pavelzw pavelzw force-pushed the document-bashrc-bashprofile branch from 3c33f00 to acb5196 Compare October 4, 2022 17:52
kenodegard
kenodegard reviewed Oct 4, 2022
View reviewed changes
@pavelzw pavelzw mentioned this pull request Oct 9, 2022
Merged
@pavelzw
Copy link
Member Author

pavelzw commented Oct 23, 2022

@kenodegard is there still something for me to do for this PR to be merged?

@kenodegard kenodegard merged commit dc2c296 into conda:main Oct 24, 2022
@kenodegard
Copy link
Contributor

@pavelzw hm no idea why I didn't merge this earlier, thanks for poking me

@pavelzw pavelzw deleted the document-bashrc-bashprofile branch October 24, 2022 16:15
jeskowagner pushed a commit to jeskowagner/conda that referenced this pull request Nov 9, 2022
@pavelzw @jeskowagner
Add comment to explain .bashrc vs .bash_profile (conda#11849)
a094c06
@github-actions github-actions bot added the locked [bot] locked due to inactivity label Oct 25, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ForgottenProgramme ForgottenProgramme ForgottenProgramme left review comments

@kenodegard kenodegard kenodegard approved these changes

Assignees
No one assigned
Labels
cla-signed [bot] added once the contributor has signed the CLA locked [bot] locked due to inactivity
Projects
🧭 Planning
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Why is the conda initialize block placed in .bashrc on Linux, but in .bash_profile on macOS + Windows?
4 participants
@pavelzw @conda-bot @kenodegard @ForgottenProgramme