[jira] [Resolved] (CASSANDRA-11639) guide_8099.md is a bit outdated

["Sylvain Lebresne (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/CASSANDRA-11639?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Sylvain Lebresne resolved CASSANDRA-11639.
------------------------------------------
    Resolution: Won't Fix

That guide was never meant to be an up-to-date document of the internals, which is probably why it doesn't do a good job at it, and it's very outdated indeed.  This was only meant as a summary of the change in CASSANDRA-8099 to make it easier to both reviewer and the rest of C* devs. It has served its purpose but we're past that now so I removed that guide. I don't think maintaining that kind of document is really worth the effort. It's not good as an introduction to new developpers since it was strongly assuming you're familiar with the pre-8099 code and it's way too specific on particular classes and details that we'll never be able to keep that up to date.


> guide_8099.md is a bit outdated
> -------------------------------
>
>                 Key: CASSANDRA-11639
>                 URL: https://issues.apache.org/jira/browse/CASSANDRA-11639
>             Project: Cassandra
>          Issue Type: Improvement
>            Reporter: Wei Deng
>
> The guide_8099.md document that comes with the 8099 commit (dated Sep 1, 2014) is a bit outdated.
> For example, in many places of the Sep 1, 2014 [commit|https://github.com/apache/cassandra/tree/a991b64811f4d6adb6c7b31c0df52288eb06cf19] we no longer use {{Atom}} to represent the unit when dealing with Row or RangeTombstoneMarker and we use {{Unfiltered}} instead. However, you can still find many references of {{Atom}} in this document. Also, AtomIterator is no longer a thing and it's still referenced later in the document.
> Another example of the outdated information is: we have removed all of the "flyweight" pattern due to CASSANDRA-9705 in C* 3.0 GA, but this document still talks about flyweight under a separate section.
> One more example: CASSANDRA-8933 turns out is not a problem out of pure luck, but we still have a section called "Short Reads" in this doc.
> Another suggestion in the new revision of guide_8099.md: it appears that some very useful information regarding the 3.0 storage format is hidden in the code comments, especially in some of the Serializer classes (e.g. UnfilteredSerializer, UnfilterRowIteratorSerializer). If we could integrate information from those javadoc comments into here, it will be very helpful (so that people don't have to look in two places).
> As this guide_8099.md is considered as a key document to an important area of under-the-hood Cassandra implementation, to help new developers to navigate this storage engine area better and to avoid unnecessary confusions, we should strive to keep it as updated as possible.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)