Changeset 2436 for draft-ietf-httpbis


Ignore:
Timestamp:
28/10/13 10:34:58 (7 years ago)
Author:
julian.reschke@…
Message:

add BCP178 reference in discussion about "X-" (see #503)

Location:
draft-ietf-httpbis/latest
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • draft-ietf-httpbis/latest/p2-semantics.html

    r2434 r2436  
    445445  }
    446446  @bottom-center {
    447        content: "Expires April 30, 2014";
     447       content: "Expires May 1, 2014";
    448448  }
    449449  @bottom-right {
     
    490490      <meta name="dct.creator" content="Reschke, J. F.">
    491491      <meta name="dct.identifier" content="urn:ietf:id:draft-ietf-httpbis-p2-semantics-latest">
    492       <meta name="dct.issued" scheme="ISO8601" content="2013-10-27">
     492      <meta name="dct.issued" scheme="ISO8601" content="2013-10-28">
    493493      <meta name="dct.replaces" content="urn:ietf:rfc:2616">
    494494      <meta name="dct.abstract" content="The Hypertext Transfer Protocol (HTTP) is an application-level protocol for distributed, collaborative, hypertext information systems. This document defines the semantics of HTTP/1.1 messages, as expressed by request methods, request header fields, response status codes, and response header fields, along with the payload of messages (metadata and body content) and mechanisms for content negotiation.">
     
    518518            <tr>
    519519               <td class="left">Intended status: Standards Track</td>
    520                <td class="right">October 27, 2013</td>
     520               <td class="right">October 28, 2013</td>
    521521            </tr>
    522522            <tr>
    523                <td class="left">Expires: April 30, 2014</td>
     523               <td class="left">Expires: May 1, 2014</td>
    524524               <td class="right"></td>
    525525            </tr>
     
    550550            in progress”.
    551551         </p>
    552          <p>This Internet-Draft will expire on April 30, 2014.</p>
     552         <p>This Internet-Draft will expire on May 1, 2014.</p>
    553553      </div>
    554554      <div id="rfc.copyrightnotice">
     
    38333833                  or the connection (i.e., control data). See <a href="p1-messaging.html#header.fields" title="Header Fields">Section 3.2</a> of <a href="#Part1" id="rfc.xref.Part1.32"><cite title="Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing">[Part1]</cite></a> for a general definition of header field syntax in HTTP messages.
    38343834               </p>
    3835                <p id="rfc.section.8.3.1.p.2">The requirements for header field names are defined in <a href="#BCP90" id="rfc.xref.BCP90.2"><cite title="Registration Procedures for Message Header Fields">[BCP90]</cite></a>. Authors of specifications defining new fields are advised to keep the name as short as practical and to not prefix the name
     3835               <p id="rfc.section.8.3.1.p.2">The requirements for header field names are defined in <a href="#BCP90" id="rfc.xref.BCP90.2"><cite title="Registration Procedures for Message Header Fields">[BCP90]</cite></a>.
     3836               </p>
     3837               <p id="rfc.section.8.3.1.p.3">Authors of specifications defining new fields are advised to keep the name as short as practical and to not prefix the name
    38363838                  with "X-" unless the header field will never be used on the Internet. (The "x-" prefix idiom has been extensively misused
    38373839                  in practice; it was intended to only be used as a mechanism for avoiding name collisions inside proprietary software or intranet
    3838                   processing, since the prefix would ensure that private names never collide with a newly registered Internet name.)
    3839                </p>
    3840                <p id="rfc.section.8.3.1.p.3">New header field values typically have their syntax defined using ABNF (<a href="#RFC5234" id="rfc.xref.RFC5234.2"><cite title="Augmented BNF for Syntax Specifications: ABNF">[RFC5234]</cite></a>), using the extension defined in <a href="p1-messaging.html#abnf.extension" title="ABNF list extension: #rule">Section 7</a> of <a href="#Part1" id="rfc.xref.Part1.33"><cite title="Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing">[Part1]</cite></a> as necessary, and are usually constrained to the range of ASCII characters. Header fields needing a greater range of characters
     3840                  processing, since the prefix would ensure that private names never collide with a newly registered Internet name; see <a href="#BCP178" id="rfc.xref.BCP178.1"><cite title="Deprecating the &#34;X-&#34; Prefix and Similar Constructs in Application Protocols">[BCP178]</cite></a> for further information)
     3841               </p>
     3842               <p id="rfc.section.8.3.1.p.4">New header field values typically have their syntax defined using ABNF (<a href="#RFC5234" id="rfc.xref.RFC5234.2"><cite title="Augmented BNF for Syntax Specifications: ABNF">[RFC5234]</cite></a>), using the extension defined in <a href="p1-messaging.html#abnf.extension" title="ABNF list extension: #rule">Section 7</a> of <a href="#Part1" id="rfc.xref.Part1.33"><cite title="Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing">[Part1]</cite></a> as necessary, and are usually constrained to the range of ASCII characters. Header fields needing a greater range of characters
    38413843                  can use an encoding such as the one defined in <a href="#RFC5987" id="rfc.xref.RFC5987.1"><cite title="Character Set and Language Encoding for Hypertext Transfer Protocol (HTTP) Header Field Parameters">[RFC5987]</cite></a>.
    38423844               </p>
    3843                <p id="rfc.section.8.3.1.p.4">Leading and trailing whitespace in raw field values is removed upon field parsing (<a href="p1-messaging.html#field.parsing" title="Field Parsing">Section 3.2.4</a> of <a href="#Part1" id="rfc.xref.Part1.34"><cite title="Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing">[Part1]</cite></a>). Field definitions where leading or trailing whitespace in values is significant will have to use a container syntax such
     3845               <p id="rfc.section.8.3.1.p.5">Leading and trailing whitespace in raw field values is removed upon field parsing (<a href="p1-messaging.html#field.parsing" title="Field Parsing">Section 3.2.4</a> of <a href="#Part1" id="rfc.xref.Part1.34"><cite title="Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing">[Part1]</cite></a>). Field definitions where leading or trailing whitespace in values is significant will have to use a container syntax such
    38443846                  as quoted-string.
    38453847               </p>
    3846                <p id="rfc.section.8.3.1.p.5">Because commas (",") are used as a generic delimiter between field-values, they need to be treated with care if they are allowed
     3848               <p id="rfc.section.8.3.1.p.6">Because commas (",") are used as a generic delimiter between field-values, they need to be treated with care if they are allowed
    38473849                  in the field-value. Typically, components that might contain a comma are protected with double-quotes using the quoted-string
    38483850                  ABNF production (<a href="p1-messaging.html#field.components" title="Field value components">Section 3.2.6</a> of <a href="#Part1" id="rfc.xref.Part1.35"><cite title="Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing">[Part1]</cite></a>).
    38493851               </p>
    3850                <p id="rfc.section.8.3.1.p.6">For example, a textual date and a URI (either of which might contain a comma) could be safely carried in field-values like
     3852               <p id="rfc.section.8.3.1.p.7">For example, a textual date and a URI (either of which might contain a comma) could be safely carried in field-values like
    38513853                  these:
    38523854               </p>
     
    38543856                     "http://without-a-comma.example.com/"
    38553857  Example-Date-Field: "Sat, 04 May 1996", "Wed, 14 Sep 2005"
    3856 </pre><p id="rfc.section.8.3.1.p.8">Note that double-quote delimiters almost always are used with the quoted-string production; using a different syntax inside
     3858</pre><p id="rfc.section.8.3.1.p.9">Note that double-quote delimiters almost always are used with the quoted-string production; using a different syntax inside
    38573859                  double-quotes will likely cause unnecessary confusion.
    38583860               </p>
    3859                <p id="rfc.section.8.3.1.p.9">Many header fields use a format including (case-insensitively) named parameters (for instance, <a href="#header.content-type" class="smpl">Content-Type</a>, defined in <a href="#header.content-type" id="rfc.xref.header.content-type.3" title="Content-Type">Section&nbsp;3.1.1.5</a>). Allowing both unquoted (token) and quoted (quoted-string) syntax for the parameter value enables recipients to use existing
     3861               <p id="rfc.section.8.3.1.p.10">Many header fields use a format including (case-insensitively) named parameters (for instance, <a href="#header.content-type" class="smpl">Content-Type</a>, defined in <a href="#header.content-type" id="rfc.xref.header.content-type.3" title="Content-Type">Section&nbsp;3.1.1.5</a>). Allowing both unquoted (token) and quoted (quoted-string) syntax for the parameter value enables recipients to use existing
    38603862                  parser components. When allowing both forms, the meaning of a parameter value ought to be independent of the syntax used for
    38613863                  it (for an example, see the notes on parameter handling for media types in <a href="#media.type" title="Media Type">Section&nbsp;3.1.1.1</a>).
    38623864               </p>
    3863                <p id="rfc.section.8.3.1.p.10">Authors of specifications defining new header fields are advised to consider documenting: </p>
     3865               <p id="rfc.section.8.3.1.p.11">Authors of specifications defining new header fields are advised to consider documenting: </p>
    38643866               <ul>
    38653867                  <li>
     
    43384340            <td class="reference"><b id="BCP13">[BCP13]</b></td>
    43394341            <td class="top"><a href="mailto:ned+ietf@mrochek.com" title="Oracle">Freed, N.</a>, <a href="mailto:john+ietf@jck.com">Klensin, J.</a>, and <a href="mailto:tony+mtsuffix@maillennium.att.com" title="AT&amp;T Laboratories">T. Hansen</a>, “<a href="http://tools.ietf.org/html/rfc6838">Media Type Specifications and Registration Procedures</a>”, BCP&nbsp;13, RFC&nbsp;6838, January&nbsp;2013.
     4342            </td>
     4343         </tr>
     4344         <tr>
     4345            <td class="reference"><b id="BCP178">[BCP178]</b></td>
     4346            <td class="top">Saint-Andre, P., Crocker, D., and M. Nottingham, “<a href="http://tools.ietf.org/html/rfc6648">Deprecating the "X-" Prefix and Similar Constructs in Application Protocols</a>”, BCP&nbsp;178, RFC&nbsp;6648, June&nbsp;2012.
    43404347            </td>
    43414348         </tr>
     
    47664773               </li>
    47674774            </ul>
     4775            <p id="rfc.section.E.2.p.2">Partly resolved issues: </p>
     4776            <ul>
     4777               <li>&lt;<a href="http://tools.ietf.org/wg/httpbis/trac/ticket/503">http://tools.ietf.org/wg/httpbis/trac/ticket/503</a>&gt;: "APPSDIR review of draft-ietf-httpbis-p2-semantics-24"
     4778               </li>
     4779            </ul>
    47684780         </div>
    47694781      </div>
     
    48404852            <li><a id="rfc.index.B" href="#rfc.index.B"><b>B</b></a><ul>
    48414853                  <li><em>BCP13</em>&nbsp;&nbsp;<a href="#rfc.xref.BCP13.1">3.1.1.1</a>, <a href="#BCP13"><b>11.2</b></a></li>
     4854                  <li><em>BCP178</em>&nbsp;&nbsp;<a href="#rfc.xref.BCP178.1">8.3.1</a>, <a href="#BCP178"><b>11.2</b></a></li>
    48424855                  <li><em>BCP90</em>&nbsp;&nbsp;<a href="#rfc.xref.BCP90.1">8.3</a>, <a href="#rfc.xref.BCP90.2">8.3.1</a>, <a href="#BCP90"><b>11.2</b></a></li>
    48434856               </ul>
  • draft-ietf-httpbis/latest/p2-semantics.xml

    r2434 r2436  
    46064606<t>
    46074607   The requirements for header field names are defined in
    4608    <xref target="BCP90"/>.  Authors of specifications defining new fields are
     4608   <xref target="BCP90"/>.
     4609</t>
     4610<t>   
     4611   Authors of specifications defining new fields are
    46094612   advised to keep the name as short as practical and to not prefix the name
    46104613   with "X-" unless the header field will never be used on the Internet.
     
    46124615   intended to only be used as a mechanism for avoiding name collisions inside
    46134616   proprietary software or intranet processing, since the prefix would ensure
    4614    that private names never collide with a newly registered Internet name.)
     4617   that private names never collide with a newly registered Internet name; see
     4618   <xref target="BCP178"/> for further information)
    46154619</t>
    46164620<t>
     
    58005804</reference>
    58015805
     5806<reference anchor="BCP178">
     5807  <front>
     5808    <title>Deprecating the "X-" Prefix and Similar Constructs in Application Protocols</title>
     5809    <author initials="P." surname="Saint-Andre" fullname="Peter Saint-Andre"/>
     5810    <author initials="D." surname="Crocker" fullname="Dave Crocker"/>
     5811    <author initials="M." surname="Nottingham" fullname="Mark Nottingham"/>
     5812    <date year="2012" month="June"/>
     5813  </front>
     5814  <seriesInfo name="BCP" value="178"/>
     5815  <seriesInfo name="RFC" value="6648"/>
     5816</reference>
     5817
    58025818<reference anchor="status-308">
    58035819        <front>
     
    63196335  </list>
    63206336</t>
     6337<t>
     6338  Partly resolved issues:
     6339  <list style="symbols">
     6340    <t>
     6341      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/503"/>:
     6342      "APPSDIR review of draft-ietf-httpbis-p2-semantics-24"
     6343    </t>
     6344  </list>
     6345</t>
    63216346</section>
    63226347</section>
Note: See TracChangeset for help on using the changeset viewer.