[gentoo-dev] [RFC PATCH 09/19] profiles/desc: reword and update nginx_modules_http.desc

[Zurab Kvachadze <zurabid2016@gmail.com>]

The wording used in nginx_modules_http.desc to describe the USE flags
was rather inconsistent with how USE flags are described in Gentoo.

This commit features the following changes:

    * The missing descriptions were added for the "ssl"[1],
      "upstream_random", "v2"[1] and "v3"[1] modules.

    * "This module does something" was changed to "Add support for
      something" en masse, as is done elsewhere in Gentoo.

    * The descriptions were brought in line with upstream[2] ones. For
      many of them, the wording was modified to better (sometimes more
      concisely) reflect their function.

    * Update copyright and actually sort the modules!

[1]: Previously, these modules were not USE_EXPAND flags but rather USE
flags on their own. With the introduction of nginx.eclass, they become
NGINX_MODULES_HTTP USE_EXPAND flags, as the rest of NGINX modules are.
[2]: See "Module reference" at the bottom of https://nginx.org/en/docs/

Signed-off-by: Zurab Kvachadze <zurabid2016@gmail.com>
---
 profiles/desc/nginx_modules_http.desc | 147 +++++++++++++-------------
 1 file changed, 75 insertions(+), 72 deletions(-)

diff --git a/profiles/desc/nginx_modules_http.desc b/profiles/desc/nginx_modules_http.desc
index dd1d7ea38a95..24f06804721c 100644
--- a/profiles/desc/nginx_modules_http.desc
+++ b/profiles/desc/nginx_modules_http.desc
@@ -1,77 +1,80 @@
-# Copyright 1999-2018 Gentoo Foundation.
+# Copyright 1999-2024 Gentoo Authors.
 # Distributed under the terms of the GNU General Public License v2
 
 # This file contains descriptions of NGINX_MODULES_HTTP USE_EXPAND flags.
 
 # Keep it sorted.
