RFC 8174 · BCP 14 · Май 2017 · Обновляет RFC 2119
Неоднозначность прописных и строчных букв в ключевых словах RFC 2119
Б. Лейба (B. Leiba), Huawei Technologies
Internet Engineering Task Force (IETF)
Категория: наилучшая текущая практика · ISSN: 2070-1721
Аннотация
RFC 2119 определяет распространённые ключевые слова, которые могут использоваться в спецификациях протоколов. Цель настоящего документа — уменьшить неоднозначность, уточнив, что определённые специальные значения имеют только ключевые слова, написанные ПРОПИСНЫМИ БУКВАМИ.
Статус документа
Этот документ описывает наилучшую текущую практику Интернета.
Документ подготовлен Инженерным советом Интернета (IETF). Он отражает консенсус сообщества IETF, прошёл публичное обсуждение и одобрен к публикации Руководящей группой инженерных работ Интернета (IESG). Дополнительные сведения о документах BCP приведены в разделе 2 RFC 7841.
Информация о текущем статусе документа, исправлениях и порядке отправки отзывов доступна по адресу rfc-editor.org/info/rfc8174.
Уведомление об авторских правах
Copyright (c) 2017 IETF Trust и лица, указанные в качестве авторов документа. Все права защищены.
На документ распространяются BCP 78 и Правовые положения IETF Trust, относящиеся к документам IETF (trustee.ietf.org/license-info), действовавшие на дату его публикации. Внимательно ознакомьтесь с ними: они определяют ваши права и ограничения в отношении этого документа. Компоненты кода, извлечённые из документа, должны включать текст Упрощённой лицензии BSD, как указано в разделе 4.e Правовых положений Trust, и предоставляются без гарантий согласно Упрощённой лицензии BSD.
Содержание
1. Введение
RFC 2119 определяет распространённые ключевые слова, такие как «MUST», «SHOULD» и «MAY», которые могут использоваться в спецификациях протоколов. В нём говорится, что эти слова «часто пишутся прописными буквами», что вызвало путаницу в толковании слов, написанных строчными буквами, например «must» и «should».
Настоящий документ обновляет RFC 2119, уточняя, что определённые специальные значения имеют только ключевые слова, написанные ПРОПИСНЫМИ БУКВАМИ. Этот документ является частью BCP 14.
2. Уточнение регистра ключевых слов
В [RFC2119] вносится следующее изменение:
Было
Во многих документах, относящихся к процессу стандартизации, несколько слов используются для обозначения требований спецификации. Эти слова часто пишутся прописными буквами. Настоящий документ определяет, как следует понимать эти слова в документах IETF. Авторам, следующим этим рекомендациям, следует включать следующую фразу в начало своего документа:
Ключевые слова «MUST», «MUST NOT», «REQUIRED», «SHALL», «SHALL NOT», «SHOULD», «SHOULD NOT», «RECOMMENDED», «MAY» и «OPTIONAL» в настоящем документе следует понимать согласно RFC 2119.
Стало
Во многих документах IETF несколько слов, написанных целиком прописными буквами, как показано ниже, используются для обозначения требований спецификации. Эти слова в прописном написании могут значительно повысить ясность и согласованность документов благодаря чётко определённым значениям. Настоящий документ устанавливает толкование этих слов в документах IETF, когда они написаны целиком прописными буквами.
- Эти слова можно использовать в определённых здесь значениях, но их использование не обязательно. В частности, нормативный текст не требует использования этих ключевых слов. Они применяются для ясности и согласованности, когда это желательно, однако многие нормативные тексты не используют их и тем не менее остаются нормативными.
- Эти слова имеют указанные здесь значения только тогда, когда они написаны целиком прописными буквами.
- Когда эти слова не написаны прописными буквами, они имеют обычные значения в английском языке; настоящий документ на них не распространяется.
Авторам, следующим этим рекомендациям, следует включать следующую фразу в начало своего документа:
Ключевые слова «MUST», «MUST NOT», «REQUIRED», «SHALL», «SHALL NOT», «SHOULD», «SHOULD NOT», «RECOMMENDED», «NOT RECOMMENDED», «MAY» и «OPTIONAL» в настоящем документе следует понимать согласно BCP 14 [RFC2119] [RFC8174] тогда и только тогда, когда они написаны целиком прописными буквами, как показано здесь.
Конец изменения.
3. Вопросы IANA
Настоящий документ не требует действий со стороны IANA.
4. Вопросы безопасности
Документ носит исключительно процедурный характер; связанных с ним вопросов безопасности нет.
5. Нормативные ссылки
[RFC2119] Bradner, S., «Key words for use in RFCs to Indicate Requirement Levels» («Ключевые слова для обозначения уровней требований в RFC»), BCP 14, RFC 2119, DOI 10.17487/RFC2119, март 1997, rfc-editor.org/info/rfc2119.
Адрес автора
Barry Leiba
Huawei Technologies
Телефон: +1 646 827 0648
Email: barryleiba@computer.org
URI: http://internetmessagingtechnology.org/
Перевод: RFCNET · rfcnet.ru
Original copyright notice
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.
Неофициальный перевод. При расхождениях см. оригинал.