On Tue, Oct 4, 2011 at 8:27 AM, Robert Muir <rcm...@gmail.com> wrote: > On Tue, Oct 4, 2011 at 6:44 AM, Michael McCandless > <luc...@mikemccandless.com> wrote: >> Can we stop trying to document the file format? >> >> Is it really needed? It has been an error-proned process over time... >> >> Can't the source code be the definitive resource one reads to >> determine how a codec stores stuff....? > > I think it should be optional, not mandatory. > > If someone wants to write up and maintain file format descriptions, > thats a great contribution to the project. > Otherwise, it doesn't happen. > > I also think that it shouldnt be forrested on some versioned website > (which means you "automatically" get a copy of the previous version, > just asking for outdated docs). It would be better to have this as a > single-document on the wiki: better to be incomplete and not have all > versions than to be wrong.
+1 I don't think we necessarily need a description where every bit must match (i.e. the goal should be general documentation for understanding, not specification for implementing). In the past, the descriptions of the index files and format have been invaluable for understanding the bigger picture and what would be fast/slow, what would take up index space, etc. -Yonik http://www.lucene-eurocon.com - The Lucene/Solr User Conference --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
