acronym glossary

_static/css/rtd_theme_mods.css

@@ -72,6 +72,12 @@ h3 {
     font-style: italic;
     font-weight: bold;
 }
+/* Single-column index */
+.genindextable td {
+  width: 100% !important;
+  display: block;
+}
+
 aside.sidebar {
     margin: 0 0 0.5em 1em;
     border: 1px solid #ddb;

_templates/genindex.html

@@ -0,0 +1,32 @@
+{%- extends "layout.html" %}
+{% set title = 'Acronym Glossary' %}
+
+{% block body %}
+
+<h1 id="index">Acronym Glossary</h1>
+
+This glossary expands the network-related acronyms used throughout the
+book, and links the section that gives the best introduction to the
+term. Use the "Search" facility for an exhaustive index of all uses.
+<p>
+
+<div class="genindex-jumpbox">
+ {% for key, dummy in genindexentries -%}
+ <a href="#{{ key }}"><strong>{{ key }}</strong></a>
+ {% if not loop.last %}| {% endif %}
+ {%- endfor %}
+</div>
+
+{%- for key, entries in genindexentries %}
+<h2 id="{{ key }}">{{ key }}</h2>
+<ul>
+  {%- for entryname, (links, subitems, _) in entries %}
+  <li>
+    {%- if links %}<a href="{{ links[0][1] }}">{{ entryname|e }}</a>
+    {%- else %}{{ entryname|e }}{% endif %}
+  </li>
+  {%- endfor %}
+</ul>
+{% endfor %}
+
+{% endblock %}

_templates/layout.html

@@ -0,0 +1,9 @@
+{% extends "!layout.html" %}
+{% block navigation %}
+{{ super() }}
+<div class="wy-menu wy-menu-vertical" role="navigation">
+  <ul>
+    <li class="toctree-l1"><a class="reference internal" href="{{ pathto('genindex') }}">Acronym Glossary</a></li>
+  </ul>
+</div>
+{% endblock %}

applications/anatomy.rst

@@ -1,3 +1,5 @@
+.. index:: IXP: Internet Exchange Point
+
 2.1 Anatomy of an Application
 ---------------------------------------
 

applications/dash.rst

@@ -1,4 +1,4 @@
-.. _artifact-dash:
+.. index:: DASH: Dynamic Adaptive Streaming over HTTP
 
 2.4 Adaptive Streaming
 -------------------------------

applications/email.rst

@@ -1,3 +1,8 @@
+.. index:: MIME: Multipurpose Internet Mail Extensions
+.. index:: IMAP: Internet Message Access Protocol
+.. index:: SMTP: Simple Mail Transfer Protocol
+.. index:: POP3: Post Office Protocol version 3
+
 2.3 Electronic Mail
 ----------------------------------------
 
@@ -193,8 +198,6 @@ contains various pieces, each denoted by a character string that does
 not appear in the data itself. Each piece then has its own
 ``Content-Type`` and ``Content-Transfer-Encoding`` lines.
 
-.. _artifact-smtp:
-
 2.3.2 Message Transfer
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -332,8 +335,6 @@ was not always the case. In the days before everyone was connected to
 the Internet, it was not uncommon to see email addresses of the form
 ``user%host@site!neighbor``.
 
-.. _artifact-pop3:
-
 2.3.3 Mail Reader
 ~~~~~~~~~~~~~~~~~
 

applications/web.rst

@@ -1,3 +1,7 @@
+.. index:: HTTP/HTTPS: Hypertext Transfer Protocol
+.. index:: REST/RESTful: Representational State Transfer
+.. index:: ISP: Internet Service Provider
+
 2.2 World Wide Web
 -----------------------------
 
@@ -11,7 +15,6 @@ protocol—HTTP—underpinning it. In this section we dig into the details
 of that protocol, and in doing so, tease out the reasons the web has
 become such a ubiquitous framework for building new applications.
 
-.. _artifact-http:
 
 2.2.1 Application Protocols
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

capacity/aqm.rst

@@ -1,3 +1,6 @@
+.. index:: RED: Random Early Detection
+.. index:: AQM: Active Queue Management
+
 |Capacity|.3  Active Queue Management
 -------------------------------------------
 

capacity/scheduler.rst

@@ -1,3 +1,8 @@
+.. index:: DSCP: DiffServ Code Point
+.. index:: FIFO: First-In First-Out
+.. index:: FQ/WFQ: Fair Queuing / Weighted Fair Queuing
+.. index:: DRR: Deficit Round Robin
+
 |Capacity|.2 Packet Schedulers
 --------------------------------
 

capacity/traffic.rst

@@ -1,3 +1,5 @@
+.. index:: TE: Traffic Engineering
+
 |Capacity|.5  Traffic Engineering
 -----------------------------------------
 

conf.py

@@ -135,7 +135,7 @@ def get_version():
 html_favicon = '_static/bridge.ico'
 
 # HTML Index
-html_use_index = False
+html_use_index = True
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

congestion/variants.rst

@@ -1,3 +1,5 @@
+.. index:: DCTCP: Data Center TCP
+
 |CC|.4  Domain-Specific Variants
 -------------------------------------------
 
@@ -19,8 +21,6 @@ described in a companion book.
    Systems Approach <https://tcpcc.systemsapproach.org>`__.
    May 2022.
 
-.. _artifact-dctcp:
-
 |CC|.4.1 Datacenter Networks
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

federation/hetero.rst

@@ -1,4 +1,6 @@
-.. _artifact-ipv4:
+.. index:: TTL: Time to Live
+.. index:: MTU: Maximum Transmission Unit
+.. index:: ARP: Address Resolution Protocol
 
 |Fed|.2 Heterogeneity
 ---------------------
@@ -516,8 +518,6 @@ by no means the last) in achieving scalability.
    packet to any node on a given network is represented by a single
    aggregated piece of information.
 
