Test that glossary is sorted

Test that glossary entries are sorted and fail the niceness test if not.

Sort those entries that were not sorted.

Change-Id: I40eec5e6132bd79899456de505406ac2fa4ca32f
This commit is contained in:
Andreas Jaeger 2016-11-14 16:33:49 +01:00
parent beebfa6bca
commit d4f58113f9
3 changed files with 49 additions and 24 deletions

View File

@ -2009,13 +2009,6 @@ I
over IP networks.
Supported by Compute, Object Storage, and Image service.
ip6tables
Tool used to set up, maintain, and inspect the tables of IPv6
packet filter rules in the Linux kernel. In OpenStack Compute,
ip6tables is used along with arptables, ebtables, and iptables to
create firewalls for both nodes and VMs.
IP address
Number that is unique to every computer system on the Internet.
@ -2028,6 +2021,13 @@ I
and management. Currently provided by Compute, melange, and
Networking.
ip6tables
Tool used to set up, maintain, and inspect the tables of IPv6
packet filter rules in the Linux kernel. In OpenStack Compute,
ip6tables is used along with arptables, ebtables, and iptables to
create firewalls for both nodes and VMs.
ipset
Extension to iptables that allows creation of firewall rules
@ -2162,6 +2162,11 @@ L
The collaboration site for OpenStack.
Layer-2 (L2) agent
OpenStack Networking agent that provides layer-2
connectivity for virtual networks.
Layer-2 network
Term used in the OSI network architecture for the data link
@ -2169,10 +2174,10 @@ L
control, flow control and detecting and possibly correcting
errors that may occur in the physical layer.
Layer-2 (L2) agent
Layer-3 (L3) agent
OpenStack Networking agent that provides layer-2
connectivity for virtual networks.
OpenStack Networking agent that provides layer-3
(routing) services for virtual networks.
Layer-3 network
@ -2180,11 +2185,6 @@ L
layer. The network layer is responsible for packet
forwarding including routing from one node to another.
Layer-3 (L3) agent
OpenStack Networking agent that provides layer-3
(routing) services for virtual networks.
Liberty
The code name for the twelfth release of OpenStack. The
@ -2229,16 +2229,16 @@ L
systems or services, based on the criteria defined as part of its
configuration.
Load-Balancer-as-a-Service (LBaaS)
Enables Networking to distribute incoming requests evenly
between designated instances.
load balancing
The process of spreading client requests between two or more
nodes to improve performance and availability.
Load-Balancer-as-a-Service (LBaaS)
Enables Networking to distribute incoming requests evenly
between designated instances.
Logical Volume Manager (LVM)
Provides a method of allocating space on mass-storage
@ -2350,15 +2350,15 @@ M
scalable and highly available manner, and to create and maintain
associated Python libraries and documentation.
Meta-Data Server (MDS)
Stores CephFS metadata.
Metadata agent
OpenStack Networking agent that provides metadata
services for instances.
Meta-Data Server (MDS)
Stores CephFS metadata.
migration
The process of moving a VM instance from one host to

24
tools/glossary-sort.sh Executable file
View File

@ -0,0 +1,24 @@
#!/bin/bash -xe
# Check that doc/common/glossary entries are alphabetized and prints
# list of entries that should be sorted.
export TMPDIR=`/bin/mktemp -d`
trap "rm -rf $TMPDIR" EXIT
pushd $TMPDIR
GLOSSARY=$OLDPWD/doc/common/glossary.rst
grep '^ [a-zA-Z]' $GLOSSARY > glossary_entries
LC_ALL=C sort --ignore-case glossary_entries -o glossary_entries.sorted
if ! diff glossary_entries glossary_entries.sorted > glossary_entries.diff; then
echo "The following entries should be alphabetized: "
cat glossary_entries.diff | grep -e '> '
exit 1
else
echo "Glossary alphabetized."
fi
popd

View File

@ -27,6 +27,7 @@ commands =
flake8
doc8 doc
bash -c "find doc -type f -regex '.*\.pot?' -print0|xargs -0 -n 1 msgfmt --check-format -o /dev/null"
{toxinidir}/tools/glossary-sort.sh
[testenv:checkbuild]
commands =