> On 2012-03-08 00:32:59, Mike Percy wrote: > > Hi Juhani, sorry for the delay in getting back to you on this. I took a > > look at the added docs and it looks great. I think this type of > > documentation really helps to clarify how the system is supposed to act. > > > > I added a few suggestions below. > > Will McQueen wrote: > Hi Juhani, > > How about adding some concurrency-related comments or annotations (eg, > JCIP-style, EJ-style or JSR-305 style... I'm not sure which one we've > standardized on for annotations, but I've seen some somewhere in the code > before) so that users know whether to make their custom implementations of > components (such as Sink) threadsafe, and so devs can tell at a glance > whether any future changes to the impl need to honor a specific thread safety > contract? EJ 2nd edition has Item 70: "Document thread safety". It > recommends, "To enable safe concurrent use, a class must clearly document > what level of thread safety it supports". > > Cheers, > Will
Good point. I'll have to do this after the weekend but I'll get on it! - Juhani ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/4175/#review5698 ----------------------------------------------------------- On 2012-03-09 07:51:16, Juhani Connolly wrote: > > ----------------------------------------------------------- > This is an automatically generated e-mail. To reply, visit: > https://reviews.apache.org/r/4175/ > ----------------------------------------------------------- > > (Updated 2012-03-09 07:51:16) > > > Review request for Flume. > > > Summary > ------- > > An initial pass at documenting the interfaces. > Let me know if I missed anything relevant, or if you feel that this does not > correctly represent our expected behaviors. > > > This addresses bug FLUME-1019. > https://issues.apache.org/jira/browse/FLUME-1019 > > > Diffs > ----- > > flume-ng-core/src/main/java/org/apache/flume/sink/SinkProcessorFactory.java > 10f9f4e > flume-ng-core/src/main/java/org/apache/flume/Sink.java 3abeeb6 > flume-ng-core/src/main/java/org/apache/flume/SinkProcessor.java 11651ad > flume-ng-core/src/main/java/org/apache/flume/sink/SinkGroup.java 2e80a56 > > Diff: https://reviews.apache.org/r/4175/diff > > > Testing > ------- > > No changes have been made to code > > > Thanks, > > Juhani > >