-.. _artifact-arp:
-
 |Fed|.2.4 Address Translation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

federation/scale.rst

@@ -1,3 +1,6 @@
+.. index:: NAT: Network Address Translation
+.. index:: IPv6: Internet Protocol version 6
+
 |Fed|.3 Scale
 -------------
 
@@ -319,8 +322,6 @@ frequently used forwarding entries; a fallback lookup algorithm is
 still needed.
 
 
-.. _artifact-nat:
-
 |Fed|.3.2 Network Address Translation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -442,8 +443,6 @@ adopted in 2015.
    <https://dl.acm.org/doi/10.1145/2766330.2766340>`__. ACM SIGCOMM
    CCR, April 2015.
 
-.. _artifact-ipv6:
-
 |Fed|.3.3 IP Version 6
 ~~~~~~~~~~~~~~~~~~~~~~
 

index.rst

@@ -14,6 +14,9 @@ Computer Networks: A Systems Approach
 Larry Peterson and Bruce Davie
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+|version|
++++++++++++++++++
+
 |
 
 
@@ -42,7 +45,6 @@ Larry Peterson and Bruce Davie
    message.rst
    overlay.rst
    stream.rst
-   appendix.rst
    README.rst
    authors.rst
    latest.rst

introduction/architecture.rst

@@ -1,3 +1,7 @@
+.. index:: IETF: Internet Engineering Task Force
+.. index:: OSI: Open Systems Interconnection
+.. index:: IP/IPv4: Internet Protocol (version 4)
+
 |Intro|.2  Network Architecture
 -------------------------------
 

introduction/protocols.rst

@@ -1,3 +1,7 @@
+.. index:: UDP: User Datagram Protocol
+.. index:: TCP: Transmission Control Protocol
+.. index:: RFC: Request for Comments
+
 |Intro|.3  Network Protocols
 ------------------------------------------
 

message/quic.rst

@@ -1,4 +1,4 @@
-.. _artifact-quic:
+
 
 |Message|.3 Optimizing RPC
 --------------------------

