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.

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

port: add page #1499

Merged
merged 4 commits into from
Oct 6, 2017
Merged

port: add page #1499

merged 4 commits into from
Oct 6, 2017

Conversation

personalnadir
Copy link
Contributor

Proposed page for mac ports port cli.


  • 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

Proposed page for mac ports port cli.
@CLAassistant
Copy link

CLAassistant commented Sep 19, 2017

CLA assistant check
All committers have signed the CLA.

@tldr-bot
Copy link

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

pages/osx/port.md:3: TLDR003 Descriptions should start with a capital letter
pages/osx/port.md:3: TLDR004 Command descriptions should end in a period

Please fix the error(s) and push again.


> Package manager for macOS.

- Search for package:
Copy link
Member

Choose a reason for hiding this comment

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

"a" package


`port search {{search_term}}`

- Install package:
Copy link
Member

Choose a reason for hiding this comment

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

"a" package


`port installed`

- Update ports tree:
Copy link
Member

Choose a reason for hiding this comment

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

Might be better to remove "tree". How about -

Update `port` to the latest version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good point. I think it still needs to refer to the update to the tree in some form though as that's its most common use-case. How about something like:

Update port and fetch latest list of available packages

Copy link
Member

Choose a reason for hiding this comment

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

Maybe I don't understand clearly, what exactly do you mean by "tree" here ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The port tree is what Mac Ports refers to the list of packages as. From their documentation for this command: "The local ports tree is a collection of files that contain information on which packages are available through MacPorts and how they can be installed. You should regularly update your ports tree to get access to updated versions of software and bug fixes. To do that, use selfupdate"

port selfupdate also upgrades the port program as well if a new version is available. The output looks something like:

MacPorts base version 2.4.1 installed,
MacPorts base version 2.4.1 downloaded.
--->  Updating the ports tree
--->  MacPorts base is already the latest version

The ports tree has been updated. To upgrade your installed ports, you should run
  port upgrade outdated

Copy link
Member

Choose a reason for hiding this comment

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

Ah, got it. Then I think its better to avoid jargon and go with simple words. Your suggestion works fine -

Update port and fetch latest list of available packages

@agnivade agnivade added the new command Issues requesting creation of a new page. label Sep 19, 2017
Also improved selfupdate command description
@@ -0,0 +1,27 @@
# port

> Package manager for macOS.
Copy link
Member

Choose a reason for hiding this comment

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

So port is macOS's primary package manager?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, there's also Homebrew which has its brew command already in the TLDR pages. I took that line directly from the brew page. I think port is the more venerable of the two.

Copy link
Member

Choose a reason for hiding this comment

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

Ah, ok 😺

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, forgot I hadn't made that change, just added it now


`sudo port upgrade outdated`

- Remove inactive package versions:
Copy link
Member

Choose a reason for hiding this comment

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

What does inactive mean in this context?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

port does not remove older versions of installed packages after an upgrade, so in case an update goes wrong you can revert to the already installed versions. These older versions are referred to as inactive by the command.

Perhaps obsolete or superseded might be clearer? Or something like:

- Remove old versions of installed packages

Copy link
Member

Choose a reason for hiding this comment

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

Ah, I see. Yeah, that's a much better way of putting it 😺

@stale
Copy link

stale bot commented Oct 5, 2017

Hi all! This thread has not had any recent activity. Are there any updates? Thanks!

@stale stale bot added the waiting Issues/PRs with Pending response by the author. label Oct 5, 2017
Changed text for uninstall inactive
@stale stale bot removed the waiting Issues/PRs with Pending response by the author. label Oct 6, 2017
@sbrl sbrl merged commit 5291f53 into tldr-pages:master Oct 6, 2017
@sbrl
Copy link
Member

sbrl commented Oct 6, 2017

Thanks, @personalnadir 😺

@personalnadir personalnadir deleted the patch-2 branch October 16, 2017 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants