File 2211-erl_docgen-Only-allow-a-single-datatype_ti... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2211-erl_docgen-Only-allow-a-single-datatype_title-in-dat.patch of Package erlang (Revision 6af34d10e5fc1c974d15399d1aade82a)

Currently displaying revision 6af34d10e5fc1c974d15399d1aade82a , Show latest

From b3a38be8dd81a37a5c6f225a9aebdf56deec9a7e Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Fri, 15 Sep 2023 12:52:15 +0200
Subject: [PATCH 1/7] erl_docgen: Only allow a single datatype_title in
 datatypes section

We do this to make validation and parsing easier.
---
 erts/doc/src/erlang.xml                 |  3 ++-
 lib/crypto/doc/src/crypto.xml           | 18 +++++++++++++++++
 lib/erl_docgen/priv/dtd/common.refs.dtd |  2 +-
 lib/ssh/doc/src/ssh.xml                 |  9 +++++++++
 lib/ssh/doc/src/ssh_connection.xml      | 27 +++++++++++++++++++++++++
 lib/ssh/doc/src/ssh_sftp.xml            |  6 ++++++
 lib/ssl/doc/src/ssl.xml                 | 20 ++++++++++++------
 7 files changed, 77 insertions(+), 8 deletions(-)

diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 345e8f000a..7eff60e7dd 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -354,8 +354,9 @@
 An Erlang <seeguide marker="system/reference_manual:data_types#tuple">tuple</seeguide>.
 </desc>
 </datatype>
+ </datatypes>
 
- <datatype_title>Other Datatypes</datatype_title>
+ <datatypes>
 <datatype>
 <name name="ext_binary" prefix="true"/>
 <desc>
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index 3a65824a67..98c82f5fec 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -248,7 +248,9 @@
 	Erlang/OTP adds a either padding of zeroes or padding with random bytes.
 </desc>
 </datatype>
+ </datatypes>
 
+ <datatypes>
 <datatype_title>Digests and hash</datatype_title>
 <datatype>
 <name name="hash_algorithm"/>
@@ -308,7 +310,9 @@
 	The <c>compatibility_only_hash()</c> algorithms are recommended only for compatibility with existing applications.
 </desc>
 </datatype>
+ </datatypes>
 
+ <datatypes>
 <datatype_title>Elliptic Curves</datatype_title>
 <datatype>
 <name name="ec_named_curve"/>
@@ -336,7 +340,9 @@
 	Curve definition details.
 </desc>
 </datatype>
+ </datatypes>
 
+ <datatypes>
 <datatype_title>Keys</datatype_title>
 <datatype>
 <name name="key_integer"/>
@@ -344,7 +350,9 @@
 	Always <c>binary()</c> when used as return value
 </desc>
 </datatype>
+ </datatypes>
 
+ <datatypes>
 <datatype_title>Public/Private Keys</datatype_title>
 <datatype>
 <name name="rsa_public"/>
@@ -416,7 +424,9 @@
 
 </desc>
 </datatype>
+ </datatypes>
 
+ <datatypes>
 <datatype_title>Public Key Ciphers</datatype_title>
 
 <datatype>
@@ -448,6 +458,8 @@
 	Those option forms are kept only for compatibility and should not be used in new code.
 </desc>
 </datatype>
+ </datatypes>
+ <datatypes>
 
 <datatype_title>Public Key Sign and Verify</datatype_title>
 
@@ -473,6 +485,8 @@
 	</warning>
 </desc>
 </datatype>
+ </datatypes>
+ <datatypes>
 
 <datatype_title>Diffie-Hellman Keys and parameters</datatype_title>
 <datatype>
@@ -496,6 +510,8 @@
 <desc>
 </desc>
 </datatype>
+ </datatypes>
+ <datatypes>
 
 <datatype_title>Types for Engines</datatype_title>
 
@@ -536,6 +552,8 @@
 	
 </desc>
 </datatype>
+ </datatypes>
+ <datatypes>
 
 <datatype_title>Internal data types</datatype_title>
 
diff --git a/lib/erl_docgen/priv/dtd/common.refs.dtd b/lib/erl_docgen/priv/dtd/common.refs.dtd
index 08e26a8b27..1743ee1fb3 100644
--- a/lib/erl_docgen/priv/dtd/common.refs.dtd
+++ b/lib/erl_docgen/priv/dtd/common.refs.dtd
@@ -48,7 +48,7 @@
 <!ELEMENT fsdescription (marker*,title,(%block;|quote|br|marker|
 warning|note|change|dont|do|section)*) >
 <!ATTLIST fsdescription ghlink CDATA #IMPLIED>
