From decb4643d18adc0bfaa24a3cea3fe591eb495e9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20=C5=A0pa=C4=8Dek?= Date: Fri, 1 Jul 2022 16:48:02 +0200 Subject: [PATCH] Deduplicate definitions of address_match_list and address_match_element It would be better if it fit into the grammar glossary, but it is too long. A link must do. --- doc/arm/reference.rst | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index 45632a4d30..eb17d9b32a 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -201,12 +201,21 @@ Address Match Lists Syntax ^^^^^^ +Address Match List is a list of semicolor-separated :term:`address_match_element` s. + :: - address_match_list = address_match_list_element ; ... + { ; ... }; - address_match_list_element = [ ! ] ( ip_address | netprefix | - key server_key | acl_name | { address_match_list } ) +Each element is then defined as: + +.. glossary:: + + ``address_match_element`` + + :: + + [ ! ] ( | | key | | { address_match_list } ) Definition and Usage ^^^^^^^^^^^^^^^^^^^^ @@ -216,13 +225,13 @@ various server operations. They are also used in the :any:`listen-on` and :any:`sortlist` statements. The elements which constitute an address match list can be any of the following: -- an IP address (IPv4 or IPv6) +- :term:`ip_address`: an IP address (IPv4 or IPv6) -- an IP prefix (in ``/`` notation) +- :term:`netprefix`: an IP prefix (in ``/`` notation) -- a key ID, as defined by the ``key`` statement +- :term:`server_key`: a key ID, as defined by the ``key`` statement -- the name of an address match list defined with the :any:`acl` statement +- :term:`acl_name`: the name of an address match list defined with the :any:`acl` statement - a nested address match list enclosed in braces @@ -279,7 +288,7 @@ file documentation: The name of an :term:`address_match_list` as defined by the :any:`acl` statement. ``address_match_list`` - A list of one or more :term:`ip_address`, :term:`netprefix`, :term:`server_key`, or :term:`acl_name` elements; see :ref:`address_match_lists`. + See :ref:`address_match_lists`. ``remote-servers`` A named list of one or more :term:`ip_address` s with optional :term:`tls_id`, :term:`server_key`, and/or :term:`port`. A ``remote-servers`` list may include other ``remote-servers`` lists. See :any:`primaries` block.