idnits 2.17.1 draft-harrington-text-mib-doc-template-06.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** It looks like you're using RFC 3978 boilerplate. You should update this to the boilerplate described in the IETF Trust License Policy document (see https://trustee.ietf.org/license-info), which is required now. -- Found old boilerplate from RFC 3978, Section 5.1 on line 15. -- Found old boilerplate from RFC 3978, Section 5.5, updated by RFC 4748 on line 154. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 165. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 172. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 178. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust Copyright Line does not match the current year -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (April 10, 2008) is 5852 days in the past. Is this intentional? Checking references for intended status: Informational ---------------------------------------------------------------------------- No issues found here. Summary: 1 error (**), 0 flaws (~~), 1 warning (==), 7 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Engineering Task Force D. Harrington, Ed. 3 Internet-Draft Huawei Technologies (USA) 4 Intended status: Informational April 10, 2008 5 Expires: October 12, 2008 7 Templates for Internet Drafts Containing MIB Modules 8 draft-harrington-text-mib-doc-template-06 10 Status of This Memo 12 By submitting this Internet-Draft, each author represents that any 13 applicable patent or other IPR claims of which he or she is aware 14 have been or will be disclosed, and any of which he or she becomes 15 aware will be disclosed, in accordance with Section 6 of BCP 79. 17 Internet-Drafts are working documents of the Internet Engineering 18 Task Force (IETF), its areas, and its working groups. Note that 19 other groups may also distribute working documents as Internet- 20 Drafts. 22 Internet-Drafts are draft documents valid for a maximum of six months 23 and may be updated, replaced, or obsoleted by other documents at any 24 time. It is inappropriate to use Internet-Drafts as reference 25 material or to cite them other than as "work in progress." 27 The list of current Internet-Drafts can be accessed at 28 http://www.ietf.org/ietf/1id-abstracts.txt. 30 The list of Internet-Draft Shadow Directories can be accessed at 31 http://www.ietf.org/shadow.html. 33 This Internet-Draft will expire on October 12, 2008. 35 Abstract 37 This memo references three annotated templates for IETF documents 38 that contain the definition of MIB modules. It is intended to reduce 39 the work of the editors of such documents, making these documents 40 more uniform and easier to read and review, thus furthering the 41 quality of such documents and expediting their publication. 43 Table of Contents 45 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 46 2. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 47 3. Security Considerations . . . . . . . . . . . . . . . . . . . . 4 48 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 4 49 5. Contributors . . . . . . . . . . . . . . . . . . . . . . . . . 4 50 6. Normative References . . . . . . . . . . . . . . . . . . . . . 4 52 1. Introduction 54 This memo references three annotated templates for IETF documents 55 that contain the definition of MIB modules. It is intended to reduce 56 the work of the editors of such documents, making these more uniform 57 and easier to read and review, thus furthering the quality of such 58 documents and expediting their publication. 60 2. Overview 62 The MIB Doctors directorate has produced three templates specifically 63 aimed at internet-drafts containing MIB modules. The templates are 64 available at the IETF Tools web site, listed as "Templates for MIB 65 Module Documents". 67 o The first is an XML template for editors that use XML2RFC. Some 68 advice echoing guidelines from RFC4181 is embedded in comments. 70 o A second template is a text template for MIB documents with advice 71 embedded in the document. 73 o A third template is a plain text template with no advice included. 75 The templates were developed to make IETF documents that contain MIB 76 modules more consistent. This makes it easier for a MIB Doctor and 77 other IETF participants to review the document. There are a number 78 of MUSTs in the templates, especially in the advice; these usually 79 refer to IESG requirements for internet drafts, and MIB Doctors are 80 likely to check for these requirements. 82 The templates contain boilerplates that are required for IETF MIB 83 module documents. It has been common practice for editors to use 84 existing MIB module documents as templates. This approach has 85 problems because boilerplates and other required elements change over 86 time. The templates referenced by this document will be made 87 available on the IETF Tools web site, and occasionally updated to 88 reflect the latest requirements. The most up-to-date revisions of 89 the templates are available at http://www.tools.ietf.org. 91 The templates contain sections that describe the purpose and 92 organization of the MIB module, and the relationship between this MIB 93 module and other MIB modules. This makes it easier for MIB Doctors 94 to understand the MIB module, which speeds the review process. 96 Editors should read RFC4181 "Guidelines for Authors and Reviewers of 97 MIB Documents" [RFC4181] which describes best current practices for 98 MIB module document editing. 100 The document templates do not include a template for the MIB module 101 itself. Tools to validate MIB modules typically require that the MIB 102 module be separated from the surrounding document. The MIB Doctors 103 feel that the simplest approach is to develop the MIB module outside 104 the document that contains the surrounding text, and then include the 105 MIB module into the surrounding document written using the templates. 107 3. Security Considerations 109 This memo recommends templates for editing; it has no direct impact 110 on network security. The templates include boilerplates and 111 associated advice for writing the Security Considerations section of 112 an Internet Draft that documents a MIB module. 114 4. IANA Considerations 116 This memo includes no request to IANA. 118 5. Contributors 120 These templates are based on contributions from the MIB Doctors, 121 especially Juergen Schoenwaelder, Dave Perkins, C.M.Heard and Randy 122 Presuhn. 124 6. Normative References 126 [RFC4181] Heard, C., "Guidelines for Authors and Reviewers of MIB 127 Documents", BCP 111, RFC 4181, September 2005. 129 Author's Address 131 David Harrington (editor) 132 Huawei Technologies (USA) 133 1700 Alma Drive, Suite 100 134 Plano, TX 75075 135 USA 137 Phone: +1 603 436 8634 138 EMail: dharrington@huawei.com 140 Full Copyright Statement 142 Copyright (C) The IETF Trust (2008). 144 This document is subject to the rights, licenses and restrictions 145 contained in BCP 78, and except as set forth therein, the authors 146 retain all their rights. 148 This document and the information contained herein are provided on an 149 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 150 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND 151 THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS 152 OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF 153 THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 154 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 156 Intellectual Property 158 The IETF takes no position regarding the validity or scope of any 159 Intellectual Property Rights or other rights that might be claimed to 160 pertain to the implementation or use of the technology described in 161 this document or the extent to which any license under such rights 162 might or might not be available; nor does it represent that it has 163 made any independent effort to identify any such rights. Information 164 on the procedures with respect to rights in RFC documents can be 165 found in BCP 78 and BCP 79. 167 Copies of IPR disclosures made to the IETF Secretariat and any 168 assurances of licenses to be made available, or the result of an 169 attempt made to obtain a general license or permission for the use of 170 such proprietary rights by implementers or users of this 171 specification can be obtained from the IETF on-line IPR repository at 172 http://www.ietf.org/ipr. 174 The IETF invites any interested party to bring to its attention any 175 copyrights, patents or patent applications, or other proprietary 176 rights that may cover technology that may be required to implement 177 this standard. Please address the information to the IETF at 178 ietf-ipr@ietf.org.