From 10eedd175e99a8be191d116d5c81c340d6c3c5b6 Mon Sep 17 00:00:00 2001 From: Luca Di Sera Date: Wed, 15 Sep 2021 16:41:31 +0200 Subject: Doc: Centralize RFC documentation-links in rfc.qdoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In the effort of repairing broken links as per QTBUG-96127, a series of RFC links referring to `tools.ietf.org/html/*` were modified to point to the new address that the site redirected to. To simplify executing a similar task and to diminish the duplication of manually inserted urls, the already existing `rfc.qdoc` file, containing `\externalpage` commands directing to RFC locations, was enhanced with links to all RFCs that were mentioned in the current documentation, so as to aggregate this common category of links. All links pointing to a `ietf` domain inside QDoc documentation blocks were then changed to use the newly provided external-references. Task-number: QTBUG-96127 Pick-to: 6.2 Change-Id: I2a52eb6aa8c9e346f64ef1a627b039220d9f6c2a Reviewed-by: Mårten Nordheim --- src/corelib/doc/src/external-resources.qdoc | 5 ----- src/corelib/doc/src/json.qdoc | 2 +- src/corelib/io/qurl.cpp | 2 +- src/corelib/plugin/quuid.cpp | 2 +- src/corelib/serialization/qcborarray.cpp | 2 +- src/corelib/serialization/qcborcommon.cpp | 14 +++++++------- src/corelib/serialization/qcbordiagnostic.cpp | 2 +- src/corelib/serialization/qcbormap.cpp | 2 +- src/corelib/serialization/qcborstreamreader.cpp | 2 +- src/corelib/serialization/qcborstreamwriter.cpp | 9 ++++----- src/corelib/serialization/qcborvalue.cpp | 8 ++++---- src/corelib/serialization/qjsonvalue.cpp | 2 +- 12 files changed, 23 insertions(+), 29 deletions(-) (limited to 'src/corelib') diff --git a/src/corelib/doc/src/external-resources.qdoc b/src/corelib/doc/src/external-resources.qdoc index 62e6b7ea1d..50a19a4e09 100644 --- a/src/corelib/doc/src/external-resources.qdoc +++ b/src/corelib/doc/src/external-resources.qdoc @@ -46,11 +46,6 @@ \title ISO 8601 */ -/*! - \externalpage http://www.ietf.org/rfc/rfc4648.txt - \title RFC 4648 -*/ - /*! \externalpage http://www.iana.org/assignments/character-sets/character-sets.xml \title IANA character-sets encoding file diff --git a/src/corelib/doc/src/json.qdoc b/src/corelib/doc/src/json.qdoc index 2a7d5a702b..9b1070ec67 100644 --- a/src/corelib/doc/src/json.qdoc +++ b/src/corelib/doc/src/json.qdoc @@ -43,7 +43,7 @@ modify and save JSON data. More details about the JSON data format can be found at \l{http://json.org}{json.org} - and in \l{https://datatracker.ietf.org/doc/html/rfc4627}{RFC-4627}. + and in \l {RFC 4627}. \tableofcontents diff --git a/src/corelib/io/qurl.cpp b/src/corelib/io/qurl.cpp index b5b4c653cd..6333ee3c84 100644 --- a/src/corelib/io/qurl.cpp +++ b/src/corelib/io/qurl.cpp @@ -1958,7 +1958,7 @@ void QUrl::setUrl(const QString &url, ParsingMode parsingMode) The scheme describes the type (or protocol) of the URL. It's represented by one or more ASCII characters at the start the URL. - A scheme is strictly \l {http://www.ietf.org/rfc/rfc3986.txt} {RFC 3986}-compliant: + A scheme is strictly \l {RFC 3986}-compliant: \tt {scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )} The following example shows a URL where the scheme is "ftp": diff --git a/src/corelib/plugin/quuid.cpp b/src/corelib/plugin/quuid.cpp index b41af5c4f2..7f7d537fe4 100644 --- a/src/corelib/plugin/quuid.cpp +++ b/src/corelib/plugin/quuid.cpp @@ -286,7 +286,7 @@ static QUuid createFromName(const QUuid &ns, const QByteArray &baseData, QCrypto \endtable The field layouts for the DCE versions listed in the table above - are specified in the \l{http://www.ietf.org/rfc/rfc4122.txt} + are specified in the \l{RFC 4122} {Network Working Group UUID Specification}. Most platforms provide a tool for generating new UUIDs, e.g. \c diff --git a/src/corelib/serialization/qcborarray.cpp b/src/corelib/serialization/qcborarray.cpp index 2e0de4f4fc..11f469dc86 100644 --- a/src/corelib/serialization/qcborarray.cpp +++ b/src/corelib/serialization/qcborarray.cpp @@ -59,7 +59,7 @@ using namespace QtCbor; binary data encoding that is a superset of JSON. It was created by the IETF Constrained RESTful Environments (CoRE) WG, which has used it in many new RFCs. It is meant to be used alongside the - \l{https://tools.ietf.org/html/rfc7252}{CoAP protocol}. + \l{RFC 7252}{CoAP protocol}. QCborArray is very similar to \l QVariantList and \l QJsonArray and its API is almost identical to those two classes. It can also be converted to and diff --git a/src/corelib/serialization/qcborcommon.cpp b/src/corelib/serialization/qcborcommon.cpp index 4f102c3b95..40caf9e3a4 100644 --- a/src/corelib/serialization/qcborcommon.cpp +++ b/src/corelib/serialization/qcborcommon.cpp @@ -153,11 +153,11 @@ QDataStream &operator>>(QDataStream &ds, QCborSimpleType &st) is the exponent of the power of 10, the second the integral mantissa. The value 273.15 would be encoded as array \c{[-2, 27315]}. \value Bigfloat Similar to Decimal, but the exponent is a power of 2 instead. - \value COSE_Encrypt0 An \c Encrypt0 map as specified by \l{https://tools.ietf.org/html/rfc8152}{RFC 8152} + \value COSE_Encrypt0 An \c Encrypt0 map as specified by \l{RFC 8152} (CBOR Object Signing and Encryption). - \value COSE_Mac0 A \c Mac0 map as specified by \l{https://tools.ietf.org/html/rfc8152}{RFC 8152} + \value COSE_Mac0 A \c Mac0 map as specified by \l{RFC 8152} (CBOR Object Signing and Encryption). - \value COSE_Sign1 A \c Sign1 map as specified by \l{https://tools.ietf.org/html/rfc8152}{RFC 8152} + \value COSE_Sign1 A \c Sign1 map as specified by \l{RFC 8152} (CBOR Object Signing and Encryption). \value ExpectedBase64url Indicates that the byte array should be encoded using Base64url if the stream is converted to JSON. @@ -172,13 +172,13 @@ QDataStream &operator>>(QDataStream &ds, QCborSimpleType &st) \value RegularExpression Indicates that the string contains a Perl-Compatible Regular Expression pattern. \value MimeMessage Indicates that the string contains a MIME message (according to - \l{https://tools.ietf.org/html/rfc2045}){RFC 2045}. + \l{RFC 2045}). \value Uuid Indicates that the byte array contains a UUID. - \value COSE_Encrypt An \c Encrypt map as specified by \l{https://tools.ietf.org/html/rfc8152}{RFC 8152} + \value COSE_Encrypt An \c Encrypt map as specified by \l{RFC 8152} (CBOR Object Signing and Encryption). - \value COSE_Mac A \c Mac map as specified by \l{https://tools.ietf.org/html/rfc8152}{RFC 8152} + \value COSE_Mac A \c Mac map as specified by \l{RFC 8152} (CBOR Object Signing and Encryption). - \value COSE_Sign A \c Sign map as specified by \l{https://tools.ietf.org/html/rfc8152}{RFC 8152} + \value COSE_Sign A \c Sign map as specified by \l{RFC 8152} (CBOR Object Signing and Encryption). \value Signature No change in interpretation; this tag can be used as the outermost tag in a CBOR stream as the file header. diff --git a/src/corelib/serialization/qcbordiagnostic.cpp b/src/corelib/serialization/qcbordiagnostic.cpp index 2e92dab0a4..b7d8f1ed6b 100644 --- a/src/corelib/serialization/qcbordiagnostic.cpp +++ b/src/corelib/serialization/qcbordiagnostic.cpp @@ -326,7 +326,7 @@ void DiagnosticNotation::appendValue(const QCborValue &v) would be possible. CBOR diagnostic notation is specified by - \l{https://tools.ietf.org/html/rfc7049#section-6}{section 6} of RFC 7049. + \l{RFC 7049, section 6}{section 6} of RFC 7049. It is a text representation of the CBOR stream and it is very similar to JSON, but it supports the CBOR types not found in JSON. The extended format enabled by the \l{DiagnosticNotationOption}{ExtendedFormat} flag is diff --git a/src/corelib/serialization/qcbormap.cpp b/src/corelib/serialization/qcbormap.cpp index 34c8c72059..2ffd0e1025 100644 --- a/src/corelib/serialization/qcbormap.cpp +++ b/src/corelib/serialization/qcbormap.cpp @@ -58,7 +58,7 @@ using namespace QtCbor; Representation, a very compact form of binary data encoding that is a superset of JSON. It was created by the IETF Constrained RESTful Environments (CoRE) WG, which has used it in many new RFCs. It is meant to - be used alongside the \l{https://tools.ietf.org/html/rfc7252}{CoAP + be used alongside the \l{RFC 7252}{CoAP protocol}. Unlike JSON and \l QVariantMap, CBOR map keys can be of any type, not just diff --git a/src/corelib/serialization/qcborstreamreader.cpp b/src/corelib/serialization/qcborstreamreader.cpp index 8e42efb0cc..551d083d11 100644 --- a/src/corelib/serialization/qcborstreamreader.cpp +++ b/src/corelib/serialization/qcborstreamreader.cpp @@ -109,7 +109,7 @@ static_assert(int(QCborStreamReader::Invalid) == CborInvalidType); Representation, a very compact form of binary data encoding that is compatible with JSON. It was created by the IETF Constrained RESTful Environments (CoRE) WG, which has used it in many new RFCs. It is meant to - be used alongside the \l{https://tools.ietf.org/html/rfc7252}{CoAP + be used alongside the \l{RFC 7252}{CoAP protocol}. QCborStreamReader provides a StAX-like API, similar to that of diff --git a/src/corelib/serialization/qcborstreamwriter.cpp b/src/corelib/serialization/qcborstreamwriter.cpp index ff6cbbec00..d3c0066cca 100644 --- a/src/corelib/serialization/qcborstreamwriter.cpp +++ b/src/corelib/serialization/qcborstreamwriter.cpp @@ -92,8 +92,7 @@ Q_DECLARE_TYPEINFO(CborEncoder, Q_PRIMITIVE_TYPE); Representation, a very compact form of binary data encoding that is compatible with JSON. It was created by the IETF Constrained RESTful Environments (CoRE) WG, which has used it in many new RFCs. It is meant to - be used alongside the \l{https://tools.ietf.org/html/rfc7252}{CoAP - protocol}. + be used alongside the \l{RFC 7252}{CoAP protocol}. QCborStreamWriter provides a StAX-like API, similar to that of \l{QXmlStreamWriter}. It is rather low-level and requires a bit of knowledge @@ -123,7 +122,7 @@ Q_DECLARE_TYPEINFO(CborEncoder, Q_PRIMITIVE_TYPE); QCborStreamWriter supports all CBOR features required to create canonical and strict streams. It implements almost all of the features specified in - \l {https://tools.ietf.org/html/rfc7049}{RFC 7049}. + \l {RFC 7049}. The following table lists the CBOR features that QCborStreamWriter supports. @@ -151,7 +150,7 @@ Q_DECLARE_TYPEINFO(CborEncoder, Q_PRIMITIVE_TYPE); \section2 Canonical CBOR encoding Canonical CBOR encoding is defined by - \l{https://tools.ietf.org/html/rfc7049#section-3.9}{Section 3.9 of RFC + \l{RFC 7049, section 3.9}{Section 3.9 of RFC 7049}. Canonical encoding is not a requirement for Qt's CBOR decoding functionality, but it may be required for some protocols. In particular, protocols that require the ability to reproduce the same stream identically @@ -181,7 +180,7 @@ Q_DECLARE_TYPEINFO(CborEncoder, Q_PRIMITIVE_TYPE); \section2 Strict CBOR mode Strict mode is defined by - \l{https://tools.ietf.org/html/rfc7049#section-3.10}{Section 3.10 of RFC + \l{RFC 7049, section 3.10}{Section 3.10 of RFC 7049}. As for Canonical encoding above, QCborStreamWriter makes it possible to create strict CBOR streams, but does not require them or validate that the output is so. diff --git a/src/corelib/serialization/qcborvalue.cpp b/src/corelib/serialization/qcborvalue.cpp index e6146c722e..44ad348fa2 100644 --- a/src/corelib/serialization/qcborvalue.cpp +++ b/src/corelib/serialization/qcborvalue.cpp @@ -75,7 +75,7 @@ QT_BEGIN_NAMESPACE binary data encoding that is a superset of JSON. It was created by the IETF Constrained RESTful Environments (CoRE) WG, which has used it in many new RFCs. It is meant to be used alongside the - \l{https://tools.ietf.org/html/rfc7252}{CoAP protocol}. + \l{RFC 7252}{CoAP protocol}. CBOR has three groups of built-in types: @@ -159,7 +159,7 @@ QT_BEGIN_NAMESPACE QCborValue supports all CBOR features required to create canonical and strict streams. It implements almost all of the features specified in \l - {https://tools.ietf.org/html/rfc7049}{RFC 7049}. + {RFC 7049}. The following table lists the CBOR features that QCborValue supports. @@ -1283,8 +1283,8 @@ inline int QCborContainerPrivate::compareElement_helper(const QCborContainerPriv \section3 Sorting order - Sorting order in CBOR is defined in RFC 7049 - {https://tools.ietf.org/html/rfc7049#section-3.9}{section 3.9}, which + Sorting order in CBOR is defined in + \l{RFC 7049, section 3.9}, which discusses the sorting of keys in a map when following the Canonical encoding. According to the specification, "sorting is performed on the bytes of the representation of the key data items" and lists as diff --git a/src/corelib/serialization/qjsonvalue.cpp b/src/corelib/serialization/qjsonvalue.cpp index 325e1db62e..933a8e1552 100644 --- a/src/corelib/serialization/qjsonvalue.cpp +++ b/src/corelib/serialization/qjsonvalue.cpp @@ -468,7 +468,7 @@ void QJsonValue::swap(QJsonValue &other) noexcept fails the value is replaced by a null JSON value. Note that QVariant::toString() is also lossy for the majority of types. For example, if the passed QVariant is representing raw byte array data, it is recommended - to pre-encode it to \l {https://www.ietf.org/rfc/rfc4648.txt}{Base64} (or + to pre-encode it to \l {RFC 4686}{Base64} (or another lossless encoding), otherwise a lossy conversion using QString::fromUtf8() will be used. -- cgit v1.2.3