-access - This module provides a simple host-based access control.
-addition - This module adds contents of other locations before and after the current location's content.
-auth_basic - This module protects your site or parts of it with username and password based on HTTP Basic Authentication.
-auth_ldap - LDAP module for nginx which supports authentication against multiple LDAP servers.
-auth_pam - This module provides authentication via PAM.
-auth_request - Module implementing client authorization based on the result of a subrequest.
-autoindex - This module provides automatic directory listings.
-brotli - This module allows for on-the-fly Brotli compression.
-browser - This module creates variables, the values of which depend on the request header "User-agent".
-cache_purge - External module adding ability to purge content from nginx's FastCGI and proxy caches.
-charset - This module can reencode data of one encoding into another.
-dav - This module adds the HTTP and WebDAV methods PUT, DELETE, MKCOL, COPY and MOVE.
-dav_ext - Add missing WebDAV methods PROPFIND & OPTIONS to the existing WebDAV module.
-degradation - Allows to return 204 or 444 code for some locations on low memory condition (reliable on FreeBSD only)
-echo - Brings shell-style goodies to Nginx config file.
-empty_gif - This module keeps a 1x1 transparent GIF in memory that can be served very quickly.
-fancyindex - This module makes possible the generation of file listings, like the built-in autoindex module does, but adding a touch of style.
-fastcgi - This module allows Nginx to interact with FastCGI processes and control what parameters are passed to the process.
-flv - This module provides the ability to seek within FLV (Flash) files using time-based offsets.
-geo - This module creates variables, whose values depend on the IP-address of the client.
-geoip - This module creates variables based on the IP-address of the client matched against the MaxMind GeoIP binary files.
-geoip2 - This module creates variables based on the IP-address of the client matched against the MaxMind GeoIP2 binary files.
-grpc - This module provides gRPC support.
-gunzip - Permits to decompress gzip'ed files on-the-fly for clients not supporting the gzip encoding method.
-gzip - This module allows for on-the-fly gzip compression.
-gzip_static - Before serving a file from disk to a gzip-enabled client, this module will look for a precompressed file in the same location.
-headers_more - Set and clear input and output headers
-image_filter - This module is a filter for transforming JPEG, GIF and PNG images.
-javascript - This module implements location and variable handlers in nginScript.
-limit_conn - This module makes it possible to limit the number of simultaneous connections for the assigned session
-limit_req - This module allows you to limit the number of requests for a given session.
-limit_conn - This module makes it possible to limit the number of simultaneous connections for the assigned session
-lua - Embed the power of Lua into nginx
-map - This module allows you to classify, or map a set of values into a different set of values and store the result in a variable.
-memc - An extended version of the standard memcached module that supports set, add, delete, and many more memcached commands.
-memcached - You can use this module to perform simple caching.
-metrics - Module to export various metrics in easy-parseable JSON.
-mirror - This module implements mirroring of an original request by creating background mirror subrequests.
-mogilefs - Enable support for MogileFS.
-mp4 - This module adds pseudo-streaming
-naxsi - An open source, high performance, low rules maintenance, Web Application Firewall module for Nginx.
-perl - This module makes it possible to execute Perl directly within Nginx and call Perl via SSI.
-proxy - This module makes it possible to transfer requests to another server.
-push_stream - Push Stream module, supporting EventSource, WebSocket, Long Polling, and Forever Iframe.
-random_index - Pick a random directory index from a directory.
-realip - This module allows to change the client's IP address to value from request header (e. g. X-Real-IP or X-Forwarded-For).
-referer - This module makes it possible to block access to the site with the incorrect values of line "Referer" in the request header.
-rewrite - This module makes it possible to change URI using regular expressions (PCRE), and to redirect and select configuration depending on variables.
-scgi - An implementation of the Simple Common Gateway Interface.
-secure_link - This module computes and checks request URLs for a required security token.
-security - Web application firewall and Intrusion Detection System.
-slice - A filter that splits a request into subrequests, each returning a certain range of response
-slowfs_cache - This module adds the ability to cache static files
-split_clients - This module provides A/B testing support.
-ssi - This module provides a filter which processes Server-Side Includes (SSI) in the input.
-spdy - This module provides an SPDY implementation. (Deprecated, use IUSE="http2" instead)
-sticky - Module to always forward clients to the same upstream server (via sticky cookies)
-stub_status - This module provides the ability to get some status from nginx.
-sub - This module can search and replace text in the nginx response.
-upload_progress - This module adds the ability to track POST upload progress via JSON API
-upstream_check - Add health check support for upstream servers.
-upstream_hash - This module provides the ability to distribute upstream requests based on hashed key value.
-upstream_ip_hash - This module provides the ability to distribute upstream requests based on the IP-address of the client.
-upstream_keepalive - Thiis module provides the ability to cache connections to upstream servers.
-upstream_least_conn - This module provides the ability to distribute upstream requests using load balancing methods.
-upstream_zone - This module makes it possible to define a shared memory zone that keeps the group's configuration and run-time state that are shared between worker processes.
-userid - This module gives out cookies for identification of clients.
-uwsgi - External module for the uWSGI protocol for python web apps.
-vhost_traffic_status - This module provides access to virtual host status information.
-vod - Adds support for video streaming using DASH, HDS, HLS, MSS.
-xslt - This module is a filter which converts an XML response with the aid of one or more XSLT templates.
+access - Add support for a simple host-based access control
+addition - Add support for adding contents of other locations before and after the current location's content
+auth_basic - Add support for limiting access to a location by validating the username and password using the HTTP Basic Authentication
+auth_ldap - Add support for LDAP authentication module for NGINX
+auth_pam - Add support for authentication via PAM
+auth_request - Add support for client authorization based on the result of a subrequest
+autoindex - Add support for processing requests ending with the slash character ('/') and produciing a directory listing
+brotli - Add support for on-the-fly Brotli compression
+browser - Add support for creating variables whose values depend on the value of the "User-Agent" request header field
+cache_purge - Add support for purging content from NGINX's FastCGI and proxy caches
+charset - Add support for adding the specified charset to the "Content-Type" response header field and reencoding singe-byte charsets
+dav - Add support for the WebDAV functionality and methods: PUT, DELETE, MKCOL, COPY and MOVE
+dav_ext - Add support for the additional WebDAV methods into the existing WebDAV module: PROPFIND & OPTIONS
+degradation - Add support for returning 204 or 444 code for some locations on low memory condition (reliable on FreeBSD only)
+echo - Add support for shell-style goodies in the NGINX configuration file
+empty_gif - Add support for emiting a single-pixel transparent GIF
+fancyindex - Add support for the fancy generation of file listings
+fastcgi - Add support for passing requests to a FastCGI server
+flv - Add support for the server-side pseudo-streaming of Flash Video (FLV) files
+geo - Add support for creating variables whose values depend on the client IP-address
+geoip - Add support for creating variables whose values depend on the client IP-address, using the precompiled MaxMind databases
+geoip2 - Add support for creating variables whose values depend on the client IP-address, using the precompiled MaxMind GeoIP2 databases
+grpc - Add support for passing requests to a gRPC server
+gunzip - Add support for decompressing responses with "Content-Encoding: gzip" for clients that do not support "gzip" encoding method
+gzip - Add support for compressing responses using the "gzip" method
+gzip_static - Add support for sending precompressed files with the ".gz" filename extension instead of regular files
+headers_more - Add support for setting arbitrary input and output headers
+image_filter - Add support for transforming images in JPEG, GIF, PNG, and WebP formats
+javascript - Add support for implementing location and variable handlers in njs - a subset of the JavaScript language
+limit_conn - Add support for limiting the number of connections per a defined key, e.g. the number of connections from a single IP address
+limit_req - Add support for limiting the request processing rate per a defined key, e.g. the processing rate of requests coming from a single IP address
+lua - Add support for Lua scripting in NGINX
+map - Add support for creating variables whose values depend on values of other variables
+memc - Add support for an extended version of the standard memcached module that supports set, add, delete, and many more memcached commands
+memcached - Add support for obtaining responses from a memcached server
+metrics - Add support for exporting various metrics in an easy-parseable JSON format
+mirror - Add support for mirroring of the original request by creating background mirror subrequests
+mogilefs - Add support for MogileFS
+mp4 - Add support for server-side pseudo-streaming for MP4 files
+naxsi - Add support for NAXSI WAF (Web Application Firewall)
+perl - Add support for implementing location and variable handlers in Perl and inserting Perl calls into SSI
+proxy - Add support for passing subrequests to another server
+push_stream - Add support for the stream HTTP push module, which supports EventSource, WebSocket, Long Polling, and Forever Iframe
+random_index - Add support for processing requests ending with the slash character ('/') by picking a random file in a directory to serve as an index file
+realip - Add support for setting the client address and optional port to those sent in the specified header field (e.g. "X-Real-IP" or "X-Forwarded-For")
+referer - Add support for blocking access to a site for requests with invalid values in the "Referer" header field
+rewrite - Add support for changing the request URI using PCRE regular expressions, returning redirects, and conditionally selecting configurations
+scgi - Add support for passing requests to an SCGI server
+secure_link - Add support for checking authenticity of requested links, protecting resources from unauthorized access, and limiting link lifetime
+security - Add support for modsecurity: web application firewall and intrusion detection system
+slice - Add support for spliting a request into subrequests, each returning a certain range of response
+slowfs_cache - Add support for caching static files
+spdy - Add support for an SPDY implementation. (Deprecated, use USE="nginx_modules_http_v2" instead)
+split_clients - Add support for creating variables suitable for A/B testing, also known as split testing
+ssi - Add support for processing SSI (Server Side Includes) commands in responses passing through NGINX
+ssl - Add support for HTTPS - SSL/TLS-encrypted HTTP
+sticky - Add support for sending a sticky cookie in order to always forward client to the same upstream server
+stub_status - Add support for providing access to basic status information
+sub - Add support for modifying a response by replacing one specified string by another
+upload_progress - Add support for an upload progress system, that monitors RFC1867 POST uploads as they are transmitted to upstream servers
+upstream_check - Add support for performing health check of upstream servers
+upstream_hash - Add support for distributing upstream requests based on hashed key value
+upstream_ip_hash - Add support for distributing upstream requests based on the IP-address of the client
+upstream_keepalive - Add support for caching connections to upstream servers
+upstream_least_conn - Add support for passing upstream requests to the server with the least number of active connections
+upstream_random - Add support for passing upstream requests to a randomly selected server
+upstream_zone - Add support for defining a shared memory zone that keeps the group's configuration and run-time state that are shared between worker processes
+userid - Add support for setting cookies suitable for client identification
+uwsgi - Add support for passing requests to a uwsgi server
+vhost_traffic_status - Add support for providing access to virtual host status information
+v2 - Add support for HTTP/2
+v3 - Add experimental support for HTTP/3
+vod - Add support for streaming video using DASH, HDS, HLS, MSS
+xslt - Add support for transforming XML responses using one or more XSLT stylesheets
-- 
2.44.2