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

microcom: add page #1538

Merged
merged 2 commits into from
Oct 13, 2017
Merged

microcom: add page #1538

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d924394
microcom: add page
fluxw42 Oct 9, 2017
94e2496
microcom: Fix various review comments
fluxw42 Oct 11, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
microcom: add page
  • Loading branch information
@fluxw42
fluxw42 committed Oct 9, 2017
commit d9243947c526a03da6054202f0a2b99e8a5ba3dc
11 changes: 11 additions & 0 deletions pages/linux/microcom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.


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


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


- 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!

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 •
edited
Loading

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.


`microcom --telnet {{hostname}}:{{port}}`