message/rdma.rst

@@ -1,4 +1,8 @@
-.. _artifact-rdma:
+.. index:: RDMA: Remote Direct Memory Access
+.. index:: MPI: Message Passing Interface
+.. index:: NCCL: NVIDIA Collective Communications Library
+.. index:: GPI: Global Address Space Programming Interface
+.. index:: OFI: Open Fabrics Interface
 
 |Message|.4 Remote DMA
 ----------------------------

message/roce.rst

@@ -1,4 +1,6 @@
-.. _artifact-roce:
+.. index:: RoCE: RDMA over Converged Ethernet
+.. index:: ECN: Explicit Congestion Notification
+.. index:: IPU: Infrastructure Processing Unit
 
 |Message|.5 Optimizing Ethernet for RDMA
 ------------------------------------------

message/rpc.rst

@@ -1,4 +1,6 @@
-.. _artifact-grpc:
+.. index:: RPC: Remote Procedure Call
+.. index:: gRPC: gRPC Remote Procedure Call
+.. index:: NFS: Network File System
 
 |Message|.2 Remote Procedure Call
 ---------------------------------
@@ -87,6 +89,7 @@ cloud services in their datacenters.
 .. sidebar:: RPC vs REST
 
    A false dichotomy...
+.. TODO finish this sidebar
 
 Despite its origins in Google, gRPC does not stand for Google RPC. The
 “g” stands for something different in each release. For version 1.10

naming/apps.rst

@@ -1,3 +1,10 @@
+.. index:: URI: Uniform Resource Identifier
+.. index:: URL: Uniform Resource Locator
+.. index:: URN: Uniform Resource Name
+.. index:: DOI: Digital Object Identifier
+.. index:: IANA: Internet Assigned Numbers Authority
+.. index:: LDAP: Lightweight Directory Access Protocol
+
 |Naming|.3 Application Naming Schemes
 --------------------------------------------
 

naming/dns.rst

@@ -1,4 +1,4 @@
-.. _artifact-dns:
+.. index:: DNS: Domain Name System
 
 |Naming|.2 Domain Naming System
 -------------------------------------------

operations/config.rst

@@ -1,3 +1,12 @@
+.. index:: SNMP: Simple Network Management Protocol
+.. index:: MIB: Management Information Base
+.. index:: XML: Extensible Markup Language
+.. index:: YAML: YAML Ain't Markup Language
+.. index:: gNMI: gRPC Network Management Interface
+.. index:: gNOI: gRPC Network Operations Interface
+.. index:: DHCP: Dynamic Host Configuration Protocol
+.. index:: YANG: Yet Another Next Generation
+
 |Ops|.2 Configuration Management
 --------------------------------------
 
@@ -13,8 +22,6 @@ illustrate the set of problems that need to be tackled and show some
 of the tools in widespread use, but this is necessarily a partial view
 of a broad landscape of operational tooling.
 
-.. _artifact-dhcp:
-
 |Ops|.2.1 Host Configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -128,8 +135,6 @@ address to its pool. A host with a leased address needs to renew the
 lease periodically if in fact it is still connected to the network and
 functioning correctly.
 
-.. _artifact-yang:
-
 |Ops|.2.2 Configuration Interface
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

operations/telemetry.rst

@@ -1,3 +1,6 @@
+.. index:: INT: Inband Network Telemetry
+.. index:: NDT: Network Diagnostic Tool
+
 |Ops|.3 Monitoring and Telemetry
 --------------------------------------
 

operations/velocity.rst

@@ -1,3 +1,5 @@
+.. index:: CI/CD: Continuous Integration / Continuous Deployment
+
 |Ops|.4 Feature Velocity
 --------------------------------------
 

overlay/cdn.rst

@@ -1,3 +1,6 @@
+.. index:: CDN: Content Distribution Network
+.. index:: DDoS: Distributed Denial of Service
+
 |Overlay|.2 Content Distribution Networks
 -----------------------------------------------