RFC 8174 Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words

Please enter banners and links.

image_print
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

Неоднозначность использования заглавных букв в ключевых словах RFC 2119

Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words

PDF

Тезисы

В RFC 2119 указаны ключевые слова общего назначения, которые могут применяться в спецификациях протоколов. Целью этого документа является устранение неоднозначности за счет прояснения необходимости использования заглавных букв1 для того, чтобы ключевые слова имели указанное специальное значение.

Статус документа

Этот документ относится к категории Internet Best Current Practice.

Документ является результатом работы IETF2 и представляет согласованный взгляд сообщества IETF. Документ прошел открытое обсуждение и был одобрен для публикации IESG3. Не все одобренные IESG документы претендуют на статус Internet Standard (см. раздел 2 в RFC 7841).

Информацию о текущем статусе документа, ошибках и способах обратной связи можно найти по ссылке http://www.rfc-editor.org/info/rfc8174.

Авторские права

Авторские права (Copyright (c) 2017) принадлежат IETF Trust и лицам, указанным в качестве авторов документа. Все права защищены.

Этот документ является субъектом прав и ограничений, перечисленных в BCP 78 и IETF Trust Legal Provisions и относящихся к документам IETF (http://trustee.ietf.org/license-info), на момент публикации данного документа. Прочтите упомянутые документы внимательно, поскольку в них описаны права и ограничения, относящиеся к данному документу. Фрагменты программного кода, включенные в этот документ, распространяются в соответствии с упрощенной лицензией BSD, как указано в параграфе 4.e документа Trust Legal Provisions, без каких-либо гарантий (как указано в Simplified BSD License).

Оглавление

Исключено в версии HTML.

1. Введение

В RFC 2119 указаны ключевые слова общего назначения типа MUST, SHOULD и MAY, которые могут применяться в спецификациях протоколов. Там сказано, что ключевые слова «часто выделяются заглавными буквами» и это приводило к неоднозначности трактовки слов типа must и should без заглавных букв.

Данный документ обновляет RFC 2119, разъясняя, что только слова, набранные заглавными буквами, имеют указанное в документе значение. Документ является частью BCP 14.

2. Разъяснение по использованию заглавных букв в ключевых словах

Ниже показаны изменения, вносимые в [RFC2119]:

=== Старый текст ===

Во многих документах, описывающих стандарты, используются модальные глаголы для обозначения уровня требований. Такие слова часто выделяются заглавными буквами4. В данном документе определяется толкование этих глаголов и производных от них слов в документах IETF. Авторам документов, следующих приведенным здесь требованиям, рекомендуется помещать в начале документов приведенный ниже текст:

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 21195.

=== Новый текст ===

Во многих документах IETF некоторые слова, будучи набранными заглавными буквами, как показано ниже, служат для обозначения уровня требований в спецификации. Такое выделение может существенно повышать уровень ясности и согласованности документов по причине четко определенных трактовок. Данный документ определяет интерпретацию таких слов в документах IETF при наборе этих слов заглавными буквами.

  • Такие слова могут использоваться в соответствии с приведенными здесь определениями, но такое использование не является обязательным. В частности, не требуется применения этих слов в нормативных текстах. Эти слова применяются для четкости и согласованности, когда это нужно, но во многих нормативных документах использование такого специального значение слов не требуется.

  • Слова имеют указанные здесь значения только в случае их набора полностью заглавными буквами.

  • Если слова не набраны полностью заглавными буквами, для них используется обычная в английском языке трактовка и данный документ не оказывает на это влияния.

Авторам, которые следуют данным рекомендациям, следует включать в начало документа приведенную ниже фразу.

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 here6.

=== Конец изменений ===

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

Phone: +1 646 827 0648

Email: barryleiba@computer.org

URI: http://internetmessagingtechnology.org/


Перевод на русский язык

Николай Малых

nmalykh@gmail.com

1В опубликованных на этом сайте переводах RFC вместо заглавных букв используется выделение полужирным шрифтом. Прим. перев.

2Internet Engineering Task Force.

3Internet Engineering Steering Group.

4В переводах на сайте www.protocols.ru используется выделение жирным шрифтом. Прим. перев.

5Ключевые слова необходимо, недопустимо, требуется, нужно, не нужно, следует, не следует, рекомендуется, не рекомендуется, возможно, необязательно в данном документе должны интерпретироваться в соответствии с требованиями RFC 2119.

6Ключевые слова необходимо, недопустимо, требуется, нужно, не нужно, следует, не следует, рекомендуется, не рекомендуется, возможно, необязательно в данном документе должны интерпретироваться в соответствии с требованиями BCP 14 [RFC2119] [RFC8174] тогда и только тогда, когда они полностью набраны заглавными буквами, как показано здесь.

Запись опубликована в рубрике RFC. Добавьте в закладки постоянную ссылку.

Добавить комментарий

Or