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

microcom: add page #1538

Merged
merged 2 commits into from
Oct 13, 2017
Merged

microcom: add page #1538

merged 2 commits into from
Oct 13, 2017

Conversation

fluxw42
Copy link
Contributor

@fluxw42 fluxw42 commented Oct 9, 2017

I noticed the microcom tool was missing from tldr. It's not a complicated tool, so the number of examples is limited.


  • 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

Siteproxy
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.

Great find! Thanks for the page. I've just got a few comments for you to review.


> A minimalistic terminal program.

- Open a serial port using the specified baudrate:
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps baudrate could be baud rate?

Copy link
Member

Choose a reason for hiding this comment

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

Not a question of perhaps, it must be 😆

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, you're right: The correct term is baud rate, two words. Fixed.

@@ -0,0 +1,11 @@
# microcom

> A minimalistic terminal program.
Copy link
Member

Choose a reason for hiding this comment

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

This description, while short and to the point, can be a little confusing (I know it's a program that runs in the terminal, but what does it do?). Perhaps it could be expanded to incorporate the fact that it talks to connected devices via a serial connection?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'v expanded the description to make it clear that microcom is used to connect to other devices trough a serial, CAN or telnet connection.


`microcom --port {{path/to/serial-port}} --speed {{baudrate}}`

- Establish a telnet connection (rfc2217) to the specified host:
Copy link
Member

Choose a reason for hiding this comment

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

It does telnet too? Cool!


- Open a serial port using the specified baudrate:

`microcom --port {{path/to/serial-port}} --speed {{baudrate}}`
Copy link
Member

Choose a reason for hiding this comment

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

serial-port => serial_port
baudrate => baud_rate

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"Use snake_case for multi-word tokens."

Jep, my bad. It's even in the CONTRIBUTING.md file, but I've skimmed right over it. Fixed.


`microcom --port {{path/to/serial-port}} --speed {{baudrate}}`

- Establish a telnet connection (rfc2217) to the specified host:
Copy link
Member

Choose a reason for hiding this comment

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

We can remove the rfc number. I think the word telnet is ubiquitous enough.

Copy link
Contributor Author

@fluxw42 fluxw42 Oct 11, 2017

Choose a reason for hiding this comment

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

Reference to the telnet rfc is gone.

 - Expand the description to prevent confusion
 - Use 'baud rate' instead of baudrate
 - Replace '-' chars in example parameter values with '_'
 - Remove the telnet RFC number
@agnivade agnivade added the new command Issues requesting creation of a new page. label Oct 12, 2017
@sbrl sbrl merged commit db3c089 into tldr-pages:master Oct 13, 2017
@sbrl
Copy link
Member

sbrl commented Oct 13, 2017

Thanks, @fluxw42! 😺

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

3 participants