Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HBASE-22481: Javadoc Warnings reference not found #254

Merged
merged 4 commits into from
Jun 8, 2019
Merged

HBASE-22481: Javadoc Warnings reference not found #254

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3eff922
HBASE-22481
murtazahassan123 May 27, 2019
e802d8c
HBASE-22481 Javadoc Warnings: reference not found, added an entry in …
murtazahassan123 May 27, 2019
61e1137
HBASE-22481 Changed suppresions.xml file with check on package instea…
murtazahassan123 May 28, 2019
2638f92
HBASE-22481: Javadoc Warnings reference not found, suppress LineLengh…
murtazahassan123 Jun 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions hbase-checkstyle/src/main/resources/hbase/checkstyle-suppressions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,5 @@
<suppress checks="IllegalImport" message="org\.apache\.htrace\.core"/>
<suppress checks="ImportOrder" message="Extra separation in import group before"/>
<suppress checks="MethodLength" files="DemoClient.java"/>
<suppress checks="LineLength" files="MultiTableSnapshotInputFormat.java"/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please check if it is possible to add the package name to the file suppression?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have checked and it is possible. Please find the latest commit.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to suppress LineLenght check only on the offending lines in the javadoc instead of completely ignoring it in the org.apache.hadoop.hbase.mapred package?

https://stackoverflow.com/a/30070188/3521345

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks i will look into it.

Copy link
Contributor Author

@murtazahassan123 murtazahassan123 Jun 7, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have suppressed LineLength check only on the offending lines in the javadoc using "@SuppressWarnings" annotation. Kindly check the 4th commit for this change.

</suppressions>
25 changes: 12 additions & 13 deletions ...mapreduce/src/main/java/org/apache/hadoop/hbase/mapred/MultiTableSnapshotInputFormat.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@
import java.util.Map;

/**
* MultiTableSnapshotInputFormat generalizes {@link org.apache.hadoop.hbase.mapred
* .TableSnapshotInputFormat}
* MultiTableSnapshotInputFormat generalizes
* {@link org.apache.hadoop.hbase.mapred.TableSnapshotInputFormat}
* allowing a MapReduce job to run over one or more table snapshots, with one or more scans
* configured for each.
* Internally, the input format delegates to {@link org.apache.hadoop.hbase.mapreduce
* .TableSnapshotInputFormat}
* and thus has the same performance advantages; see {@link org.apache.hadoop.hbase.mapreduce
* .TableSnapshotInputFormat} for
* more details.
* Internally, the input format delegates to
* {@link org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormat}
* and thus has the same performance advantages; see
* {@link org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormat}
* for more details.
* Usage is similar to TableSnapshotInputFormat, with the following exception:
* initMultiTableSnapshotMapperJob takes in a map
* from snapshot name to a collection of scans. For each snapshot in the map, each corresponding
Expand All @@ -71,8 +71,8 @@
* </pre>
* Internally, this input format restores each snapshot into a subdirectory of the given tmp
* directory. Input splits and
* record readers are created as described in {@link org.apache.hadoop.hbase.mapreduce
* .TableSnapshotInputFormat}
* record readers are created as described in
* {@link org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormat}
* (one per region).
* See {@link org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormat} for more notes on
* permissioning; the
Expand Down Expand Up @@ -110,10 +110,9 @@ public RecordReader<ImmutableBytesWritable, Result> getRecordReader(InputSplit s
/**
* Configure conf to read from snapshotScans, with snapshots restored to a subdirectory of
* restoreDir.
* Sets: {@link org.apache.hadoop.hbase.mapreduce
* .MultiTableSnapshotInputFormatImpl#RESTORE_DIRS_KEY},
* {@link org.apache.hadoop.hbase.mapreduce
* .MultiTableSnapshotInputFormatImpl#SNAPSHOT_TO_SCANS_KEY}
* Sets:
* {@link org.apache.hadoop.hbase.mapreduce.MultiTableSnapshotInputFormatImpl#RESTORE_DIRS_KEY},
* {@link org.apache.hadoop.hbase.mapreduce.MultiTableSnapshotInputFormatImpl#SNAPSHOT_TO_SCANS_KEY}
*
* @param conf
* @param snapshotScans
Expand Down