Basic networking in Networking Guide, terminology

Bug #1515552 reported by martin_gm
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Low
Randy Perryman

Bug Description

On http://docs.openstack.org/networking-guide/intro_basic_networking.html it says:
"In an Ethernet network, the hosts connected to the network communicate by exchanging frames, which is the Ethernet terminology for packets."

This is not entirely correct. "Frame" is the OSI terminology for a protocol data unit (PDU) on layer 2. "Packets" is the OSI terminology for PDUs on layer 3. Since the text leading up to the quoted passage is about the OSI model, its layers and how Ethernet may/does fit in there, and the entire page is about protocols on various OSI layers and intended to teach people about these, this difference in terminology matters and ought to be corrected.

Frames and packets are clearly distinguishable. Mushing their meanings and even implying they are the same thing does not help this article and can be confusing, as both, layer 2 and layer 3 are discussed on this page.

-----------------------------------
Release: 0.9 on 2015-11-12 08:10
SHA: 3de94056cb1c87983c19d93ecff71c695b98078e
Source: http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/networking-guide/source/intro_basic_networking.rst
URL: http://docs.openstack.org/networking-guide/intro_basic_networking.html

Revision history for this message
Matt Kassawara (ionosphere80) wrote :

Makes sense. Much of this content needs help. :)

Changed in openstack-manuals:
status: New → Triaged
importance: Undecided → Low
milestone: none → mitaka
Revision history for this message
Randy Perryman (randy-perryman) wrote :

So looking at the document, it looks just removing the line: "which is the Ethernet terminology for packets." would correct the usage, as it is not referred to anywhere else in the article.

Revision history for this message
Randy Perryman (randy-perryman) wrote :

if that is acceptable, I will submit a patch for that.

Matt Dorn (madorn)
Changed in openstack-manuals:
assignee: nobody → Matt Dorn (madorn)
Changed in openstack-manuals:
assignee: Matt Dorn (madorn) → Randy Perryman (randy-perryman)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (master)

Fix proposed to branch: master
Review: https://review.openstack.org/246589

Changed in openstack-manuals:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (master)

Reviewed: https://review.openstack.org/246589
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=4f7e372302bf96d3549799f3b24a3273f8fb372b
Submitter: Jenkins
Branch: master

commit 4f7e372302bf96d3549799f3b24a3273f8fb372b
Author: Randy Perryman <email address hidden>
Date: Tue Nov 17 16:43:01 2015 -0500

    Remove inaccurate OSI Model reference

    Updates to remove calling packets equal to frames. The OSI Model has them at
    two different layers and thus this reference was inaccurate.

    Closes-Bug: #1515552

    Change-Id: Ia828e3e8d8100a878b6e41ba4f80a24bf5e7d589

Changed in openstack-manuals:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (stable/liberty)

Fix proposed to branch: stable/liberty
Review: https://review.openstack.org/263382

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (stable/liberty)

Reviewed: https://review.openstack.org/263382
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=8627a97656ff35152e2061a12f80c2c896deb453
Submitter: Jenkins
Branch: stable/liberty

commit 8627a97656ff35152e2061a12f80c2c896deb453
Author: Randy Perryman <email address hidden>
Date: Tue Nov 17 16:43:01 2015 -0500

    Remove inaccurate OSI Model reference

    Updates to remove calling packets equal to frames. The OSI Model has them at
    two different layers and thus this reference was inaccurate.

    Closes-Bug: #1515552

    Change-Id: Ia828e3e8d8100a878b6e41ba4f80a24bf5e7d589
    (cherry picked from commit 4f7e372302bf96d3549799f3b24a3273f8fb372b)

tags: added: in-stable-liberty
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/openstack-manuals 15.0.0

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.