Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words
RFC 8174 обновляет RFC 2119 и уточняет, что специальные нормативные значения ключевых слов возникают только при их написании полностью прописными буквами. Слова MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, NOT RECOMMENDED, MAY и OPTIONAL в ином регистре сохраняют обычное английское значение. Документ подчёркивает, что нормативный текст может не использовать эти ключевые слова и всё равно оставаться нормативным. Для документов, следующих этой практике, приводится рекомендуемая формула ссылки на BCP 14, RFC 2119 и RFC 8174.
Internet Engineering Task Force (IETF) B. Leiba
Request for Comments: 8174 Huawei Technologies
BCP: 14 Май 2017
Обновляет: 2119
Категория: Лучшая современная практика
ISSN: 2070-1721
Неоднозначность прописных и строчных нормативных слов RFC 2119
Аннотация
RFC 2119 определяет общепринятые ключевые слова, которые могут
использоваться в спецификациях протоколов. Настоящий документ призван
уменьшить неоднозначность, разъясняя, что определённые особые значения
имеют только ключевые слова, используемые ПРОПИСНЫМИ БУКВАМИ.
Статус данного меморандума
Этот меморандум документирует Лучшую современную практику Интернета.
Этот документ является продуктом Internet Engineering Task Force
(IETF). Он отражает консенсус сообщества IETF. Он прошёл публичное
рассмотрение и был одобрен для публикации Internet Engineering
Steering Group (IESG). Дополнительная информация о BCP доступна в
разделе 2 RFC 7841.
Информацию о текущем статусе данного документа, любых исправлениях
и о том, как предоставить отзыв о нём, можно получить по адресу
http://www.rfc-editor.org/info/rfc8174.
Leiba Лучшая современная практика [Страница 1]
RFC 8174 Разъяснение RFC 2119 Май 2017
Уведомление об авторском праве
Авторское право (c) 2017 принадлежит IETF Trust и лицам, указанным
в качестве авторов документа. Все права защищены.
Настоящий документ подпадает под действие BCP 78 и Правовых положений
IETF Trust, относящихся к документам IETF
(IETF Trust's Legal Provisions Relating to IETF Documents)
(http://trustee.ietf.org/license-info), действующих на дату публикации
настоящего документа. Внимательно ознакомьтесь с этими документами,
поскольку они описывают ваши права и ограничения в отношении
настоящего документа. Компоненты кода, извлечённые из настоящего
документа, должны включать текст лицензии Simplified BSD License, как
описано в разделе 4.e Trust Legal Provisions, и предоставляются без
гарантии, как описано в Simplified BSD License.
Содержание
1. Введение . . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Разъяснение регистра ключевых слов . . . . . . . . . . . . . 3
3. Соображения IANA . . . . . . . . . . . . . . . . . . . . . . 4
4. Соображения безопасности . . . . . . . . . . . . . . . . . . 4
5. Нормативные ссылки . . . . . . . . . . . . . . . . . . . . 4
Адрес автора . . . . . . . . . . . . . . . . . . . . . . . . . 4
1. Введение
RFC 2119 определяет общепринятые ключевые слова, такие как "MUST",
"SHOULD" и "MAY", которые могут использоваться в спецификациях
протоколов. В нём сказано, что ключевые слова «часто пишутся
прописными буквами», что вызвало путаницу в отношении того, как
интерпретировать слова, написанные не полностью прописными буквами,
такие как «must» и «should».
Настоящий документ обновляет RFC 2119, разъясняя, что определённые
особые значения имеют только ключевые слова, используемые ПРОПИСНЫМИ
БУКВАМИ. Настоящий документ является частью BCP 14.
Leiba Лучшая современная практика [Страница 2]
RFC 8174 Разъяснение RFC 2119 Май 2017
2. Разъяснение регистра ключевых слов
В [RFC2119] вносится следующее изменение:
=== СТАРОЕ ===
Во многих документах уровня стандартов несколько слов используются
для обозначения требований в спецификации. Эти слова часто пишутся
прописными буквами. Этот документ определяет, как следует
интерпретировать эти слова в документах IETF. Авторам, следующим этим
рекомендациям, следует включать следующую фразу ближе к началу своего
документа:
Ключевые слова "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY" и "OPTIONAL" в этом
документе должны толковаться так, как описано в RFC 2119.
=== НОВОЕ ===
Во многих документах IETF несколько слов, когда они написаны всеми
прописными буквами, как показано ниже, используются для обозначения
требований в спецификации. Эти слова, написанные прописными буквами,
могут вносить в документы существенную ясность и согласованность,
поскольку их значения чётко определены. Этот документ определяет,
как толкуются эти слова в документах IETF, когда слова написаны всеми
прописными буквами.
o Эти слова могут использоваться в определённом здесь значении, но
их использование не требуется. В частности, нормативный текст не
требует использования этих ключевых слов. Они используются для
ясности и согласованности, когда это желательно, однако большой
объём нормативного текста не использует их и всё равно является
нормативным.
o Эти слова имеют указанные в настоящем документе значения только
тогда, когда они написаны всеми прописными буквами.
o Когда эти слова не написаны всеми прописными буквами, они имеют
свои обычные значения в английском языке и не подпадают под
действие настоящего документа.
Авторам, следующим этим рекомендациям, следует включать следующую
фразу ближе к началу своего документа:
Ключевые слова "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
"MAY" и "OPTIONAL" в этом документе должны толковаться так, как
описано в BCP 14 [RFC2119] [RFC8174], тогда и только тогда, когда
они написаны всеми прописными буквами, как показано здесь.
=== КОНЕЦ ===
Leiba Лучшая современная практика [Страница 3]
RFC 8174 Разъяснение RFC 2119 Май 2017
3. Соображения IANA
Настоящий документ не требует каких-либо действий IANA.
4. Соображения безопасности
Настоящий документ носит исключительно процедурный характер;
связанных с ним соображений безопасности нет.
5. Нормативные ссылки
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>.
Адрес автора
Barry Leiba
Huawei Technologies
Телефон: +1 646 827 0648
Электронная почта: barryleiba@computer.org
URI: http://internetmessagingtechnology.org/
Leiba Лучшая современная практика [Страница 4]
Internet Engineering Task Force (IETF) B. Leiba
Request for Comments: 8174 Huawei Technologies
BCP: 14 May 2017
Updates: 2119
Category: Best Current Practice
ISSN: 2070-1721
Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words
Abstract
RFC 2119 specifies common key words that may be used in protocol
specifications. This document aims to reduce the ambiguity by
clarifying that only UPPERCASE usage of the key words have the
defined special meanings.
Status of This Memo
This memo documents an Internet Best Current Practice.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
BCPs is available in Section 2 of RFC 7841.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
http://www.rfc-editor.org/info/rfc8174.
Leiba Best Current Practice [Page 1]
RFC 8174 RFC 2119 Clarification May 2017
Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Clarifying Capitalization of Key Words . . . . . . . . . . . 3
3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4
4. Security Considerations . . . . . . . . . . . . . . . . . . . 4
5. Normative References . . . . . . . . . . . . . . . . . . . . 4
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 4
1. Introduction
RFC 2119 specifies common key words, such as "MUST", "SHOULD", and
"MAY", that may be used in protocol specifications. It says that the
key words "are often capitalized," which has caused confusion about
how to interpret non-capitalized words such as "must" and "should".
This document updates RFC 2119 by clarifying that only UPPERCASE
usage of the key words have the defined special meanings. This
document is part of BCP 14.
Leiba Best Current Practice [Page 2]
RFC 8174 RFC 2119 Clarification May 2017
2. Clarifying Capitalization of Key Words
The following change is made to [RFC2119]:
=== OLD ===
In many standards track documents several words are used to signify
the requirements in the specification. These words are often
capitalized. This document defines these words as they should be
interpreted in IETF documents. Authors who follow these guidelines
should incorporate this phrase near the beginning of their document:
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119.
=== NEW ===
In many IETF documents, several words, when they are in all capitals
as shown below, are used to signify the requirements in the
specification. These capitalized words can bring significant clarity
and consistency to documents because their meanings are well defined.
This document defines how those words are interpreted in IETF
documents when the words are in all capitals.
o These words can be used as defined here, but using them is not
required. Specifically, normative text does not require the use
of these key words. They are used for clarity and consistency
when that is what's wanted, but a lot of normative text does not
use them and is still normative.
o The words have the meanings specified herein only when they are in
all capitals.
o When these words are not capitalized, they have their normal
English meanings and are not affected by this document.
Authors who follow these guidelines should incorporate this phrase
near the beginning of their document:
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
"MAY", and "OPTIONAL" in this document are to be interpreted as
described in BCP 14 [RFC2119] [RFC8174] when, and only when, they
appear in all capitals, as shown here.
=== END ===
Leiba Best Current Practice [Page 3]
RFC 8174 RFC 2119 Clarification May 2017
3. IANA Considerations
This document does not require any IANA actions.
4. Security Considerations
This document is purely procedural; there are no related security
considerations.
5. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>.
Author's Address
Barry Leiba
Huawei Technologies
Phone: +1 646 827 0648
Email: barryleiba@computer.org
URI: http://internetmessagingtechnology.org/
Leiba Best Current Practice [Page 4]