Re: [xri] host-meta comments
Dirk Balfanz <[email protected]> Wed, 18 Feb 2009 08:54:48 -0800
| Newsgroups | gmane.ietf.apps-discuss,gmane.comp.web.general |
|---|---|
| Message-ID | <[email protected]> |
--===============0444524875== Content-Type: multipart/alternative; boundary=0015175caae610f238046334471f --0015175caae610f238046334471f Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit On Wed, Feb 18, 2009 at 8:23 AM, Breno de Medeiros <[email protected]> wrote: > While /host-meta is intended to be parsed by machines and not > human-readable content, it is often the case that users eyeball such content > for clues. For instance: > > 1. Developer is writing and debugging a library to parse host-meta files. > 2. Developer is looking at /host-meta examples to get clues on how to write > one for his site. > > Being able to add human-readable comments on site-meta can be useful for > such tasks. It also helps to preserve 'institutional memory' by > documentation in place, which is often the only one that developers can > locate. > > Should there be a simple mechanism for line comments in site-meta? > +1 for comments. I propose that any line that starts with # (possibly preceded by whitespace) is a comment. Dirk. > > -- > --Breno > > +1 (650) 214-1007 desk > +1 (408) 212-0135 (Grand Central) > MTV-41-3 : 383-A > PST (GMT-8) / PDT(GMT-7) > --0015175caae610f238046334471f Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable <br><br><div class=3D"gmail_quote">On Wed, Feb 18, 2009 at 8:23 AM, Breno d= e Medeiros <span dir=3D"ltr"><<a href=3D"mailto:[email protected]">breno@= google.com</a>></span> wrote:<br><blockquote class=3D"gmail_quote" style= =3D"border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; p= adding-left: 1ex;"> While /host-meta is intended to be parsed by machines and not human-readabl= e content, it is often the case that users eyeball such content for clues. = For instance:<br><br>1. Developer is writing and debugging a library to par= se host-meta files.<br> 2. Developer is looking at /host-meta examples to get clues on how to write= one for his site.<br><br>Being able to add human-readable comments on site= -meta can be useful for such tasks. It also helps to preserve 'institut= ional memory' by documentation in place, which is often the only one th= at developers can locate.<br> <br>Should there be a simple mechanism for line comments in site-meta?<br c= lear=3D"all"><font color=3D"#888888"></font></blockquote><div><br>+1 for co= mments. <br><br>I propose that any line that starts with # (possibly preced= ed by whitespace) is a comment.<br> <br>Dirk.<br> </div><blockquote class=3D"gmail_quote" style=3D"border-= left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left= : 1ex;"><font color=3D"#888888"><br>-- <br>--Breno<br><br>+1 (650) 214-1007= desk<br> +1 (408) 212-0135 (Grand Central)<br>MTV-41-3 : 383-A <br>PST (GMT-8) / PDT= (GMT-7)<br> </font></blockquote></div><br> --0015175caae610f238046334471f-- --===============0444524875== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ Apps-Discuss mailing list [email protected] https://www.ietf.org/mailman/listinfo/apps-discuss --===============0444524875==--