Revision 54edaee58654bdc3c961906a8390088f35460ae9 authored by Jungtaek Lim (HeartSaVioR) on 02 December 2019, 15:01:45 UTC, committed by Sean Owen on 02 December 2019, 15:01:45 UTC
### What changes were proposed in this pull request? The patch adds scaladoc on `HDFSMetadataLog.serialize` and `HDFSMetadataLog.deserialize` for adding implementation note when overriding - HDFSMetadataLog calls `serialize` and `deserialize` inside try-finally and caller will do the resource (input stream, output stream) cleanup, so resource cleanup should not be performed in these methods, but there's no note on this (only code comment, not scaladoc) which is easy to be missed. ### Why are the changes needed? Contributors who are unfamiliar with the intention seem to think it as a bug if the resource is not cleaned up in serialize/deserialize of subclass of HDFSMetadataLog, and they couldn't know about the intention without reading the code of HDFSMetadataLog. Adding the note as scaladoc would expand the visibility. ### Does this PR introduce any user-facing change? No ### How was this patch tested? Just a doc change. Closes #26732 from HeartSaVioR/MINOR-SS-HDFSMetadataLog-serde-scaladoc. Lead-authored-by: Jungtaek Lim (HeartSaVioR) <kabhwan.opensource@gmail.com> Co-authored-by: dz <953396112@qq.com> Signed-off-by: Sean Owen <sean.owen@databricks.com>
1 parent e271664
File | Mode | Size |
---|---|---|
slaves.sh | -rwxr-xr-x | 2.7 KB |
spark-config.sh | -rwxr-xr-x | 1.4 KB |
spark-daemon.sh | -rwxr-xr-x | 5.6 KB |
spark-daemons.sh | -rwxr-xr-x | 1.2 KB |
start-all.sh | -rwxr-xr-x | 1.2 KB |
start-history-server.sh | -rwxr-xr-x | 1.7 KB |
start-master.sh | -rwxr-xr-x | 2.0 KB |
start-mesos-dispatcher.sh | -rwxr-xr-x | 1.8 KB |
start-mesos-shuffle-service.sh | -rwxr-xr-x | 1.4 KB |
start-slave.sh | -rwxr-xr-x | 3.1 KB |
start-slaves.sh | -rwxr-xr-x | 1.5 KB |
start-thriftserver.sh | -rwxr-xr-x | 2.0 KB |
stop-all.sh | -rwxr-xr-x | 1.4 KB |
stop-history-server.sh | -rwxr-xr-x | 1.0 KB |
stop-master.sh | -rwxr-xr-x | 1.1 KB |
stop-mesos-dispatcher.sh | -rwxr-xr-x | 1.2 KB |
stop-mesos-shuffle-service.sh | -rwxr-xr-x | 1.1 KB |
stop-slave.sh | -rwxr-xr-x | 1.5 KB |
stop-slaves.sh | -rwxr-xr-x | 1.0 KB |
stop-thriftserver.sh | -rwxr-xr-x | 1.0 KB |
![swh spinner](/static/img/swh-spinner.gif)
Computing file changes ...