-
Notifications
You must be signed in to change notification settings - Fork 381
Proofread docs in the /operation directory #1710
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
Open
teslazonda
wants to merge
15
commits into
vyos:current
Choose a base branch
from
teslazonda:docs/proofread-docs-in-operation-directory
base: current
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
eeed7e8
Proofread boot-options.rst
teslazonda 4d123fd
Fix line length Markdown lint errors
teslazonda 60be5b9
Proofread information.rst
teslazonda af8b272
Update lastproofread date in information.rst
teslazonda 99752f4
Updated password-recovery.rst
teslazonda f642b7f
Proofread upgrade-recovery.rst
teslazonda 75908d2
Fix line length linting errors
teslazonda fa666f4
Proofread up to Empty 2+ Disk
teslazonda d3c88bd
Complete proofread of raid.rst
teslazonda fcf95c0
Update upgrade-recovery timeout explanation
teslazonda c22d0a3
Fix header formatting
teslazonda 786eb2e
Update docs/operation/boot-options.rst
teslazonda 1510dfd
Add missing period in raid.rst
teslazonda 024659b
Implement Copilot feedback
teslazonda 18949d8
Update capitalization in information.rst
teslazonda File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,14 @@ | ||
| :lastproofread: 2021-07-07 | ||
| :lastproofread: 2025-11-19 | ||
|
|
||
| .. _information: | ||
|
|
||
| *********** | ||
| Information | ||
| System Information | ||
| *********** | ||
|
|
||
| VyOS features a rich set of operational level commands to retrieve arbitrary | ||
| information about your running system. | ||
| information about your running system. For more information on the VyOS command | ||
| line interface (CLI), see :ref:`cli`. | ||
|
|
||
| ######## | ||
| Hardware | ||
|
|
@@ -18,27 +19,29 @@ Hardware | |
| USB | ||
| === | ||
|
|
||
| In the past serial interface have been defined as ttySx and ttyUSBx where x was | ||
| an instance number of the serial interface. It was discovered that from system | ||
| boot to system boot the mapping of USB based serial interfaces will differ, | ||
| depending which driver was loaded first by the operating system. This will | ||
| become rather painful if you not only have serial interfaces for a console | ||
| server connected but in addition also a serial backed :ref:`wwan-interface`. | ||
| In the past, serial interfaces were defined as ``ttySx`` and ``ttyUSBx`` where | ||
| ``x`` | ||
| was the instance number. However, the mapping of USB-based serial interfaces | ||
teslazonda marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| can change from one system boot to another, depending on which driver the | ||
| operating system loads first. This inconsistency can be problematic when you | ||
| use multiple serial interfaces. | ||
| For example, both console-server connections and a serial-backed | ||
| :ref:`wwan-interface`. | ||
|
|
||
| To overcome this issue and the fact that in almost 50% of all cheap USB to | ||
| serial converters there is no serial number programmed, the USB to serial | ||
| interface is now directly identified by the USB root bridge and bus it connects | ||
| to. This somehow mimics the new network interface definitions we see in recent | ||
| Linux distributions. | ||
| To address this issue, and because of many low-cost USB-to-serial converters | ||
teslazonda marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| do not have a programmed serial number, VyOS now identifies USB-to-serial | ||
| interfaces by the USB root bridge and the bus they connect to. | ||
| This approach is similar to the network interface naming conventions used in | ||
| recent Linux distributions. | ||
|
|
||
| For additional details you can refer to https://vyos.dev/T2490. | ||
| For details, see https://vyos.dev/T2490. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This issue was resolved in 2020. Is the above content still relevant? |
||
|
|
||
| .. opcmd:: show hardware usb | ||
|
|
||
| Retrieve a tree like representation of all connected USB devices. | ||
| Retrieve a tree-like representation of all connected USB devices. | ||
|
|
||
| .. note:: If a device is unplugged and re-plugged it will receive a new | ||
| Port, Dev, If identification. | ||
| .. note:: If a device is unplugged and plugged in again, it is assigned a new | ||
| ``Port``, ``Dev``, and ``If``. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What do |
||
|
|
||
| .. code-block:: none | ||
|
|
||
|
|
@@ -72,8 +75,8 @@ For additional details you can refer to https://vyos.dev/T2490. | |
| .. opcmd:: show hardware usb serial | ||
|
|
||
| Retrieve a list and description of all connected USB serial devices. The | ||
| device name displayed, e.g. `usb0b2.4p1.0` can be directly used when accessing | ||
| the serial console as console-server device. | ||
| device name displayed, (for example ``usb0b2.4p1.0``), can be used | ||
| directly when accessing the serial console as console-server device. | ||
|
|
||
| .. code-block:: none | ||
|
|
||
|
|
@@ -105,9 +108,9 @@ Version | |
|
|
||
| .. opcmd:: show version | ||
|
|
||
| Return the current running VyOS version and build information. This includes | ||
| also the name of the release train which is ``crux`` on VyOS 1.2, ``equuleus`` | ||
| on VyOS 1.3 and ``sagitta`` on VyOS 1.4. | ||
| Return the currently running VyOS version and build information. This includes | ||
| the name of the release train, which is ``crux`` on VyOS 1.2, ``equuleus`` | ||
| on VyOS 1.3, ``sagitta`` on VyOS 1.4, and ``circinus`` on VyOS 1.5. | ||
|
|
||
| .. code-block:: none | ||
|
|
||
|
|
@@ -134,7 +137,7 @@ Version | |
|
|
||
| .. opcmd:: show version kernel | ||
|
|
||
| Return version number of the Linux Kernel used in this release. | ||
| Return the version number of the currently running Linux kernel. | ||
|
|
||
| .. code-block:: none | ||
|
|
||
|
|
@@ -143,7 +146,7 @@ Version | |
|
|
||
| .. opcmd:: show version frr | ||
|
|
||
| Return version number of FRR (Free Range Routing - https://frrouting.org/) | ||
| Return the version number of FRR (Free Range Routing - https://frrouting.org/) | ||
| used in this release. This is the routing control plane and a successor to GNU | ||
| Zebra and Quagga. | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.