-<!ELEMENT datatypes (datatype_title?,datatype)+ >
+<!ELEMENT datatypes (datatype_title?,datatype+) >
 <!ELEMENT datatype_title (#PCDATA) >
 <!ELEMENT datatype (name+,desc?) >
 <!ATTLIST datatype ghlink CDATA #IMPLIED>
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index d58166711a..bc96e13a8a 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -347,6 +347,9 @@
 </datatype>
 
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Daemon Options (Server Options)</datatype_title>
 
 <datatype>
@@ -887,6 +890,9 @@
 </datatype>
 
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Options common to clients and daemons</datatype_title>
 <datatype>
 <name name="common_options"/>
@@ -1181,6 +1187,9 @@
 </datatype>
 
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Other data types</datatype_title>
 
 <datatype>
diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml
index 899bd0c2b7..4ecbfae02d 100644
--- a/lib/ssh/doc/src/ssh_connection.xml
+++ b/lib/ssh/doc/src/ssh_connection.xml
@@ -91,6 +91,9 @@
 </desc>
 </datatype>
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>SSH Connection Protocol: General</datatype_title>
 <datatype>
 <name name="event"/>
@@ -116,6 +119,9 @@
 </datatype>
 
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Data Transfer (RFC 4254, section 5.2)</datatype_title>
 <datatype>
 <name name="data_ch_msg"/>
@@ -127,6 +133,9 @@
 </datatype>
 
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Closing a Channel (RFC 4254, section 5.3)</datatype_title>
 <datatype>
 <name name="eof_ch_msg"/>
@@ -147,6 +156,9 @@
 </datatype>
 
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Requesting a Pseudo-Terminal (RFC 4254, section 6.2)</datatype_title>
 <datatype>
 <name name="pty_ch_msg"/>
@@ -169,6 +181,9 @@
 </datatype>
 
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Environment Variable Passing (RFC 4254, section 6.4)</datatype_title>
 <datatype>
 <name name="env_ch_msg"/>
@@ -181,6 +196,9 @@
 </datatype>
 
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Starting a Shell or Command (RFC 4254, section 6.5)</datatype_title>
 <datatype>
 <name name="shell_ch_msg"/>
@@ -202,6 +220,9 @@
 </datatype>
 
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Window Dimension Change Message (RFC 4254, section 6.7)</datatype_title>
 <datatype>
 <name name="window_change_ch_msg"/>
@@ -212,6 +233,9 @@
 </desc>
 </datatype>
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Signals (RFC 4254, section 6.9)</datatype_title>
 <datatype>
 <name name="signal_ch_msg"/>
@@ -226,6 +250,9 @@
 </datatype>
 
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Returning Exit Status (RFC 4254, section 6.10)</datatype_title>
 <datatype>
 <name name="exit_status_ch_msg"/>
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml
index c035f74b3a..60752054dc 100644
--- a/lib/ssh/doc/src/ssh_sftp.xml
+++ b/lib/ssh/doc/src/ssh_sftp.xml
@@ -44,6 +44,9 @@
 </desc>
 </datatype>
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Error cause</datatype_title>
 <datatype>
 <name name="reason"/>
@@ -63,6 +66,9 @@
 </desc>
 </datatype>
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>Crypto operations for open_tar</datatype_title>
 <datatype>
 <name name="tar_crypto_spec"/>
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index 57fb68ab5f..f719c55c32 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -283,7 +283,9 @@
 <datatype>
 <name name="server_session_tickets"/>
 </datatype>
+ </datatypes>
 
+ <datatypes>
 <datatype_title>TLS/DTLS OPTION DESCRIPTIONS - COMMON for SERVER and CLIENT</datatype_title>
 
 <datatype>
@@ -995,6 +997,9 @@ fun(srp, Username :: binary(), UserState :: term()) ->
 </desc>
 </datatype>
 
+ </datatypes>
+ <datatypes>
+
 <datatype_title>TLS/DTLS OPTION DESCRIPTIONS - CLIENT</datatype_title>
 
 <datatype>
@@ -1281,7 +1286,10 @@ fun(srp, Username :: binary(), UserState :: term()) ->
 
 
 
- <datatype_title>TLS/DTLS OPTION DESCRIPTIONS - SERVER</datatype_title>
+ </datatypes>
+ <datatypes>
+
+ <datatype_title>TLS/DTLS OPTION DESCRIPTIONS - SERVER</datatype_title>
 
 <datatype>
 	<name name="server_option"/>
@@ -1294,9 +1302,9 @@ fun(srp, Username :: binary(), UserState :: term()) ->
 	</desc>
 </datatype>
 
- <datatype>
- <name since="OTP 25.2" name="server_certificate_authorities"/>
- <desc>
+ <datatype>
+ <name since="OTP 25.2" name="server_certificate_authorities"/>
+ <desc>
 	Determines if a TLS-1.3 server should include the authorities
 	extension in its certificate request message that will be sent if the
 	option <c>verify</c> is set to <c>verify_peer</c>. Defaults to <c>true</c>.
@@ -1307,7 +1315,7 @@ fun(srp, Username :: binary(), UserState :: term()) ->
 
 </desc>
 
- </datatype>
+ </datatype>
 
 <datatype>
 	<name name="server_cafile"/>
@@ -1675,7 +1683,7 @@ fun(srp, Username :: binary(), UserState :: term()) ->
 <name name="tls_options_name"/>
 </datatype>
 
- </datatypes>
+ </datatypes>
 
 <!--
 ================================================================
-- 
2.35.3

Places

File 2211-erl_docgen-Only-allow-a-single-datatype_title-in-dat.patch of Package erlang (Revision 6af34d10e5fc1c974d15399d1aade82a)

Places