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

Update v1 and v2 network config docs to clarify MAC addresses #623

Merged
merged 3 commits into from
Oct 27, 2020

Conversation

dermotbradley
Copy link
Contributor

Proposed Commit Message

Update v1 and v2 network config docs to clarify when MAC addresses should be quoted.

Also update MAC addresses used in testcases to remove quotes where not
required and add single quotes where quotes are required.

Additional Context

MAC addresses consisting of only 0-9 digits may be misintepreted as YAML Base 60 numbers if not quoted.

See YAML reference for definition of a Base 60 number.

Test Steps

Existing testcases are adequate.

Checklist:

  • My code follows the process laid out in the documentation
  • I have updated or added any unit tests accordingly
  • I have updated or added any documentation accordingly

Copy link
Collaborator

@OddBloke OddBloke left a comment

Choose a reason for hiding this comment

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

Thanks for chasing this all down, Dermot, it's been quite the adventure! If we're ever at a conference together, I owe you 00:00:00:00:00:01 beverages of your choosing. (I have a couple of thoughts inline.)

doc/rtd/topics/network-config-format-v1.rst Outdated Show resolved Hide resolved
doc/rtd/topics/network-config-format-v1.rst Outdated Show resolved Hide resolved
…ould

be quoted.

Also update MAC addresses used in testcases to remove quotes where not
required and add single quotes where quotes are required.
Copy link
Collaborator

@igalic igalic left a comment

Choose a reason for hiding this comment

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

🙋🏻‍♀️

doc/rtd/topics/network-config-format-v1.rst Show resolved Hide resolved
Copy link
Collaborator

@OddBloke OddBloke left a comment

Choose a reason for hiding this comment

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

LGTM, with one minor formatting issue. I'll apply that fix then land this. Thank you!

doc/rtd/topics/network-config-format-v1.rst Outdated Show resolved Hide resolved
@OddBloke OddBloke merged commit f50f635 into canonical:master Oct 27, 2020
@dermotbradley dermotbradley deleted the correct_mac_address_docs branch November 18, 2020 18:18
This was referenced May 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants