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

update-alternatives: add page #1544

Merged
merged 7 commits into from
Oct 24, 2017
Merged

update-alternatives: add page #1544

merged 7 commits into from
Oct 24, 2017

Conversation

maxsxu
Copy link
Collaborator

@maxsxu maxsxu commented Oct 13, 2017 •
edited
Loading

  • The page (if new), does not already exist in the repo.

  • The page (if new), has been added to the correct platform folder:
    common/ if it's common to all platforms, linux/ if it's Linux-specific, and so on.

  • The page has 8 or fewer examples.

  • The PR is appropriately titled:
    <command name>: add page for new pages, or <command name>: <description of changes> for pages being edited

  • The page follows the contributing guidelines

sbrl
sbrl reviewed Oct 13, 2017
View reviewed changes
Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

1000 yeses! I was wondering what the command was that did this 😺 Thanks for the page! I've left a few comment about a few minor readability-realted things.

pages/linux/update-alternatives.md Outdated
@@ -0,0 +1,19 @@
# update-alternatives

> A convenient tool for maintaining symbolic links determining default commands.
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps determining should be that determine?

pages/linux/update-alternatives.md Outdated

`sudo update-alternatives --install /usr/bin/java java /opt/java/jdk1.8.0_102/bin/java 300`

- Config a symbolic link:
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps expanding Config to Configure would read better?

pages/linux/update-alternatives.md Outdated

`sudo update-alternatives --remove java /usr/bin/java`

- Display information about the link group:
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps about the link group would read better as about the specified link group?

@agnivade agnivade added the new command Issues requesting creation of a new page. label Oct 14, 2017
agnivade
agnivade requested changes Oct 15, 2017
View reviewed changes
pages/linux/update-alternatives.md Outdated
@@ -0,0 +1,19 @@
# update-alternatives

> A convenient tool for maintaining symbolic links that determining default commands.
Copy link
Member

Choose a reason for hiding this comment

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

Umm the grammar got messed up a bit. I think @sbrl was trying to say "that determines". I actually prefer "to determine".

What do you say @sbrl ?

Copy link
Member

Choose a reason for hiding this comment

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

Hrm, it has a bit! Yeah, it's a rather awkward situation here actually. I'd be happy with either "that determine" or "to determine".

pages/linux/update-alternatives.md Outdated

> A convenient tool for maintaining symbolic links that determining default commands.

- Add a symbolic link:
Copy link
Member

Choose a reason for hiding this comment

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

Since all your examples are java based, we should mention this at the start. Then it will be implied. So I suggest - Add a symbolic link for "java"

Copy link
Member

Choose a reason for hiding this comment

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

I didnt want you to remove all concrete examples with their generic counterparts 😄. Those are fine. Just change the description to Add a symbolic link for "java" with a priority of "300"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, but I think a more generic expression maybe better. Or can we add a generic expression and a concrete examples

Copy link
Member

Choose a reason for hiding this comment

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

We try to put concrete examples instead of generic ones so that beginners can have a better idea as to how the command is used. If you want, we can start with a generic example and then have concrete ones after that.

pages/linux/update-alternatives.md Outdated

- Add a symbolic link:

`sudo update-alternatives --install /usr/bin/java java /opt/java/jdk1.8.0_102/bin/java 300`
Copy link
Member

Choose a reason for hiding this comment

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

Please wrap the parameters in tokens. Also, what does 300 stand for ?

pages/linux/update-alternatives.md Outdated

`sudo update-alternatives --remove java /usr/bin/java`

- Display information about the specified link group:
Copy link
Member

Choose a reason for hiding this comment

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

What is meant by a link group here ?

agnivade
agnivade requested changes Oct 22, 2017
View reviewed changes
pages/linux/update-alternatives.md Outdated
@@ -1,19 +1,19 @@
# update-alternatives

> A convenient tool for maintaining symbolic links that determining default commands.
> A convenient tool for maintaining symbolic links to determin default commands.
Copy link
Member

Choose a reason for hiding this comment

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

=> determine

pages/linux/update-alternatives.md Outdated

> A convenient tool for maintaining symbolic links that determining default commands.

- Add a symbolic link:
Copy link
Member

Choose a reason for hiding this comment

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

I didnt want you to remove all concrete examples with their generic counterparts 😄. Those are fine. Just change the description to Add a symbolic link for "java" with a priority of "300"

maxsxu added 2 commits October 23, 2017 12:09
@maxsxu
Update update-alternatives.md
5c9ab17
@maxsxu
Update update-alternatives.md
1d7ad86 
Add both generic expression and a concrete examples.
@tldr-bot
Copy link

The build for this PR has failed with the following error(s):

pages/linux/update-alternatives.md:9: TLDR005 Example descriptions should end in a colon

Please fix the error(s) and push again.

@agnivade
Copy link
Member

@jsonbruce I made some slight modifications of my own which I believe clarifies some things better. Please let me know your thoughts on it.

maxsxu
maxsxu commented Oct 24, 2017
View reviewed changes
Copy link
Collaborator Author

@maxsxu maxsxu left a comment

Choose a reason for hiding this comment

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

Yes, It's better.

@sbrl sbrl merged commit c98b4dc into tldr-pages:master Oct 24, 2017
@sbrl
Copy link
Member

sbrl commented Oct 24, 2017

Thanks for sticking with the review process, @jsonbruce! 😺

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sbrl sbrl sbrl approved these changes

@agnivade agnivade agnivade approved these changes

Assignees
No one assigned
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@maxsxu @tldr-bot @agnivade @sbrl