cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Wei Deng (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (CASSANDRA-11639) guide_8099.md is a bit outdated
Date Mon, 25 Apr 2016 11:39:12 GMT

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

Wei Deng updated CASSANDRA-11639:
---------------------------------
    Description: 
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.

  was:
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.

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.


> 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)

Mime
View raw message